Class: MintPress::SiebelApi::CacheserverDeployment

Inherits:
Instances::Instance show all
Includes:
Mixins::Properties, MintPress::Siebel::ControllableMixin, MintPress::Siebel::Utils
Defined in:
src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb

Overview

CacheserverDeployment

Properties (Read/Write)

  • #start_timeout (Default Value: 3600)

    Property Attributes
    • default ⇒ 3600
    

91
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 91

property :start_timeout, default: 3600
  • #bypass_cache ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Setting this property to true will bypass the local cache. This may slow down the execution of Post calls if the network is slow.'
    Property Attributes
    • default ⇒ false
    

92
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 92

property :bypass_cache, type: [TrueClass, FalseClass], default: false, description: 'Setting this property to true will bypass the local cache. This may slow down the execution of Post calls if the network is slow.'
  • #wait_for_warm ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we wait for the server to be warm before continuing?
    Property Attributes
    • default ⇒ false
    

109
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 109

property :wait_for_warm, type: [TrueClass, FalseClass], default: false
  • #restart_on_deploy ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we restart the server on deploy?
    Property Attributes
    • default ⇒ false
    

111
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 111

property :restart_on_deploy, type: [TrueClass, FalseClass], default: false
  • #manage_via_container ⇒ [TrueClass, FalseClass] (Default Value: true)
    Should we always ensure the application containers for this installation are up?
    Property Attributes
    • default ⇒ true
    

113
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 113

property :manage_via_container, type: [TrueClass, FalseClass], default: true
  • #disable_application_container ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we _shut down_ the application container once we've confirmed this component up?
    Property Attributes
    • default ⇒ false
    

115
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 115

property :disable_application_container, type: [TrueClass, FalseClass], default: false
  • #restart_appcontainer_before_deploy ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we restart the application container before deploy of this item?
    Property Attributes
    • default ⇒ false
    

117
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 117

property :restart_appcontainer_before_deploy, type: [TrueClass, FalseClass], default: false
  • #restart_all_appcontainers_before_deploy ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we restart _all_ application containers before deploy of this item?
    Property Attributes
    • default ⇒ false
    

119
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 119

property :restart_all_appcontainers_before_deploy, type: [TrueClass, FalseClass], default: false
  • #application_interface ⇒ MintPress::Siebel::ApplicationInterface (Default Value: Proc.new { $default_ai })

    Property Attributes
    • default ⇒ Proc.new { $default_ai }
    

120
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 120

property :application_interface, type: MintPress::Siebel::ApplicationInterface, default: Proc.new { $default_ai }
  • #physical_host_ip ⇒ String (Default Value: Proc.new { "#{self.installation.host.name}:#{self.port}" })
    "HTTP Port"
    Property Attributes
    • default ⇒ Proc.new { "#{self.installation.host.name}:#{self.port}" }
    • alias ⇒ :DeploymentInfo_PhysicalHostIP
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

122
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 122

property :physical_host_ip, type: String, description: "HTTP Port", default: Proc.new { "#{self.installation.host.name}:#{self.port}" }, alias: :DeploymentInfo_PhysicalHostIP, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #profile_name ⇒ [String] (Default Value: Proc.new { self.cacheserver_profile.name })
    "Profile"
    Property Attributes
    • default ⇒ Proc.new { self.cacheserver_profile.name }
    • alias ⇒ :DeploymentInfo_ProfileName
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

124
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 124

property :profile_name, type: [String], description: "Profile", default: Proc.new { self.cacheserver_profile.name }, alias: :DeploymentInfo_ProfileName, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #cacheserver_profile ⇒ CacheserverProfile
    "Profile"
    Property Attributes 
    

126
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 126

property :cacheserver_profile, type: CacheserverProfile, description: "Profile"
  • #action ⇒ String
    "Action"
    Property Attributes
    • allowed_values ⇒ ["Save", "Deploy"]
    • alias ⇒ :DeploymentInfo_Action
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

128
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 128

property :action, type: String, description: "Action", allowed_values: ["Save", "Deploy"], alias: :DeploymentInfo_Action, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #status ⇒ String
    "Status of the deployment"
    Property Attributes
    • allowed_values ⇒ ["Saved", "DeployInProgress", "Deployed", "DeployFailed"]
    • alias ⇒ :DeploymentInfo_Status
    • required_for ⇒ []
    • param_for ⇒ ["deploy", "update"]
    

130
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 130

property :status, type: String, description: "Status of the deployment", allowed_values: ["Saved", "DeployInProgress", "Deployed", "DeployFailed"], alias: :DeploymentInfo_Status, required_for: [], param_for: ["deploy", "update"]
  • #cache_server_agent_node ⇒ String (Default Value: "none")
    "Siebel Cache Server Agent Node Name"
    Property Attributes
    • default ⇒ "none"
    • alias ⇒ :CacheServerDeployParams_CacheServerAgentNode
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

132
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 132

property :cache_server_agent_node, type: String, description: "Siebel Cache Server Agent Node Name", default: "none", alias: :CacheServerDeployParams_CacheServerAgentNode, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #cache_server_agent_node_desc ⇒ String (Default Value: "Cache server agent Node Name")
    "Cache server agent Description"
    Property Attributes
    • default ⇒ "Cache server agent Node Name"
    • alias ⇒ :CacheServerDeployParams_CacheServerAgentNodeDesc
    • required_for ⇒ []
    • param_for ⇒ ["deploy", "update"]
    

134
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 134

property :cache_server_agent_node_desc, type: String, description: "Cache server agent Description", default: "Cache server agent Node Name", alias: :CacheServerDeployParams_CacheServerAgentNodeDesc, required_for: [], param_for: ["deploy", "update"]
  • #name ⇒ String
    "Cache Server deployment name"
    Property Attributes 
    

136
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 136

property :name, type: String, description: "Cache Server deployment name"
  • #installation ⇒ MintPress::Siebel::Installation
    "Installation on a host for this component - this will be used to fill physical_host_ip. Use this particularly if you're using scaleout with MIntPress"
    Property Attributes 
    

138
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 138

property :installation, type: MintPress::Siebel::Installation, description: "Installation on a host for this component - this will be used to fill physical_host_ip.  Use this particularly if you're using scaleout with MIntPress"
  • #port ⇒ Integer
    "Port for use with installation - if this is specified, you must also specify an installation, otherwise use physical_host_ip"
    Property Attributes 
    

140
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcacheserverprofilespec.rb', line 140

property :port, type: Integer, description: "Port for use with installation - if this is specified, you must also specify an installation, otherwise use physical_host_ip"
  • #name ⇒ String

    Property Attributes 
    

15
    		 
    # File 'src/mintpress-utils/lib/mintpress-utils/instance.rb', line 15

property :name, type: String
  • #instance_home
    Subclasses should add a `default: Proc.new { installation.path_property` } to their definition of this, if it makes sense to do so. For example, the FMWInstance subclass defines this as `Proc.new { installation.fmw_home }` The tomcat version, will instead define this as `default: Proc.new { installation.home }`, but also define java_home as `default: Proc.new { installation.java_home }`, allowing the user to specify both of these without having to link to an installation object
    Property Attributes 
    

22
    		 
    # File 'src/mintpress-utils/lib/mintpress-utils/instance.rb', line 22

property :instance_home
  • #installation
    Subclasses should NEVER EVER use this as anything except as a default to `instance_home` and related ittems But it exists here as an advisory thing to add
    Property Attributes 
    

25
    		 
    # File 'src/mintpress-utils/lib/mintpress-utils/instance.rb', line 25

property :installation
  • #start_timeout ⇒ Integer (Default Value: 300)
    Startup timeout in seconds
    Property Attributes
    • default ⇒ 300
    

28
    		 
    # File 'src/mintpress-utils/lib/mintpress-utils/instance.rb', line 28

property :start_timeout, type: Integer, default: 300
  • #process_start_timeout ⇒ Integer (Default Value: 30)

    Property Attributes
    • default ⇒ 30
    

29
    		 
    # File 'src/mintpress-utils/lib/mintpress-utils/instance.rb', line 29

property :process_start_timeout, type: Integer, default: 30
  • #stop_timeout ⇒ Integer (Default Value: 300)
    Shutdown timeout in seconds
    Property Attributes
    • default ⇒ 300
    

31
    		 
    # File 'src/mintpress-utils/lib/mintpress-utils/instance.rb', line 31

property :stop_timeout, type: Integer, default: 300
  • #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { installation.host })
    Host where the instance is runninig. This is entirely optional, but can help with a generic implementation It will default to `installation.host` if it exists
    Property Attributes
    • default ⇒ Proc.new { installation.host }
    

35
    		 
    # File 'src/mintpress-utils/lib/mintpress-utils/instance.rb', line 35

property :host, type: MintPress::Infrastructure::Host, default: Proc.new { installation.host }

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from MintPress::Siebel::Utils

#can_hit_ai_locally?, #full_url, #get_ai_oracle_home, #get_oracle_home, #get_servermanager_oracle_home, #http_delete, #http_get, #http_post, #http_put, #request_headers

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods included from MintPress::Siebel::ControllableMixin

#appcontainer_stopped?, #application_interface_running?, #application_interface_stopped?, #enterprise_container_running?, #enterprise_container_stopped?, #get_graceful_timeout, #get_host_object, #get_non_graceful_timeout, #is_siebel_server_warm?, #post_start, #really_start_appcontainer, #really_stop_appcontainer, #restart_application_interface, #restart_enterprise_container, #restart_siebel_gateway, #restart_siebel_server, #running?, #siebel_gateway_running?, #siebel_gateway_stopped?, #siebel_server_running?, #siebel_server_stopped?, #start_appcontainer, #start_application_interface, #start_async, #start_enterprise_container, #start_siebel_gateway, #start_siebel_server, #start_tomcat_container, #stop_appcontainer, #stop_application_interface, #stop_async, #stop_enterprise_container, #stop_siebel_gateway, #stop_siebel_server, #stop_tomcat_container, #stopped?, #tomcat_container_stopped?

Methods inherited from Instances::Instance

#create, #destroy, #exists?, #has_process?, #internal_call, #process_id, #process_name, #real_state, #running?, #shutdown, #shutdown_async, #start, #start_async, #state, #stop, #stop_async

Constructor Details

#initialize(opts = {}) ⇒ CacheserverDeployment

Returns a new instance of CacheserverDeployment.

Instance Method Details

#deep_compact(hash) ⇒ Object

#delete ⇒ Object

#deploy ⇒ Object

Deploys/Saves an Cache Server deployment

#deploy_failed? ⇒ Boolean

Returns:

  • (Boolean)

#deploy_json ⇒ Object

#deployed? ⇒ Boolean

Returns:

  • (Boolean)

#exist? ⇒ Boolean

Check for existance of CacheserverDeployment via get

Returns:

  • (Boolean)

#get ⇒ Object

#get_property_from_target(prop) ⇒ Object

Allow getting props for get_property_from_target

#props_from_model ⇒ Object

#stage ⇒ Object

Stage deployment for Deploys/Saves an Cache Server deployment

#updatable? ⇒ Boolean

Returns:

  • (Boolean)

#update ⇒ Object

Modifies/reconfigures a saved/deployed Cache Server deployment

#update_json ⇒ Object