Class: MintPress::OracleDocumaker::DocserverInstance

Inherits:
MintPress::OracleWeblogic::FMWInstance show all
Defined in:
src/oracle-documaker/lib/oracle-documaker/docserver_instance.rb

Properties (Read/Write)

  • #documaker_home ⇒ String (Default Value: Proc.new { "#{self.instance_fmw_home}/odee_12" })
    Documaker home folder - it is usually unnessesary to change this from the default, as long as there is access to instance_fmw_home via either a domain link or an installation link
    Property Attributes
    • default ⇒ Proc.new { "#{self.instance_fmw_home}/odee_12" }
    [View source]
    
9
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/docserver_instance.rb', line 9

property :documaker_home, type: String, default: Proc.new { "#{self.instance_fmw_home}/odee_12" }
  • #docserver_instances ⇒ Integer (Default Value: Proc.new { begin if installation.version.to_f >= 12.7 then 2 else 3 end rescue => e verbose "Installation object not found. No way to determine the number of instances so defaulting to 2. Update docserver_instances property to control instances" 2 end })
    'The number of process Docfactory should start, this is the number MintPress will look for when starting Docserver services. If you have more processes, increase this number to match. You can also decrease this number if you have less processes running. Default for version < 12.7 is 3, for > 12.7 is 2.'
    Property Attributes
    • default ⇒ Proc.new { begin if installation.version.to_f >= 12.7 then 2 else 3 end rescue => e verbose "Installation object not found. No way to determine the number of instances so defaulting to 2. Update docserver_instances property to control instances" 2 end }
    [View source]
    
12
13
14
15
16
17
18
19
20
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/docserver_instance.rb', line 12

property :docserver_instances, type: Integer, default: Proc.new { 
begin  
  if installation.version.to_f >= 12.7 then 2 else 3 end 
rescue => e
  verbose "Installation object not found. No way to determine the number of instances so defaulting to 2. Update docserver_instances property to control instances"
  2
end
  
}, description: 'The number of process Docfactory should start, this is the number MintPress will look for when starting Docserver services. If you have more processes, increase this number to match. You can also decrease this number if you have less processes running. Default for version < 12.7 is 3, for > 12.7 is 2.'
  • #installation ⇒ MintPress::OracleWeblogic::Installation
    Installation must be an FMW installation for this type
    Property Attributes
    [View source]
    
10
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/fmw_instance.rb', line 10

property :installation, type: MintPress::OracleWeblogic::Installation
  • #instance_home
    This is where the instance lives under that - each product will usually extend this default... an example might be for documaker, the instances are in #{instance_fmw_home}/odee_12
    Property Attributes
    • required ⇒ true
    [View source]
    
14
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/fmw_instance.rb', line 14

property :instance_home, required: true
  • #instance_fmw_home (Default Value: Proc.new { r = nil if self.installation and self.installation.respond_to?(:fmw_home) and self.installation.fmw_home r = self.installation.fmw_home elsif self.domain and self.domain.java_home r = self.domain.java_home end r })
    This is the FMW home that we discover
    Property Attributes
    • default ⇒ Proc.new { r = nil if self.installation and self.installation.respond_to?(:fmw_home) and self.installation.fmw_home r = self.installation.fmw_home elsif self.domain and self.domain.java_home r = self.domain.java_home end r }
    [View source]
    
17
18
19
20
21
22
23
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/fmw_instance.rb', line 17

property :instance_fmw_home, default: Proc.new { r = nil
if self.installation and self.installation.respond_to?(:fmw_home) and self.installation.fmw_home
  r = self.installation.fmw_home
elsif self.domain and self.domain.java_home
 r = self.domain.java_home
end
r }
  • #domain ⇒ MintPress::OracleWeblogic::Domain
    Optionally, this can be linked to a domain - if it is, it'll try and get fmw_home from there
    Property Attributes
    • required ⇒ false
    [View source]
    
26
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/fmw_instance.rb', line 26

property :domain, type: MintPress::OracleWeblogic::Domain, required: false
  • #java_home
    java_home for the instance - if we're hooked to a domain
    Property Attributes
    • defualt ⇒ Proc.new { r = nil if self.installation and self.installation.java_home r = self.installation.java_home elsif self.get_property(:domain) and self.domain.java_home r = self.domain.java_home end r }
    [View source]
    
29
30
31
32
33
34
35
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/fmw_instance.rb', line 29

property :java_home, defualt: Proc.new { r = nil
if self.installation and self.installation.java_home
  r = self.installation.java_home
elsif self.get_property(:domain) and self.domain.java_home
  r = self.domain.java_home
end
r }
  • #name ⇒ String

    Property Attributes
    [View source]
    
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
    [View source]
    
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
    [View source]
    
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
    [View source]
    
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
    [View source]
    
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
    [View source]
    
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 }
    [View source]
    
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 inherited from Instances::Instance

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

Methods included from MintLogger::Utils::Common

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

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

Constructor Details

#initialize(opts = {}) ⇒ DocserverInstance

Returns a new instance of DocserverInstance.

Instance Method Details

#create ⇒ Object

#destory ⇒ Object

#exists? ⇒ Boolean

Returns:

  • (Boolean)

#process_name ⇒ Object

This will allow the generic ps stuff to ensure that we're not dead dead

#running? ⇒ Boolean

Returns:

  • (Boolean)

#start_async ⇒ Object

Impletement start_async and let the framework take care of this!

#stop_async ⇒ Object