Class: MintPress::SiebelApi::ServerDeployment

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

Overview

ServerDeployment

Properties (Read/Write)

  • #start_timeout (Default Value: 3600)

    Property Attributes
    • default ⇒ 3600
    

1520
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1520

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
    

1521
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1521

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
    

1538
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1538

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
    

1540
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1540

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
    

1542
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1542

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
    

1544
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1544

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
    

1546
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1546

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
    

1548
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1548

property :restart_all_appcontainers_before_deploy, type: [TrueClass, FalseClass], default: false
  • #disable_application_interface_container ⇒ [TrueClass, FalseClass] (Default Value: false)
    Setting this property to true will disable start/stop of the external container.
    Property Attributes
    • default ⇒ false
    

1550
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1550

property :disable_application_interface_container, type: [TrueClass, FalseClass], default: false
  • #disable_enterprise_container ⇒ [TrueClass, FalseClass] (Default Value: false)
    Setting this property to true will disable start/stop of the internal container.
    Property Attributes
    • default ⇒ false
    

1552
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1552

property :disable_enterprise_container, type: [TrueClass, FalseClass], default: false
  • #startup_delay ⇒ Integer (Default Value: nil)
    'Set this property to a positive integer value and MintPress will wait that number of seconds before starting the application services. Value is in seconds.'
    Property Attributes
    • default ⇒ nil
    

1553
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1553

property :startup_delay, type: Integer, default: nil, description: 'Set this property to a positive integer value and MintPress will wait that number of seconds before starting the application services. Value is in seconds.'
  • #shutdown_delay ⇒ Integer (Default Value: nil)
    'Set this property to a positive integer value and MintPress will wait that number of seconds before stopping the application services. Value is in seconds.'
    Property Attributes
    • default ⇒ nil
    

1554
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1554

property :shutdown_delay, type: Integer, default: nil, description: 'Set this property to a positive integer value and MintPress will wait that number of seconds before stopping the application services. Value is in seconds.'
  • #components_for_warm ⇒ Hash (Default Value: nil)
    "A list of components and their status to check before the server is deemed as warm. Format: components_for_warm: {'UCMObjMgr_enu':'Running', 'JMSReceiverRCCInboundLK':'Online'}"
    Property Attributes
    • default ⇒ nil
    

1555
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1555

property :components_for_warm, type: Hash, default: nil, description: "A list of components and their status to check before the server is deemed as warm. Format: components_for_warm: {'UCMObjMgr_enu':'Running', 'JMSReceiverRCCInboundLK':'Online'}"
  • #fail_startup_if_running ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Set this property to true if you want MintPress to fail if an attempt is made to start the server and the server is already running.'
    Property Attributes
    • default ⇒ false
    

1556
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1556

property :fail_startup_if_running, type: [TrueClass, FalseClass], default: false, description: 'Set this property to true if you want MintPress to fail if an attempt is made to start the server and the server is already running.'
  • #auto_recover_if_failed ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Set this property to true if you want MintPress to attempt to cleanup lingering Siebel server processes and start the server.'
    Property Attributes
    • default ⇒ false
    

1557
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1557

property :auto_recover_if_failed, type: [TrueClass, FalseClass], default: false, description: 'Set this property to true if you want MintPress to attempt to cleanup lingering Siebel server processes and start the server.'
  • #application_interface ⇒ MintPress::Siebel::ApplicationInterface (Default Value: Proc.new { $default_ai })

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

1558
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1558

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}" })
    "IP Address of the siebel server box"
    Property Attributes
    • default ⇒ Proc.new { "#{self.installation.host.name}:#{self.port}" }
    • alias ⇒ :DeploymentInfo_PhysicalHostIP
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1560
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1560

property :physical_host_ip, type: String, description: "IP Address of the siebel server box", 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.server_profile.name })
    "Profile Name"
    Property Attributes
    • default ⇒ Proc.new { self.server_profile.name }
    • alias ⇒ :DeploymentInfo_ProfileName
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1562
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1562

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

1564
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1564

property :server_profile, type: ServerProfile, description: "Profile Name"
  • #action ⇒ String (Default Value: "Save")
    "Save or deploy action"
    Property Attributes
    • default ⇒ "Save"
    • allowed_values ⇒ ["Save", "Deploy"]
    • alias ⇒ :DeploymentInfo_Action
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1566
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1566

property :action, type: String, description: "Save or deploy action", default: "Save", allowed_values: ["Save", "Deploy"], alias: :DeploymentInfo_Action, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #status ⇒ String (Default Value: "Saved")
    "Status of the deployed configuration"
    Property Attributes
    • default ⇒ "Saved"
    • allowed_values ⇒ ["Saved", "DeployInProgress", "Deployed", "DeployFailed"]
    • alias ⇒ :DeploymentInfo_Status
    • required_for ⇒ []
    • param_for ⇒ ["deploy", "update"]
    

1568
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1568

property :status, type: String, description: "Status of the deployed configuration", default: "Saved", allowed_values: ["Saved", "DeployInProgress", "Deployed", "DeployFailed"], alias: :DeploymentInfo_Status, required_for: [], param_for: ["deploy", "update"]
  • #anon_login_username ⇒ String
    "Anonymous User Login Name"
    Property Attributes
    • alias ⇒ :ServerDeployParams_AnonLoginUserName
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1570
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1570

property :anon_login_username, type: String, description: "Anonymous User Login Name", alias: :ServerDeployParams_AnonLoginUserName, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #anon_login_password ⇒ Mint::Secret
    "Anonymous User Password"
    Property Attributes
    • alias ⇒ :ServerDeployParams_AnonLoginPassword
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1572
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1572

property :anon_login_password, type: Mint::Secret, description: "Anonymous User Password", alias: :ServerDeployParams_AnonLoginPassword, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #name ⇒ String
    "Server deployment name"
    Property Attributes
    • alias ⇒ :ServerDeployParams_SiebelServer
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1574
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1574

property :name, type: String, description: "Server deployment name"
  • #description ⇒ String
    "Siebel Server Description"
    Property Attributes
    • alias ⇒ :ServerDeployParams_SiebelServerDesc
    • required_for ⇒ []
    • param_for ⇒ ["deploy", "update"]
    

1576
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1576

property :description, type: String, description: "Siebel Server Description", alias: :ServerDeployParams_SiebelServerDesc, required_for: [], param_for: ["deploy", "update"]
  • #select_omsia ⇒ String
    "Select Object Managers for association with the Security Adapter (Name Space)"
    Property Attributes
    • alias ⇒ :ServerDeployParams_SelectOMSIA
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1578
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1578

property :select_omsia, type: String, description: "Select Object Managers for association with the Security Adapter (Name Space)", alias: :ServerDeployParams_SelectOMSIA, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #enable_comp_groups_sia ⇒ String
    "Enable Component Groups"
    Property Attributes
    • alias ⇒ :ServerDeployParams_EnableCompGroupsSIA
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1580
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1580

property :enable_comp_groups_sia, type: String, description: "Enable Component Groups", alias: :ServerDeployParams_EnableCompGroupsSIA, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #scb_port ⇒ Integer
    "Siebel Connection Broker Port"
    Property Attributes
    • alias ⇒ :ServerDeployParams_SCBPort
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1582
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1582

property :scb_port, type: Integer, description: "Siebel Connection Broker Port", alias: :ServerDeployParams_SCBPort, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #local_synch_mgr_port ⇒ Integer
    "Network TCP/IP Port for Syncronization Manager"
    Property Attributes
    • alias ⇒ :ServerDeployParams_LocalSynchMgrPort
    • required_for ⇒ ["deploy", "update"]
    • param_for ⇒ ["deploy", "update"]
    

1584
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1584

property :local_synch_mgr_port, type: Integer, description: "Network TCP/IP Port for Syncronization Manager", alias: :ServerDeployParams_LocalSynchMgrPort, required_for: ["deploy", "update"], param_for: ["deploy", "update"]
  • #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 
    

1588
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1588

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 
    

1590
    		 
    # File 'src/oracle-siebel/lib/oracle-siebel/generated/siebelcgentssspec.rb', line 1590

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 = {}) ⇒ ServerDeployment

Returns a new instance of ServerDeployment.

Instance Method Details

#deep_compact(hash) ⇒ Object

#delete ⇒ Object

#deploy ⇒ Object

Deploys/Saves a server deployment

#deploy_failed? ⇒ Boolean

Returns:

  • (Boolean)

#deploy_json ⇒ Object

#deployed? ⇒ Boolean

Returns:

  • (Boolean)

#exist? ⇒ Boolean

Check for existance of ServerDeployment 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 a server deployment

#updatable? ⇒ Boolean

Returns:

  • (Boolean)

#update ⇒ Object

Modifies/reconfigures a saved/deployed server deployment

#update_json ⇒ Object