Class: ForgeRock::IdentityManagement::Installation

Inherits:
ForgeRock::IdentityPlatform::Installation show all
Includes:
Utils, ForgeRock::IdentityPlatform::Utils, MintLogger, MintPress::Mixins::Properties
Defined in:
src/forgerock/lib/forgerock/identity/installation.rb

Properties (Read/Write)

  • #openidm_home ⇒ Pathname
    OPENIDM_HOME install path location - this can come directly
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    

33
    		 
    # File 'src/forgerock/lib/forgerock/identity/installation.rb', line 33

property :openidm_home, type: Pathname, from: String, required: true
  • #name ⇒ String (Default Value: self.class.to_s.gsub('::',''))

    Property Attributes
    • default ⇒ self.class.to_s.gsub('::','')
    

33
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 33

property :Name, type: String, default: self.class.to_s.gsub('::','')
  • #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { r = nil if self.get_property(:java) and self.java.host.is_a?(MintPress::Infrastructure::Host) r = self.java.host end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if self.get_property(:java) and self.java.host.is_a?(MintPress::Infrastructure::Host) r = self.java.host end r }
    • required ⇒ true
    • no_backref ⇒ true
    • parallel ⇒ true
    • disposition ⇒ :requires
    

35
36
37
38
39
40
41
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 35

property :host, type: MintPress::Infrastructure::Host, default: Proc.new { 
  r = nil
  if self.get_property(:java) and self.java.host.is_a?(MintPress::Infrastructure::Host)
      r = self.java.host
  end 
  r 
}, required: true, no_backref: true, parallel: true, disposition: :requires
  • #java ⇒ MintPress::OracleJava::Installation
    The java installation to use for this installation
    Property Attributes
    • disposition ⇒ :requires
    • no_backref ⇒ true
    

44
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 44

property :java, type: MintPress::OracleJava::Installation, disposition: :requires, no_backref: true
  • #java_home ⇒ Pathname (Default Value: Proc.new { r = nil if self.get_property(:java).is_a?(MintPress::OracleJava::Installation) r = self.java.java_home end r })
    Java Home location - this can come from either a "real" java home folder, from a java installation, or from another weblogic- the advantage of the latter two is, of course, dependency stuff Also, this is completley bollocksed for some reason.....
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { r = nil if self.get_property(:java).is_a?(MintPress::OracleJava::Installation) r = self.java.java_home end r }
    • required ⇒ true
    

50
51
52
53
54
55
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 50

property :java_home, type: Pathname, from: String, default: Proc.new { 
r = nil
if self.get_property(:java).is_a?(MintPress::OracleJava::Installation) 
  r = self.java.java_home
end 
r }, required: true
  • #version ⇒ String
    The version of the software to install. If there is a parent installation, or a domain, the version can be taken from those instead.
    Property Attributes
    • required ⇒ true
    

58
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 58

property :version, type: String, required: true
  • #owner ⇒ String
    The OS owner of these files. This will default to the current user
    Property Attributes
    • required ⇒ false
    

61
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 61

property :owner, type: String, required: false
  • #group ⇒ String
    The OS group of these files. This will default to the primary group of the current user.
    Property Attributes
    • required ⇒ false
    

64
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 64

property :group, type: String, required: false
  • #software_stage ⇒ Pathname
    Location of the installer binary
    Property Attributes
    • from ⇒ String
    • alias ⇒ :stage
    

67
    		 
    # File 'src/forgerock/lib/forgerock/installation.rb', line 67

property :software_stage, type: Pathname, from: String, alias: :stage

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 MintPress::Mixins::Properties

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

Instance Method Summary collapse

Methods included from Utils

#admin_transport, #cli, #rest, #transport

Methods included from MintPress::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 ForgeRock::IdentityPlatform::Installation

#harvest, #install_zip_archive, #transport, #version_numeric

Constructor Details

#initialize(opts = {}) ⇒ Installation

Returns a new instance of Installation.

Instance Method Details

#clobber ⇒ void

This method returns an undefined value.

Clobber the ForgeRock Identity Management installation

#exist? ⇒ Boolean

Alias for exists?

Returns:

  • (Boolean)

#exists? ⇒ Boolean

Does the installation exist

Returns:

  • (Boolean)

#install ⇒ void

This method returns an undefined value.

Install the ForgeRock Identity Management software

#installed_version ⇒ Object

Get the installed version

#installed_version_numeric ⇒ Object

Get the installed version in numeric format

#killall ⇒ void

This method returns an undefined value.

Kill all processes running out of OPENIDM_HOME

#to_hash ⇒ Hash

Return a Hash representation for the Installation and all its sub-classes.

Returns:

  • (Hash) —
    the object in Hash format

#uninstall ⇒ Object

Alias method to clobber

#usage ⇒ Object