Class: MintPress::Siebel::ApplicationInterface

Inherits:

Instances::Instance

• Object
• Instances::Instance
• MintPress::Siebel::ApplicationInterface

Includes:

Mixins::Properties

Defined in:

src/oracle-siebel/lib/oracle-siebel/application_interface.rb

Properties (Read/Write)

• #installation ⇒ MintPress::Siebel::Installation
  
  Property Attributes

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 8
  
  property :installation, type: MintPress::Siebel::Installation

• #servermanager_installation ⇒ MintPress::Siebel::Installation (Default Value: Proc.new { self.installation })
  
  Property Attributes
  • default ⇒ Proc.new { self.installation }
  • no_backref ⇒ true

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 9
  
  property :servermanager_installation, type: MintPress::Siebel::Installation, default: Proc.new { self.installation }, no_backref: true

• #instance_home ⇒ String (Default Value: Proc.new { installation.get_property(:oracle_home, disable_proc: true) })
  
  Property Attributes
  • default ⇒ Proc.new { installation.get_property(:oracle_home, disable_proc: true) }
  • alias ⇒ :oracle_home

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 10
  
  property :instance_home, type: String, default: Proc.new { installation.get_property(:oracle_home, disable_proc: true) }, alias: :oracle_home

• #servermanager_oracle_home ⇒ String (Default Value: Proc.new { servermanager_installation.get_property(:oracle_home, disable_proc: true) })
  
  Property Attributes
  • default ⇒ Proc.new { servermanager_installation.get_property(:oracle_home, disable_proc: true) }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 11
  
  property :servermanager_oracle_home, type: String, default: Proc.new { servermanager_installation.get_property(:oracle_home, disable_proc: true) }

• #http_port ⇒ Integer (Default Value: Proc.new { installation.get_property(:ai_http_connection_port, disable_proc: true) })
  
  Property Attributes
  • default ⇒ Proc.new { installation.get_property(:ai_http_connection_port, disable_proc: true) }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 12
  
  property :http_port, type: Integer, default: Proc.new { installation.get_property(:ai_http_connection_port, disable_proc: true) }

• #https_port ⇒ Integer (Default Value: Proc.new { installation.get_property(:ai_https_redirect_port, disable_proc: true) })
  
  Property Attributes
  • default ⇒ Proc.new { installation.get_property(:ai_https_redirect_port, disable_proc: true) }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 13
  
  property :https_port, type: Integer, default: Proc.new { installation.get_property(:ai_https_redirect_port, disable_proc: true) }

• #username ⇒ String (Default Value: Proc.new { installation.get_property(:ai_username, disable_proc: true) })
  
  Property Attributes
  • default ⇒ Proc.new { installation.get_property(:ai_username, disable_proc: true) }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 14
  
  property :username, type: String, default: Proc.new { installation.get_property(:ai_username, disable_proc: true) }

• #password ⇒ Mint::Secret (Default Value: Proc.new { self.install_password })
  
  Property Attributes
  • from ⇒ String
  • default ⇒ Proc.new { self.install_password }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 15
  
  property :password, type: Mint::Secret, from: String, default: Proc.new { self.install_password }

• #install_password ⇒ Mint::Secret (Default Value: Proc.new { r = installation.get_property(:ai_password, disable_proc: true) })
  
  Property Attributes
  • from ⇒ String
  • default ⇒ Proc.new { r = installation.get_property(:ai_password, disable_proc: true) }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 16
  
  property :install_password, type: Mint::Secret, from: String, default: Proc.new { r = installation.get_property(:ai_password, disable_proc: true) }

• #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { installation.get_property(:host, disable_proc: true) })
  
  Property Attributes
  • default ⇒ Proc.new { installation.get_property(:host, disable_proc: true) }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 17
  
  property :host, type: MintPress::Infrastructure::Host, default: Proc.new { installation.get_property(:host, disable_proc: true) }

• #gateway_host_name ⇒ String (Default Value: Proc.new { self.host.name })
  
  Property Attributes
  • default ⇒ Proc.new { self.host.name }

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 18
  
  property :gateway_host_name, type: String, default: Proc.new { self.host.name }

• #base_url ⇒ String
  The base url of the rest interface - if you've suppled a host, this is not required. Format should be like https://siebelserver.mintpress.io:8443/ (i.e. the SMC url without /siebel/smc)
  Property Attributes

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 21
  
  property :base_url, type: String

• #graceful_timeout ⇒ Integer (Default Value: 60)
  The amount of time, in seconds, to wait for tomcat to shut down before sending it the kill signal
  Property Attributes
  • default ⇒ 60

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 23
  
  property :graceful_timeout, type: Integer, default: 60

• #non_graceful_timeout ⇒ Integer (Default Value: 180)
  The amount of time, in seconds, to wait for tomcat to shut down before sending it the kill -9 signal
  Property Attributes
  • default ⇒ 180

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 25
  
  property :non_graceful_timeout, type: Integer, default: 180

• #local_http ⇒ [TrueClass, FalseClass]
  Should we always try and connect to the application interface from the local host, or always ssh? Set this to "false" if you have a firewall that takes a very long time to time out This defaults to detecting by trying - see the `http_connect_timeout` property for how long that will be tried for
  Property Attributes

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 31
  
  property :local_http, type: [TrueClass, FalseClass]

• #http_connect_timeout ⇒ Integer (Default Value: 30)
  The maximum amount of time to wait for the initial SMC response The default is 30s, which is a reasonable amount of time for the login page to show. You can reduce this if you want that check to be speedier, but maybe better to se the `local_http` property instead
  Property Attributes
  • default ⇒ 30

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 35
  
  property :http_connect_timeout, type: Integer, default: 30

• #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

  # File 'src/oracle-siebel/lib/oracle-siebel/application_interface.rb', line 37
  
  property :disable_application_container, type: [TrueClass, FalseClass], default: false

• #name ⇒ String
  
  Property Attributes

  # 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

  # 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

  # 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

  # 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

  # 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

  # 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 }

  # 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

• #container_path ⇒ Object
• #initialize(opts = {}) ⇒ ApplicationInterface constructor
  A new instance of ApplicationInterface.
• #post_start ⇒ Object
• #process_name ⇒ Object
• #running? ⇒ Boolean
• #start_async ⇒ Object
• #stop_async ⇒ Object
• #stopped? ⇒ Boolean

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 inherited from Instances::Instance

#create, #destroy, #exists?, #has_process?, #internal_call, #process_id, #real_state, #shutdown, #shutdown_async, #start, #state, #stop

Constructor Details

#initialize(opts = {}) ⇒ ApplicationInterface

Returns a new instance of ApplicationInterface.

Instance Method Details

#container_path ⇒ Object

#post_start ⇒ Object

#process_name ⇒ Object

#running? ⇒ Boolean

Returns:

• (Boolean)

#start_async ⇒ Object

#stop_async ⇒ Object

#stopped? ⇒ Boolean

Returns:

• (Boolean)