Class: MintPress::Siebel::Gateway

Inherits:

Instances::Instance

• Object
• Instances::Instance
• MintPress::Siebel::Gateway

Includes:

Mixins::Properties, ControllableMixin, Utils

Defined in:

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

Properties (Read/Write)

• #application_interface ⇒ MintPress::Siebel::ApplicationInterface (Default Value: Proc.new { $default_ai })
  
  Property Attributes
  • required ⇒ true
  • default ⇒ Proc.new { $default_ai }

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 13
  
  property :application_interface, type: MintPress::Siebel::ApplicationInterface, required: true, default: Proc.new { $default_ai }

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

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 14
  
  property :installation, type: MintPress::Siebel::Installation, required: true

• #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { if self.installation then installation.host else $default_ai.host end })
  
  Property Attributes
  • default ⇒ Proc.new { if self.installation then installation.host else $default_ai.host end }

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 15
  
  property :host, type: MintPress::Infrastructure::Host, default: Proc.new { if self.installation then installation.host else $default_ai.host end }

• #http_port ⇒ Integer (Default Value: Proc.new { installation.ec_http_connection_port })
  
  Property Attributes
  • default ⇒ Proc.new { installation.ec_http_connection_port }

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 16
  
  property :http_port, type: Integer, default: Proc.new { installation.ec_http_connection_port }

• #https_port ⇒ Integer (Default Value: Proc.new { installation.ec_https_redirect_port })
  
  Property Attributes
  • default ⇒ Proc.new { installation.ec_https_redirect_port }

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 17
  
  property :https_port, type: Integer, default: Proc.new { installation.ec_https_redirect_port }

• #instance_home ⇒ String (Default Value: Proc.new { self.get_oracle_home })
  
  Property Attributes
  • default ⇒ Proc.new { self.get_oracle_home }
  • alias ⇒ :oracle_home

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 18
  
  property :instance_home, type: String, default: Proc.new { self.get_oracle_home }, alias: :oracle_home

• #client_oracle_home ⇒ String
  
  Property Attributes
  • required ⇒ true

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 19
  
  property :client_oracle_home, type: String, required: true

• #security_profile ⇒ String (Default Value: "gateway")
  FIXME: have this be able to reference an object as well
  Property Attributes
  • default ⇒ "gateway"

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 22
  
  property :security_profile, type: String, default: "gateway"

• #host_uri ⇒ String (Default Value: Proc.new { uri = "https://#{self.host.name}:#{self.https_port}" uri })
  property :host_uri, type: String, default: Proc.new { t = installation.host.transport ; uri = "#{installation.host.name}:#{self.tls_port}" ; uri }
  Property Attributes
  • default ⇒ Proc.new { uri = "https://#{self.host.name}:#{self.https_port}" uri }

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 25
  
  property :host_uri, type: String, default: Proc.new { 
    uri = "https://#{self.host.name}:#{self.https_port}" 
    uri 
  }

• #tls_port ⇒ Integer (Default Value: 9011)
  
  Property Attributes
  • default ⇒ 9011

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 29
  
  property :tls_port, type: Integer, default: 9011

• #registry_port ⇒ Integer (Default Value: 2320)
  This should be seperated out, obv....
  Property Attributes
  • default ⇒ 2320

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 32
  
  property :registry_port, type: Integer, default: 2320

• #registry_username ⇒ String (Default Value: 'SADMIN')
  
  Property Attributes
  • default ⇒ 'SADMIN'

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 33
  
  property :registry_username, type: String, default: 'SADMIN'

• #registry_password ⇒ Mint::Secret
  
  Property Attributes
  • from ⇒ String

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 34
  
  property :registry_password, type: Mint::Secret, from: String

• #primary_language ⇒ String (Default Value: 'enu')
  , allowed_values: ['English', 'German', 'Chinese', 'Japanese', 'Hebrew', 'Finnish']
  Property Attributes
  • default ⇒ 'enu'

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 35
  
  property :primary_language, type: String, default: 'enu'

• #enforce_gateway_configuration ⇒ [TrueClass, FalseClass] (Default Value: false)
  When setting the gateway TLS port, should we override the properties file in case siebel gets this wronh - set this to true for versions 17,18 and _some_ varients of 20, and to false for later versions of 20 and 21
  Property Attributes
  • default ⇒ false

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 38
  
  property :enforce_gateway_configuration, type: [TrueClass, FalseClass], default: false

• #restart_after_bootstrap ⇒ [TrueClass, FalseClass] (Default Value: true)
  Do a restart _after_ cgbootstrap? This is required at some environments, due to a race condition in siebel It's never been required in ours, but seems to be required in some performance profiles to ensure the TLS port comes up. We're defaulting this to true, because it does not seem to hurt
  Property Attributes
  • default ⇒ true

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 42
  
  property :restart_after_bootstrap,  type: [TrueClass, FalseClass], default: true

• #include_uri_scheme_in_cghost ⇒ [TrueClass, FalseClass] (Default Value: false)
  Should we include the URI scheme (i.e. https://) in the REST request when we create the gateway?
  Property Attributes
  • default ⇒ false

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 45
  
  property :include_uri_scheme_in_cghost, type: [TrueClass, FalseClass], default: false

• #include_tls_port ⇒ [TrueClass, FalseClass] (Default Value: true)
  should we include the CGTlsPort parameter?
  Property Attributes
  • default ⇒ true

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 47
  
  property :include_tls_port, type: [TrueClass, FalseClass], default: true

• #manage_via_container ⇒ [TrueClass, FalseClass] (Default Value: false)
  Should we ensure the application container is up/down when we start/stop this?
  Property Attributes
  • default ⇒ false

  # File 'src/oracle-siebel/lib/oracle-siebel/gateway.rb', line 50
  
  property :manage_via_container, type: [TrueClass, FalseClass], default: false

• #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/gateway.rb', line 52
  
  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

• #bootstrap_registry ⇒ Object
• #configure ⇒ Object
• #container_path ⇒ Object
• #container_stopped?(host_obj: nil) ⇒ Boolean
• #delete ⇒ Object
• #delete_registry ⇒ Object
• #exists? ⇒ Boolean
• #gateway_exists? ⇒ Boolean
• #get ⇒ Object
• #get_property_from_target(prop) ⇒ Object
• #initialize(opts = {}) ⇒ Gateway constructor
  A new instance of Gateway.
• #process_name ⇒ Object
• #registry_exists? ⇒ Boolean
• #running? ⇒ Boolean
• #start_async ⇒ Object
• #start_siebel_gateway ⇒ Object
• #stop_async ⇒ Object
• #stop_siebel_gateway ⇒ Object
• #stopped? ⇒ Boolean

Methods included from 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, #siebel_gateway_running?, #siebel_gateway_stopped?, #siebel_server_running?, #siebel_server_stopped?, #start_appcontainer, #start_application_interface, #start_enterprise_container, #start_siebel_server, #start_tomcat_container, #stop_appcontainer, #stop_application_interface, #stop_enterprise_container, #stop_siebel_server, #stop_tomcat_container, #tomcat_container_stopped?

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

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

Constructor Details

#initialize(opts = {}) ⇒ Gateway

Returns a new instance of Gateway.

Instance Method Details

#bootstrap_registry ⇒ Object

#configure ⇒ Object

#container_path ⇒ Object

#container_stopped?(host_obj: nil) ⇒ Boolean

Returns:

• (Boolean)

#delete ⇒ Object

#delete_registry ⇒ Object

#exists? ⇒ Boolean

Returns:

• (Boolean)

#gateway_exists? ⇒ Boolean

Returns:

• (Boolean)

#get ⇒ Object

#get_property_from_target(prop) ⇒ Object

#process_name ⇒ Object

#registry_exists? ⇒ Boolean

Returns:

• (Boolean)

#running? ⇒ Boolean

Returns:

• (Boolean)

#start_async ⇒ Object

#start_siebel_gateway ⇒ Object

#stop_async ⇒ Object

#stop_siebel_gateway ⇒ Object

#stopped? ⇒ Boolean

Returns:

• (Boolean)