Class: ForgeRock::IdentityManagement::Instance

Inherits:
Object
  • Object
show all
Includes:
Utils, ForgeRock::IdentityPlatform::Utils, MintLogger, MintPress::Mixins::Properties
Defined in:
src/forgerock/lib/forgerock/identity/identity-management.rb

Properties (Read/Write)

  • #installation ⇒ ForgeRock::IdentityManagement::Installation
    OPENIDM installation
    Property Attributes 
    

36
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 36

property :installation, type: ForgeRock::IdentityManagement::Installation
  • #java_home ⇒ Pathname (Default Value: Proc.new { self.installation.java_home })
    OPENIDM_JAVA_HOME - automatically derived from the installation if it is provided
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    • default ⇒ Proc.new { self.installation.java_home }
    

39
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 39

property :java_home, type: Pathname, from: String, required: true, default: Proc.new { self.installation.java_home }
  • #openidm_home ⇒ Pathname (Default Value: Proc.new { self.installation.openidm_home })
    OPENIDM_JAVA_HOME - automatically derived from the installation if it is provided
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    • default ⇒ Proc.new { self.installation.openidm_home }
    

42
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 42

property :openidm_home, type: Pathname, from: String, required: true, default: Proc.new { self.installation.openidm_home }
  • #owner ⇒ String (Default Value: Proc.new { self.installation.owner })
    OPENIDM Owner - automatically derived from the installation if it is provided
    Property Attributes
    • required ⇒ true
    • default ⇒ Proc.new { self.installation.owner }
    

45
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 45

property :owner, type: String, required: true, default: Proc.new { self.installation.owner }
  • #group ⇒ String (Default Value: Proc.new { self.installation.group })
    OPENIDM Group - automatically derived from the installation if it is provided
    Property Attributes
    • required ⇒ true
    • default ⇒ Proc.new { self.installation.group }
    

48
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 48

property :group, type: String, required: true, default: Proc.new { self.installation.group }
  • #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { r = nil if self.get_property(:installation) and self.installation.host.is_a?(MintPress::Infrastructure::Host) r = self.installation.host end r })
    The host object associated with this Identity Management instance
    Property Attributes
    • default ⇒ Proc.new { r = nil if self.get_property(:installation) and self.installation.host.is_a?(MintPress::Infrastructure::Host) r = self.installation.host end r }
    • required ⇒ true
    • no_backref ⇒ true
    • parallel ⇒ true
    • disposition ⇒ :requires
    

51
52
53
54
55
56
57
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 51

property :host, type: MintPress::Infrastructure::Host, default: Proc.new { 
  r = nil
  if self.get_property(:installation) and self.installation.host.is_a?(MintPress::Infrastructure::Host)
      r = self.installation.host
  end 
  r 
}, required: true, no_backref: true, parallel: true, disposition: :requires
  • #hostname ⇒ String (Default Value: Proc.new { r = nil if self.get_property(:installation) and self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation) r = self.installation.host.fqdn end r })
    The fully-qualified directory server host name that will be used when generating self-signed certificates for LDAP SSL/StartTLS, the administration connector, and replication
    Property Attributes
    • default ⇒ Proc.new { r = nil if self.get_property(:installation) and self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation) r = self.installation.host.fqdn end r }
    • required ⇒ true
    

62
63
64
65
66
67
68
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 62

property :hostname, type: String, default: Proc.new { 
  r = nil
  if self.get_property(:installation) and self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation)
    r = self.installation.host.fqdn
  end 
  r 
}, required: true
  • #boot_properties ⇒ Hash of (Default Value: {})
    A Hash of properties in the form of { "property.name" => "value" } that will ultimately result in a property being updated in OPENIDM_HOME/resolver/boot.properties
    Property Attributes
    • on_set ⇒ Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }
    • default ⇒ {}
    • dotted_properties_allowed ⇒ true
    

72
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 72

property :boot_properties, hash: true, on_set: Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }, default: {}, dotted_properties_allowed: true
  • #config_properties ⇒ Hash of (Default Value: {})
    A Hash of properties in the form of { "property.name" => "value" } that will ultimately result in a property being updated in OPENIDM_HOME/conf/config.properties
    Property Attributes
    • on_set ⇒ Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }
    • default ⇒ {}
    • dotted_properties_allowed ⇒ true
    

76
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 76

property :config_properties, hash: true, on_set: Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }, default: {}, dotted_properties_allowed: true
  • #logging_properties ⇒ Hash of (Default Value: {})
    A Hash of properties in the form of { "property.name" => "value" } that will ultimately result in a property being updated in OPENIDM_HOME/conf/logging.properties
    Property Attributes
    • on_set ⇒ Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }
    • default ⇒ {}
    • dotted_properties_allowed ⇒ true
    

80
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 80

property :logging_properties, hash: true, on_set: Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }, default: {}, dotted_properties_allowed: true
  • #system_properties ⇒ Hash of (Default Value: {})
    A Hash of properties in the form of { "property.name" => "value" } that will ultimately result in a property being updated in OPENIDM_HOME/conf/system.properties
    Property Attributes
    • on_set ⇒ Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }
    • default ⇒ {}
    • dotted_properties_allowed ⇒ true
    

84
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 84

property :system_properties, hash: true, on_set: Proc.new { |h| Hashie.stringify_keys! h if h.is_a?(Hash) }, default: {}, dotted_properties_allowed: true
  • #instance_configs ⇒ Hash of ⇒ ForgeRock::IdentityManagement::InstanceConfig (Default Value: {})
    A Hash of JSON file configs for JSON configuration files located in OPENIDM_HOME/conf directory To update/interact with the JSON handler, see following example: instance_configs['cluster']['instanceTimeout'] = 60000 Setting the above property will update the cluster.json file located in the OPENIDM_HOME/conf with property instanceTimeout to 60000
    Property Attributes
    • from ⇒ Hash
    • default ⇒ {}
    

90
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 90

property :instance_configs, hash: true, type: ForgeRock::IdentityManagement::InstanceConfig, from: Hash, default: {}
  • #openidm_opts ⇒ Array of (Default Value: [])
    A Hash of properties that will be set as environment variable OPENIDM_OPTS e.g. [ "-Xmx1024m", "-Xms1024m", "-Dopenidm.repo.host=localhost", "-Dopenidm.repo.port=3306" ]
    Property Attributes
    • default ⇒ []
    

99
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 99

property :openidm_opts, array: true, default: []
  • #project_home ⇒ Pathname (Default Value: Proc.new { r = nil if self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation) r = "#{self.installation.openidm_home}/../project" elsif ! self.get_property(:openidm_home).nil? r = "#{self.openidm_home}/../project" end r })
    The project location specifies the directory that contains the configuration and script files that IDM will use. All configuration objects and any artifacts that are not in the bundled defaults (such as custom scripts) must be included in the project location. These objects include all files otherwise included in the openidm/conf and openidm/script directories. Default value:
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    • default ⇒ Proc.new { r = nil if self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation) r = "#{self.installation.openidm_home}/../project" elsif ! self.get_property(:openidm_home).nil? r = "#{self.openidm_home}/../project" end r }
    

106
107
108
109
110
111
112
113
114
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 106

property :projectHome, type: Pathname, from: String, required: true, default: Proc.new { 
  r = nil
  if self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation)
    r = "#{self.installation.openidm_home}/../project"
  elsif ! self.get_property(:openidm_home).nil?
    r = "#{self.openidm_home}/../project"
  end
  r
}
  • #working_location ⇒ Pathname (Default Value: Proc.new { r = nil if self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation) r = "#{self.installation.openidm_home}/../data" elsif ! self.get_property(:openidm_home).nil? r = "#{self.openidm_home}/../data" end r })
    The working location specifies the directory in which the embedded DS instance is installed, and the directory to which IDM writes its database cache, audit logs, and felix cache. The working location includes everything that is in the default db/, audit/, and felix-cache/ subdirectories. Default value:
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    • default ⇒ Proc.new { r = nil if self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation) r = "#{self.installation.openidm_home}/../data" elsif ! self.get_property(:openidm_home).nil? r = "#{self.openidm_home}/../data" end r }
    

120
121
122
123
124
125
126
127
128
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 120

property :workingLocation, type: Pathname, from: String, required: true, default: Proc.new { 
  r = nil
  if self.get_property(:installation).is_a?(ForgeRock::IdentityManagement::Installation)
    r = "#{self.installation.openidm_home}/../data"
  elsif ! self.get_property(:openidm_home).nil?
    r = "#{self.openidm_home}/../data"
  end
  r
}
  • #storage_location ⇒ Pathname
    Specifies the OSGi storage location of the cached configuration files. You can use this option to redirect output if you are installing on a read-only filesystem volume.
    Property Attributes
    • from ⇒ String
    

132
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 132

property :storageLocation, type: Pathname, from: String
  • #http_port ⇒ Integer (Default Value: 8080)
    OPENIDM HTTP Listen Port
    Property Attributes
    • from ⇒ String
    • default ⇒ 8080
    

135
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 135

property :httpPort, type: Integer, from: String, default: 8080
  • #https_port ⇒ Integer (Default Value: 8443)
    OPENIDM HTTPS Listen Port
    Property Attributes
    • from ⇒ String
    • default ⇒ 8443
    

138
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 138

property :httpsPort, type: Integer, from: String, default: 8443
  • #admin_username ⇒ String (Default Value: 'openidm-admin')
    OPENIDM Admin Username
    Property Attributes
    • default ⇒ 'openidm-admin'
    

141
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 141

property :adminUsername, type: String, default: 'openidm-admin'
  • #admin_password ⇒ Mint::Secret (Default Value: 'openidm-admin')
    OPENIDM Admin Password
    Property Attributes
    • from ⇒ String
    • default ⇒ 'openidm-admin'
    

144
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 144

property :adminPassword, type: Mint::Secret, from: String, default: 'openidm-admin'
  • #directory ⇒ ForgeRock::DirectoryServices::DirectoryServer
    IDM Repository - External Directory
    Property Attributes 
    

147
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 147

property :directory, type: ForgeRock::DirectoryServices::DirectoryServer
  • #configure_db ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    IDM Repository - External Oracle Database
    Property Attributes
    • default ⇒ false
    

150
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 150

property :configure_db, type: [ TrueClass, FalseClass ], default: false
  • #database ⇒ MintPress::OracleDatabase::Database

    Property Attributes 
    

151
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 151

property :database, type: MintPress::OracleDatabase::Database
  • #db_audit_logs_enabled ⇒ [ TrueClass, FalseClass ] (Default Value: false)

    Property Attributes
    • default ⇒ false
    

152
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 152

property :db_audit_logs_enabled, type: [ TrueClass, FalseClass ], default: false
  • #db_bootstrap ⇒ [ TrueClass, FalseClass ] (Default Value: false)

    Property Attributes
    • default ⇒ false
    

153
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 153

property :db_bootstrap, type: [ TrueClass, FalseClass ], default: false
  • #db_host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = self.get_property(:database, disable_proc: true).host end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = self.get_property(:database, disable_proc: true).host end r }
    

154
155
156
157
158
159
160
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 154

property :db_host, type: MintPress::Infrastructure::Host, default: Proc.new { 
  r = nil
  if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database)
    r = self.get_property(:database, disable_proc: true).host
  end
  r
}
  • #db_oracle_home ⇒ String (Default Value: Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = "#{self.get_property(:database, disable_proc: true).oracle_home}" end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = "#{self.get_property(:database, disable_proc: true).oracle_home}" end r }
    

161
162
163
164
165
166
167
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 161

property :db_oracle_home, type: String, default: Proc.new { 
  r = nil
  if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database)
    r = "#{self.get_property(:database, disable_proc: true).oracle_home}"
  end
  r
}
  • #db_version ⇒ String (Default Value: Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) verbose "PROC :db_version: #{self.get_property(:database, disable_proc: true).installation.version}" r = self.get_property(:database, disable_proc: true).installation.version end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) verbose "PROC :db_version: #{self.get_property(:database, disable_proc: true).installation.version}" r = self.get_property(:database, disable_proc: true).installation.version end r }
    

168
169
170
171
172
173
174
175
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 168

property :db_version, type: String, default: Proc.new { 
  r = nil
  if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database)
    verbose "PROC :db_version: #{self.get_property(:database, disable_proc: true).installation.version}"
    r = self.get_property(:database, disable_proc: true).installation.version
  end
  r
}
  • #db_connect_address ⇒ String (Default Value: Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = "#{self.get_property(:database, disable_proc: true).db_connect_address}" end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = "#{self.get_property(:database, disable_proc: true).db_connect_address}" end r }
    

176
177
178
179
180
181
182
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 176

property :db_connect_address, type: String, default: Proc.new { 
  r = nil
  if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database)
    r = "#{self.get_property(:database, disable_proc: true).db_connect_address}"
  end
  r
}
  • #db_connect_port ⇒ Integer (Default Value: Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = self.get_property(:database, disable_proc: true).db_connect_port.to_i end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = self.get_property(:database, disable_proc: true).db_connect_port.to_i end r }
    

183
184
185
186
187
188
189
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 183

property :db_connect_port, type: Integer, default: Proc.new { 
  r = nil
  if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database)
    r = self.get_property(:database, disable_proc: true).db_connect_port.to_i
  end
  r
}
  • #db_service_name ⇒ String (Default Value: Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = "#{self.get_property(:database, disable_proc: true).db_service_name}" end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database) r = "#{self.get_property(:database, disable_proc: true).db_service_name}" end r }
    

190
191
192
193
194
195
196
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 190

property :db_service_name, type: String, default: Proc.new { 
  r = nil
  if ! self.get_property(:database, disable_proc: true).nil? and self.get_property(:database, disable_proc: true).is_a?(MintPress::OracleDatabase::Database)
    r = "#{self.get_property(:database, disable_proc: true).db_service_name}"
  end
  r
}
  • #db_url ⇒ String (Default Value: Proc.new { r = nil if ! self.get_property(:database).nil? and self.get_property(:database).is_a?(MintPress::OracleDatabase::Database) r = "jdbc:oracle:thin:@&{openidm.repo.host}:&{openidm.repo.port}:#{self.get_property(:database).db_service_name}" end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if ! self.get_property(:database).nil? and self.get_property(:database).is_a?(MintPress::OracleDatabase::Database) r = "jdbc:oracle:thin:@&{openidm.repo.host}:&{openidm.repo.port}:#{self.get_property(:database).db_service_name}" end r }
    

198
199
200
201
202
203
204
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 198

property :db_url, type: String, default: Proc.new { 
  r = nil
  if ! self.get_property(:database).nil? and self.get_property(:database).is_a?(MintPress::OracleDatabase::Database)
    r = "jdbc:oracle:thin:@&{openidm.repo.host}:&{openidm.repo.port}:#{self.get_property(:database).db_service_name}"
  end
  r
}
  • #db_username ⇒ String
    Username for the OPENIDM Repo DB user
    Property Attributes 
    

206
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 206

property :db_username, type: String
  • #db_password ⇒ Mint::Secret
    Password for the OPENIDM Repo DB user
    Property Attributes
    • from ⇒ String
    

208
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 208

property :db_password, type: Mint::Secret, from: String
  • #db_datasource_connection_timeout ⇒ Integer (Default Value: 30000)
    Default Database datasource connection timeout (in milliseconds)
    Property Attributes
    • default ⇒ 30000
    

211
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 211

property :db_datasource_connectionTimeout, type: Integer, default: 30000
  • #db_datasource_min_pool_size ⇒ Integer (Default Value: 20)
    Default Database datasource minimum connection pool size
    Property Attributes
    • default ⇒ 20
    

213
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 213

property :db_datasource_minPoolSize, type: Integer, default: 20
  • #db_datasource_max_pool_size ⇒ Integer (Default Value: 50)
    Default Database datasource maximum connection pool size
    Property Attributes
    • default ⇒ 50
    

215
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 215

property :db_datasource_maxPoolSize, type: Integer, default: 50
  • #db_ojdbc_jar ⇒ Pathname
    OJDBC8 JAR required for Oracle Database IDM Repository. Download JAR from location https://download.oracle.com/otn/utilities_drivers/jdbc/122010/ojdbc8.jar
    Property Attributes
    • from ⇒ String
    

218
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 218

property :db_ojdbc_jar, type: Pathname, from: String
  • #db_ucp_jar ⇒ Pathname
    Oracle Universal Connection Pool JAR required for Oracle Database IDM Repository. Download JAR from location https://download.oracle.com/otn/utilities_drivers/jdbc/122010/ucp.jar
    Property Attributes
    • from ⇒ String
    

220
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 220

property :db_ucp_jar, type: Pathname, from: String
  • #db_ons_jar ⇒ Pathname
    Oracle Notification Service JAR required for Oracle Database IDM Repository. Download JAR from location https://download.oracle.com/otn/utilities_drivers/jdbc/122010/ons.jar
    Property Attributes
    • from ⇒ String
    

222
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 222

property :db_ons_jar, type: Pathname, from: String
  • #db_bnd_jar ⇒ Pathname
    BND JAR required for Oracle Database IDM Repository. Download JAR from location http://central.maven.org/maven2/biz/aQute/bnd/bnd/2.4.0/bnd-2.4.0.jar
    Property Attributes
    • from ⇒ String
    

224
    		 
    # File 'src/forgerock/lib/forgerock/identity/identity-management.rb', line 224

property :db_bnd_jar, type: Pathname, from: String

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_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

Constructor Details

#initialize(opts = {}) ⇒ Instance

Returns a new instance of Instance.

Instance Method Details

#active_ready? ⇒ TrueClass | FalseClass

Determine whether state of server is ACTIVE_READY

Returns:

  • (TrueClass | FalseClass)

#clobber ⇒ void

This method returns an undefined value.

Clobber the ForgeRock Identity Management instance

#clobber_systemd ⇒ void

This method returns an undefined value.

Remove the SYSTEMD configuration

#clobber_sysv ⇒ void

This method returns an undefined value.

Remove the SYSV configuration

#configexport(location = "#{host.temp_folder}") ⇒ void

This method returns an undefined value.

The configexport subcommand exports all configuration objects to a specified location, enabling you to reuse a system configuration in another environment. For example, you can test a configuration in a development environment, then export it and import it into a production environment. This subcommand also enables you to inspect the active configuration of an IDM instance.

#configimport(location, replace_all: false, retries: 10, retry_delay: 500) ⇒ void

This method returns an undefined value.

The configimport subcommand imports configuration objects from the specified directory, enabling you to reuse a system configuration from another environment. For example, you can test a configuration in a development environment, then export it and import it into a production environment. The command updates the existing configuration from the import-location over the REST interface. By default, if configuration objects are present in the import-location and not in the existing configuration, these objects are added. If configuration objects are present in the existing location but not in the import-location, these objects are left untouched in the existing configuration.

#configure ⇒ void

This method returns an undefined value.

Configure the ForgeRock Identity Management instance

#configure_systemd ⇒ void

This method returns an undefined value.

If you're running relatively standard versions of Red Hat Enterprise Linux (CentOS Linux) version 7.x, or Ubuntu 16.04 and later, you'll want to set up a systemd service script. To set up such a script, navigate to the /path/to/openidm/bin directory, and run the following command:

#configure_sysv ⇒ void

This method returns an undefined value.

If you're running relatively standard versions of Red Hat Enterprise Linux (CentOS Linux) version 6.x, you'll want to set up a SysV service script, with runlevels controlled through the chkconfig command. To set up such a script, navigate to the /path/to/openidm/bin directory, and run the following command:

#configurewithrest ⇒ Object

#create_user ⇒ Object

#encrypt(content, is_json: false) ⇒ String

The encrypt subcommand encrypts an input string, or JSON object, provided at the command line. This subcommand can be used to encrypt passwords, or other sensitive data, to be stored in the repository. The encrypted value is output to standard output and provides details of the cryptography key that is used to encrypt the data.

Returns:

  • (String) —
    Encrypted Hash to be placed in configuration using .to_json

#exist? ⇒ Boolean

Alias for exists?

Returns:

  • (Boolean)

#exists? ⇒ TrueClass | FalseClass

Does the Identity Management instance exist

Returns:

  • (TrueClass | FalseClass)

#features ⇒ Hash

Return list of features enabled on the Server instance

Returns:

  • (Hash) —
    Features enabled on the Server Instance

#get_user(username) ⇒ Hash

Fetch the newly created user from the repository with a RESTful GET:

Returns:

  • (Hash) —
    details for the user

#harden ⇒ Object

#harvest ⇒ void

This method returns an undefined value.

Return a Hash representation for object and all its sub-classes and load into class instance

#list_users ⇒ Hash

Access the following URL to obtain the JSON representation of all users in the IDM repository:

Returns:

  • (Hash) —
    list of all users in the IDM respository

#load_properties(props) ⇒ Hash

Load properties from .properties file

Returns:

  • (Hash) —
    Hash represenation of all the properties

#maintenance_disable ⇒ void

This method returns an undefined value.

Disable server maintenance mode

#maintenance_enable ⇒ void

This method returns an undefined value.

Enable server maintenance mode

#maintenance_enabled? ⇒ TrueClass | FalseClass

Return whether the server is in maintenance mode

Returns:

  • (TrueClass | FalseClass) —
    whether the server is in maintenance mode

#ping ⇒ String

Return PING response from the instance Basic Health Checks The health check service reports on the state of the server and outputs this state to the OSGi console and to the log files. The server can be in one of the following states: STARTING - the server is starting up ACTIVE_READY - all of the specified requirements have been met to consider the server ready ACTIVE_NOT_READY - one or more of the specified requirements have not been met and the server is not considered ready STOPPING - the server is shutting down

Returns:

  • (String) —
    PING response from the Server Instance

#reset ⇒ void

This method returns an undefined value.

Reset the ForgeRock Identity Management instance This resets the DB repository to allow a fresh restart of the configuration

#running? ⇒ TrueClass, FalseClass

Is the server running?

Returns:

  • (TrueClass, FalseClass)

#securehash(content, is_json: false, algorithm: "SHA-256") ⇒ String

The secureHash subcommand hashes an input string, or JSON object, using the specified hash algorithm. This subcommand can be used to hash password values, or other sensitive data, to be stored in the repository. The hashed value is output to standard output and provides details of the algorithm that was used to hash the data. IDM supports the following hash algorithms: - SHA-256 - SHA-384 - SHA-512 - Bcrypt - Scrypt - Password-Based Key Derivation Function 2 (PBKDF2)

Returns:

  • (String) —
    Encrypted Hash to be placed in configuration using .to_json

#start ⇒ void

This method returns an undefined value.

Start the instance if it is not running

#state ⇒ String

Return server instance status The health check service reports on the state of the server and outputs this state to the OSGi console and to the log files. The server can be in one of the following states: STARTING - the server is starting up ACTIVE_READY - all of the specified requirements have been met to consider the server ready ACTIVE_NOT_READY - one or more of the specified requirements have not been met and the server is not considered ready STOPPING - the server is shutting down

Returns:

  • (String) —
    State of the Server Instance

#status ⇒ String

Return server instance status

Returns:

  • (String) —
    Status response from Server Instance

#stop ⇒ void

This method returns an undefined value.

Stop the instance if it is running

#to_hash ⇒ Hash

Return a Hash representation and all its sub-classes.

Returns:

  • (Hash) —
    the object in Hash format

#update_password ⇒ void

This method returns an undefined value.

The default security settings are adequate for evaluation purposes. In production environments, change at least the following settings: The password of the default administrative user (openidm-admin) The default keystore password

#updaterestcontext ⇒ Object

#usage ⇒ Object

#validate ⇒ void

This method returns an undefined value.

Validate the JSON configuration files in the PROJECT_HOME/conf location using [ cli.sh validate ]