public interface CollectiveRegistrationMBean
The ObjectName for this MBean is "WebSphere:feature=collectiveController,type=CollectiveRegistration,name=CollectiveRegistration".
The registration operations must provide sufficient data (the host authentication information) for a remote client to be able to start the server. The unregistration operation removes all data associated with the host or server from the collective.
The values specified to the host authentication information should match the values set in the <hostAuthInfo> configuration element for the registered server. Host authentication information should define sufficient information to authenticate the operating system user, using either the user's password or an SSH private key. Use of keys is encouraged; use of passwords is discouraged.
null
during host registration. May be null
during host updates, if there is no data to be changed.
When specified, the hostAuthInfo map must be complete. Partial updates of the information are not supported.
For example, if the "rpcUserPassword" password has changed, the entire set of required properties must be defined to the host update operation: the "rpcUserPassword", the "rpcUserPassword", and any other information.
Recognized properties are summarized in the following table. Most property values are non-empty Strings, with types and further constraints list by key. Complete details for each property are documented with each property constant.Property Name | Description | Data Type / Format | Required/Optional |
---|---|---|---|
"useHostCredentials" | Indicates whether to inherit the host level credentials for member server RPC | Boolean | optional; default is false. If this option is set to true, all other RPC credentials specified in hostAuthInfo config element are ignored. |
"rpcHost" | The fully qualified host name or IP address | String | optional; defaults to the hostName parameter specified |
"rpcPort" | The SSH or RPC port number | Integer | optional; defaults to SSH port (22) |
"rpcUser" | The user ID for the remote connection | String | required |
"rpcUserPassword" | The password for the user ID | String (either clear text or encoded) | required if the "sshPrivateKey" property is not specified; otherwise optional |
"sshPrivateKey" | The SSH private key | String (either clear text or encoded) | required if the "rpcUserPassword" property is not specified; otherwise optional |
"sshPrivateKeyPassword" | The password for the SSH private key | String (either clear text or encoded) | required if the SSH private key is password protected; otherwise optional |
"useSudo" | Indicates whether using sudo should be used | Boolean | optional |
"sudoUser" | The sudo user ID | String | optional |
"sudoUserPassword" | The password for the sudo user | String (either clear text or encoded) | required if the "sudoUser" property specified and a password is required to authenticate as the sudo user; otherwise optional |
"hostReadList" | The list of locations on the host with allowed read-access. | List<String> (The list is allowed to be empty, and string inside it is also allowed to be empty) | optional N.B. This value should be specified in the host paths map. If the host paths map is provided, the value specified in the hostAuthInfo map will be ignored. |
"hostWriteList" | The list of locations on the host with allowed write-access. | List<String> (The list is allowed to be empty, and the string inside it is also allowed to be empty) | optional N.B. This value should be specified in the host paths map. If the host paths map is provided, the value specified in the hostAuthInfo map will be ignored. |
"hostJavaHome" | The location of the java installation to use for this host. | String (If specified, must not be empty) | optional N.B. This value should be specified in the host paths map. If the host paths map is provided, the value specified in the hostAuthInfo map will be ignored. |
null
. If host paths map is provided, all path values used are from this map.
If host paths map is not provided, some path values from hostAuthInfo map will be used (if defined in hostAuthInfo map).
See Host Authentication Informationfor the set of path values which hostAuthInfo map can define.
Partial updates of the host paths map is supported, individual keys are replaced with new values. For example, a host update operation can change only the "hostReadList" by specifying a new value in the host paths map. In this case, the other values in the host paths map are not changed, but the previous value of "hostReadList" is replaced with the new value specified in the host paths map.
Recognized properties are summarized in the following table. All properties are optional and are documented by key. Complete details for each property are documented with each property constant.Property Name | Description | Data Type / Format | Required/Optional |
---|---|---|---|
"hostReadList" | The list of locations on the host with allowed read-access. | List<String> (The list is allowed to be empty, and string inside it is also allowed to be empty) | optional |
"hostWriteList" | The list of locations on the host with allowed write-access. | List<String> (The list is allowed to be empty, and string inside it is also allowed to be empty) | optional |
"hostJavaHome" | The location of the java installation to use for this host. | String (If specified, must not be empty) | optional |
null
or an empty Map.
If the Map is null
or empty, all default values will be taken.
Recognized properties are summarized in the following table. All property values are non-empty Strings, with further constraints by key.
Complete details for each property are documented with each property constant.
Property Name | Description | Data Type / Format | Required/Optional |
---|---|---|---|
"serverIdentityKeystorePassword" | The password for the serverIdentity.jks keystore | String (either clear text or encoded) | optional; defaults to the specified keystorePassword parameter |
"serverIdentityCertificateValidity" | The validity period in number of days for the server identity certificate is valid for | Integer, unit is days | optional; defaults to 5 years or 1825 days |
"collectiveTrustKeystorePassword" | The password for the collectiveTrust.jks keystore | String (either clear text or encoded) | optional; defaults to the specified keystorePassword parameter |
"httpsKeystorePassword" | The password for the key.jks keystore | String (either clear text or encoded) | optional; defaults to the specified keystorePassword parameter |
"httpsCertificateSubject" | The DN to use as the HTTPS certificate subject | String | optional; defaults to CN=hostname,OU=serverName,O=ibm,C=us |
"httpsCertificateValidity" | The validity period in number of days for the HTTPS certificate is valid for | Integer, unit is days | optional; defaults to 5 years or 1825 days |
"httpsTruststorePassword" | The password for the trust.jks keystore | String (either clear text or encoded) | optional; defaults to the specified keystorePassword parameter |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CERTIFICATE_SUBJECT
The subject of the certificate for the genKey certificate.
|
static java.lang.String |
CERTIFICATE_VALIDITY
The validity in days of the certificate for the genKey certificate.
|
static java.lang.String |
COLLECTIVE_MEMBER_TYPE
Collective member type for host authentication information map.
|
static java.lang.String |
COLLECTIVE_TRUST_KEYSTORE_PASSWORD
The collectiveTrust.jks keystore password for the certificate properties.
|
static java.lang.String |
FILE_COLLECTIVE_NAME
Key for the collective.name entry in the map returned by replicate.
|
static java.lang.String |
FILE_COLLECTIVE_UUID
Key for the collective.uuid entry in the map returned by replicate.
|
static java.lang.String |
HOST_JAVA_HOME
The location of the java installation that the collective controller should use for this host.
|
static java.lang.String |
HOST_READ_LIST
A list of locations on the host with allowed read-access.
|
static java.lang.String |
HOST_WRITE_LIST
A list of locations on the host with allowed write-access.
|
static java.lang.String |
HTTPS_CERTIFICATE_SUBJECT
The subject of the HTTPS certificate for the certificate properties.
|
static java.lang.String |
HTTPS_CERTIFICATE_VALIDITY
The validity in days of the HTTPS certificate for the certificate properties.
|
static java.lang.String |
HTTPS_KEYSTORE_PASSWORD
The key.jks keystore password for the certificate properties.
|
static java.lang.String |
HTTPS_TRUSTSTORE_PASSWORD
The trust.jks keystore password for the certificate properties.
|
static java.lang.String |
KEYSTORE_COLLECTIVE_TRUST_JKS
Key for the collectiveTrust.jks entry in the map returned by join and replicate.
|
static java.lang.String |
KEYSTORE_COLLECTIVE_TRUST_PFX
Key for the collectiveTrust.pfx entry in the map returned by join and replicate.
|
static java.lang.String |
KEYSTORE_KEY_JKS
Key for the key.jks entry in the map returned by join and replicate.
|
static java.lang.String |
KEYSTORE_KEY_PFX
Key for the key.pfx entry in the map returned by join and replicate.
|
static java.lang.String |
KEYSTORE_ROOT_KEYS_JKS
Key for the rootKeys.jks entry in the map returned by replicate.
|
static java.lang.String |
KEYSTORE_SERVER_IDENTITY_JKS
Key for the serverIdentity.jks entry in the map returned by join and replicate.
|
static java.lang.String |
KEYSTORE_SERVER_IDENTITY_PFX
Key for the serverIdentity.pfx entry in the map returned by join and replicate.
|
static java.lang.String |
KEYSTORE_TRUST_JKS
Key for the trust.jks entry in the map returned by join and replicate.
|
static java.lang.String |
KEYSTORE_TRUST_PFX
Key for the trust.pfx entry in the map returned by join and replicate.
|
static java.lang.String |
OBJECT_NAME
A String representing the
ObjectName that this MBean maps to. |
static java.lang.String |
RPC_HOST
Host name host authentication information map.
|
static java.lang.String |
RPC_PORT
Port for host authentication information map.
|
static java.lang.String |
RPC_USER
User ID for host authentication information map.
|
static java.lang.String |
RPC_USER_PASSWORD
User password for host authentication information map.
|
static java.lang.String |
SERVER_IDENTITY_CERTIFICATE_VALIDITY
The validity in days of the serverIdentity certificate for the certificate properties.
|
static java.lang.String |
SERVER_IDENTITY_KEYSTORE_PASSWORD
The serverIdentity.jks keystore password for the certificate properties.
|
static java.lang.String |
SSH_PRIVATE_KEY
SSH private key for host authentication information map.
|
static java.lang.String |
SSH_PRIVATE_KEY_PASSWORD
SSH private key password for host authentication information map.
|
static java.lang.String |
SUDO_USER
sudo user for host authentication information map.
|
static java.lang.String |
SUDO_USER_PASSWORD
sudo user password for host authentication information map.
|
static java.lang.String |
USE_HOST_CREDENTIALS
Whether to inherit the host level credentials for member server RPC.
|
static java.lang.String |
USE_SUDO
Use sudo key for host authentication information map.
|
static java.lang.String |
X509_CERTIFICATE |
Modifier and Type | Method and Description |
---|---|
void |
avow(java.lang.String hostName,
java.lang.String wlpUserDir,
java.lang.String serverName)
Avow the server to the collective.
|
void |
disavow(java.lang.String hostName,
java.lang.String wlpUserDir,
java.lang.String serverName)
Disavow the server from the collective.
|
java.util.Map<java.lang.String,byte[]> |
genKey(java.lang.String keystorePassword,
java.util.Map<java.lang.String,java.lang.Object> certProperties,
java.lang.Boolean addMemberRootSigner)
Generate a collective controller client keystore.
|
java.util.Map<java.lang.String,byte[]> |
join(java.lang.String hostName,
java.lang.String wlpUserDir,
java.lang.String serverName,
java.lang.String wlpInstallDir,
java.lang.String keystorePassword,
java.util.Map<java.lang.String,java.lang.Object> certProperties,
java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo)
Join the specified server to the collective as a member.
|
java.util.List<java.lang.String> |
listHosts()
List all hosts configured in the collective repository .
|
java.util.List<java.lang.String> |
listInstallDirs(java.lang.String hostName,
java.lang.String type)
List all liberty installed directories under the specified host.
|
java.util.List<java.lang.String> |
listServers(java.lang.String hostName,
java.lang.String wlpUserDir)
List all liberty servers created under the specified host and user directory.
|
java.util.List<java.lang.String> |
listUserDirs(java.lang.String hostName)
List all user directories of server for the specified host.
|
void |
registerHost(java.lang.String hostName,
java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo)
Same as
registerHost(String, Map, Map) , except hostPaths is null. |
void |
registerHost(java.lang.String hostName,
java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo,
java.util.Map<java.lang.String,java.lang.Object> hostPaths)
Registers a host with the collective.
|
void |
registerInstallDir(java.lang.String hostName,
java.lang.String type,
java.lang.String wlpInstallDir)
Registers the liberty installed directory for the host to the collective repository.
|
void |
remove(java.lang.String hostName,
java.lang.String wlpUserDir,
java.lang.String serverName)
Removes the server from the collective.
|
java.util.Map<java.lang.String,byte[]> |
replicate(java.lang.String hostName,
java.lang.String wlpUserDir,
java.lang.String serverName,
java.lang.String wlpInstallDir,
java.lang.String keystorePassword,
java.util.Map<java.lang.String,java.lang.Object> certProperties,
java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo)
Replicates the collective controller configuration it order to allow
the specified server to act as a collective controller.
|
void |
unregisterHost(java.lang.String hostName)
Unregisters a host from the collective.
|
void |
unregisterInstallDir(java.lang.String hostName,
java.lang.String type,
java.lang.String wlpInstallDir)
Unregisters the liberty installed directory for the host from the collective repository.
|
void |
updateHost(java.lang.String hostName,
java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo)
Same as
registerHost(String, Map, Map) , except hostPaths is null. |
void |
updateHost(java.lang.String hostName,
java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo,
java.util.Map<java.lang.String,java.lang.Object> hostPaths)
Updates the authentication information for a known host with the collective.
|
static final java.lang.String OBJECT_NAME
ObjectName
that this MBean maps to.static final java.lang.String USE_HOST_CREDENTIALS
If this property is set to true, any RPC operations will use host level credentials.
This property is optional. If it is not specified, the default is false. If this option is set to true, all other RPC credentials specified in hostAuthInfo config element are ignored.
static final java.lang.String RPC_HOST
The host can take on the form of a fully qualified domain name, or an IP address. The host name must be unique within the network and must be the host name on which the remote connection protocol is listening (SSH, or OS specific RPC). The host name should match the defaultHostName or configured value for <hostAuthInfo> in the server.xml.
This property is optional. If it is not specified, the hostName specified will be used.
static final java.lang.String RPC_PORT
The port on which the remote connection protocol is listening (SSH, or other supported RPC mechanism). See product documentation for supported RPC mechanisms.
This property is optional. Type is Integer. If the property is not specified, the SSH port (22) is assumed.
static final java.lang.String RPC_USER
The operating system user ID to use to connect to the host.
This property is required.
static final java.lang.String RPC_USER_PASSWORD
The password for the operating system user.
Either "rpcUserPassword" or "sshPrivateKey" should be specified, but not both. If both are specified, an IllegalArgumentException will be thrown.
This property is optional.
static final java.lang.String COLLECTIVE_MEMBER_TYPE
The type of member that is joining the collective.
This property is optional.
static final java.lang.String SSH_PRIVATE_KEY
The SSH private key to use for authenticating the specified operating system user. The SSH private key value is expected to be in the PEM format; a path to a key file is not supported.
-----BEGIN RSA PRIVATE KEY-----
....
-----END RSA PRIVATE KEY-----
Any key algorithm supported by the target sshd server is valid.
Either "rpcUserPassword" or "sshPrivateKey" should be specified, but not both. If both are specified, an IllegalArgumentException will be thrown.
This property is optional.
static final java.lang.String SSH_PRIVATE_KEY_PASSWORD
The password for the SSH private key.
If this property is set but no "sshPrivateKey" has been set, an IllegalArgumentException will be thrown.
This property is optional.
static final java.lang.String USE_SUDO
If this property is set to true, then sudo will be used to invoke commands. The user to sudo as can be controlled by setting "sudoUser". If "sudoUser" is not set, then the user to sudo as will be the configured default sudo user for the target host.
If this property is not set, and either "sudoUser" or "sudoUserPassword" are set, then "useSudo" is assumed to be true.
If this property is set to false, and either "sudoUser" or "sudoUserPassword" are set, then an IllegalArgumentException will be thrown.
This property is optional. Type is Boolean. Defaults to false if no sudo options are set.
static final java.lang.String SUDO_USER
Causes sudo to run the as specified user.
This property must not be set when "useSudo" is set to false.
This property is optional.
static final java.lang.String SUDO_USER_PASSWORD
Set this property if the sudo user (explicit or implied) requires a password.
This property must not be set when "useSudo" is set to false.
This property is optional.
static final java.lang.String HOST_READ_LIST
Set this property if file access is needed outside of the server instance level. An example scenario is routing (host level context) a file transfer operation through the collective controller into a registered member.
This property is optional. Type is List<String>.
This property is only valid for registerHost
and updateHost
.
static final java.lang.String HOST_WRITE_LIST
Set this property if file access is needed outside of the server instance level. An example scenario is routing (host level context) a file transfer operation through the collective controller into a registered member.
This property is optional. Type is List<String>.
This property is only valid for registerHost
and updateHost
.
static final java.lang.String HOST_JAVA_HOME
Set this property if a different java instance is to be used by the collective controller when invoking archive expansion on the host during routing file transfer uploads.
This property is optional. If specified, must not be empty.
This property is only valid for registerHost
and updateHost
.
static final java.lang.String SERVER_IDENTITY_KEYSTORE_PASSWORD
This property is optional.
static final java.lang.String SERVER_IDENTITY_CERTIFICATE_VALIDITY
This property is optional. Type is Integer, unit is days. Defaults to 5 years or 1825 days.
static final java.lang.String COLLECTIVE_TRUST_KEYSTORE_PASSWORD
This property is optional.
static final java.lang.String HTTPS_KEYSTORE_PASSWORD
This property is optional.
static final java.lang.String HTTPS_CERTIFICATE_SUBJECT
This property is optional.
static final java.lang.String HTTPS_CERTIFICATE_VALIDITY
This property is optional. Type is Integer, unit is days. Defaults to 5 years or 1825 days.
static final java.lang.String HTTPS_TRUSTSTORE_PASSWORD
This property is optional.
static final java.lang.String KEYSTORE_SERVER_IDENTITY_JKS
This entry should be written to: ${server.config.dir}/resources/collective/serverIdentity.jks
static final java.lang.String KEYSTORE_SERVER_IDENTITY_PFX
This entry should be written to: ${server.config.dir}/resources/collective/serverIdentity.pfx
static final java.lang.String X509_CERTIFICATE
static final java.lang.String KEYSTORE_COLLECTIVE_TRUST_JKS
This entry should be written to: ${server.config.dir}/resources/collective/collectiveTrust.jks
static final java.lang.String KEYSTORE_COLLECTIVE_TRUST_PFX
This entry should be written to: ${server.config.dir}/resources/collective/collectiveTrust.pfx
static final java.lang.String KEYSTORE_KEY_JKS
This entry should be written to: ${server.config.dir}/resources/security/key.jks
static final java.lang.String KEYSTORE_KEY_PFX
This entry should be written to: ${server.config.dir}/resources/security/key.pfx
static final java.lang.String KEYSTORE_TRUST_JKS
This entry should be written to: ${server.config.dir}/resources/security/trust.jks
static final java.lang.String KEYSTORE_TRUST_PFX
This entry should be written to: ${server.config.dir}/resources/security/trust.pfx
static final java.lang.String KEYSTORE_ROOT_KEYS_JKS
This entry should be written to: ${server.config.dir}/resources/collective/rootKeys.jks
static final java.lang.String FILE_COLLECTIVE_UUID
This entry should be written to: ${server.config.dir}/resources/collective/collective.uuid
static final java.lang.String FILE_COLLECTIVE_NAME
This entry should be written to: ${server.config.dir}/resources/collective/collective.name
static final java.lang.String CERTIFICATE_SUBJECT
This property is optional.
static final java.lang.String CERTIFICATE_VALIDITY
This property is optional. Type is Integer, unit is days. Defaults to 5 years or 1825 days.
void registerHost(java.lang.String hostName, java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo, java.util.Map<java.lang.String,java.lang.Object> hostPaths) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
The host authentication information requires either the user password or the SSH private key.
hostName
- The case insensitive host name. Must not be null
or an empty string.hostAuthInfo
- See the Host Authentication Information
CollectiveRegistrationMBean
.
Must not be null
.hostPaths
- See the Host Paths
CollectiveRegistrationMBean
.
May be null
.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not valid or
if any of the keys in the properties map are unrecognizedjava.lang.IllegalStateException
- If the host was already registeredvoid registerHost(java.lang.String hostName, java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
registerHost(String, Map, Map)
, except hostPaths is null. Some host paths are
may be specified in hostAuthInfo.java.io.IOException
java.lang.IllegalArgumentException
java.lang.IllegalStateException
void updateHost(java.lang.String hostName, java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo, java.util.Map<java.lang.String,java.lang.Object> hostPaths) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
The host authentication information requires either the user password or the SSH private key.
hostName
- The case insensitive host name. Must not be null
or an empty string.hostAuthInfo
- See the Host Authentication Information
CollectiveRegistrationMBean
.
May be null
if there is no authentication information to change.hostPaths
- See the Host Paths
CollectiveRegistrationMBean
.
May be null
if there is no path information to change.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not valid or
if any of the keys in the properties map are unrecognizedjava.lang.IllegalStateException
- If the host was not registeredvoid updateHost(java.lang.String hostName, java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
registerHost(String, Map, Map)
, except hostPaths is null. Some host paths are
may be specified in hostAuthInfo.java.io.IOException
java.lang.IllegalArgumentException
java.lang.IllegalStateException
void unregisterHost(java.lang.String hostName) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
hostName
- The case insensitive host name. Must not be null
or an empty string.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not validjava.lang.IllegalStateException
- If the host was not registeredjava.util.Map<java.lang.String,byte[]> join(java.lang.String hostName, java.lang.String wlpUserDir, java.lang.String serverName, java.lang.String wlpInstallDir, java.lang.String keystorePassword, java.util.Map<java.lang.String,java.lang.Object> certProperties, java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.security.cert.CertificateException, java.security.KeyStoreException
This will register the server and generate the security credentials required by the server to communicate with the collective.
A server is uniquely identified by its name, the host on which it resides, and the wlpUserDir within which it resides. The wlpUserDir is used in the repository path to differentiate between servers of the same name on the same host.
The host authentication information requires either the user password or the SSH private key.
hostName
- The host name. Must not be null
or an empty string. The
host name set here will directly control where the server's
information is stored within the repository. This host name should
match the host name set to the defaultHostName variable for the
server's server.xml
Must not be null
or an empty string.wlpUserDir
- The canonical path for the user directory of server.
This should match the WLP_USER_DIR environment variable for the server.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.serverName
- The server name. Must not be null
or an empty string.wlpInstallDir
- The Liberty install directory for this server.
Must not be null
or an empty string.keystorePassword
- The password to protect the created keystores.
Must not be null
. Each keystore's password can be
overridden individually by specifying additional certProperties.certProperties
- See the Certificate Creation Properties
CollectiveRegistrationMBean
hostAuthInfo
- See the Host Authentication Information
CollectiveRegistrationMBean
java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not valid or if any of the keys in the properties maps are unrecognizedjava.lang.IllegalStateException
- If the server was already registeredjava.security.cert.CertificateException
- If there is a problem creating the certificatesjava.security.KeyStoreException
- If there is a problem creating the keystorejava.util.Map<java.lang.String,byte[]> genKey(java.lang.String keystorePassword, java.util.Map<java.lang.String,java.lang.Object> certProperties, java.lang.Boolean addMemberRootSigner) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.security.cert.CertificateException, java.security.KeyStoreException
This will register the server and generate the security credentials required by the server to communicate with the collective.
A server is uniquely identified by its name, the host on which it resides, and the wlpUserDir within which it resides. The wlpUserDir is used in the repository path to differentiate between servers of the same name on the same host.
The host authentication information requires either the user password or the SSH private key.
keystorePassword
- The password to protect the created keystores.
Must not be null
. Each keystore's password can be
overridden individually by specifying additional certProperties.certProperties
- See the Certificate Creation Properties
CollectiveRegistrationMBean
addMemberRootSigner
- if true, add member root signer to the generated keystorejava.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not valid or if any of the keys in the properties maps are unrecognizedjava.lang.IllegalStateException
- If the server was already registeredjava.security.cert.CertificateException
- If there is a problem creating the certificatesjava.security.KeyStoreException
- If there is a problem creating the keystorejava.util.Map<java.lang.String,byte[]> replicate(java.lang.String hostName, java.lang.String wlpUserDir, java.lang.String serverName, java.lang.String wlpInstallDir, java.lang.String keystorePassword, java.util.Map<java.lang.String,java.lang.Object> certProperties, java.util.Map<java.lang.String,java.lang.Object> hostAuthInfo) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.security.cert.CertificateException, java.security.KeyStoreException
This will register the server and generate the security credentials required by the server to communicate with the collective.
A server is uniquely identified by its name, the host on which it resides, and the wlpUserDir within which it resides. The wlpUserDir is used in the repository path to differentiate between servers of the same name on the same host.
The host authentication information requires either the user password or the SSH private key.
hostName
- The host name. Must not be null
or an empty string. The
host name set here will directly control where the server's
information is stored within the repository. This host name should
match the host name set to the defaultHostName variable for the
server's server.xmlwlpUserDir
- The canonical path for the user directory of server.
This should match the WLP_USER_DIR environment variable for the server.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.serverName
- The server name. Must not be null
or an empty string.wlpInstallDir
- The Liberty install directory for this server.
Must not be null
or an empty string.keystorePassword
- The password to protect the created keystores.
Must not be null
. Each keystore's password can be
overridden individually by specifying additional certProperties.certProperties
- See the Certificate Creation Properties
CollectiveRegistrationMBean
hostAuthInfo
- See the Host Authentication Information
CollectiveRegistrationMBean
java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not valid or if any of the keys in the properties maps are unrecognizedjava.lang.IllegalStateException
- If the server was already registeredjava.security.cert.CertificateException
- If there is a problem creating the certificatesjava.security.KeyStoreException
- If there is a problem creating the keystorevoid remove(java.lang.String hostName, java.lang.String wlpUserDir, java.lang.String serverName) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
A server is uniquely identified by its name, the host on which it resides, and the wlpUserDir within which it resides. The wlpUserDir is used in the repository path to differentiate between servers of the same name on the same host.
hostName
- The host name. Must not be null
or an empty string.
This host name should match the host name set to the defaultHostName
variable for the server's server.xmlwlpUserDir
- The canonical path for the user directory of server.
This should match the WLP_USER_DIR environment variable for the server.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.serverName
- The server name. Must not be null
or an empty string.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not validjava.lang.IllegalStateException
- If the server was not registeredvoid avow(java.lang.String hostName, java.lang.String wlpUserDir, java.lang.String serverName) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
A server is uniquely identified by its name, the host on which it resides, and the wlpUserDir within which it resides. The wlpUserDir is used in the repository path to differentiate between servers of the same name on the same host.
hostName
- The host name. Must not be null
or an empty string.
This host name should match the host name set to the defaultHostName
variable for the server's server.xmlwlpUserDir
- The canonical path for the user directory of server.
This should match the WLP_USER_DIR environment variable for the server.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.serverName
- The server name. Must not be null
or an empty string.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not validjava.lang.IllegalStateException
- If the server was not registeredvoid disavow(java.lang.String hostName, java.lang.String wlpUserDir, java.lang.String serverName) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
A server is uniquely identified by its name, the host on which it resides, and the wlpUserDir within which it resides. The wlpUserDir is used in the repository path to differentiate between servers of the same name on the same host.
hostName
- The host name. Must not be null
or an empty string.
This host name should match the host name set to the defaultHostName
variable for the server's server.xmlwlpUserDir
- The canonical path for the user directory of server.
This should match the WLP_USER_DIR environment variable for the server.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.serverName
- The server name. Must not be null
or an empty string.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not validjava.lang.IllegalStateException
- If the server was not registeredvoid registerInstallDir(java.lang.String hostName, java.lang.String type, java.lang.String wlpInstallDir) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
hostName
- The case insensitive host name. Must not be null
or an empty string.type
- The installable type, valid types are wlp, jre and other. Default is other.wlpInstallDir
- The canonical path for the install directory.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.java.io.IOException
- If there was any problem completing the operation.java.lang.IllegalArgumentException
- If any of the parameters are not valid.java.lang.IllegalStateException
- If the host was unregistered or
the install directory was registered already.void unregisterInstallDir(java.lang.String hostName, java.lang.String type, java.lang.String wlpInstallDir) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
hostName
- The case insensitive host name. Must not be null
or an empty string.type
- The installable type, valid types including wlp, jre and other. Default is other.wlpInstallDir
- The canonical path for the install directory.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.java.io.IOException
- If there was any problem completing the operation.java.lang.IllegalArgumentException
- If any of the parameters are not valid.java.lang.IllegalStateException
- If the host or install directory was unregistered.java.util.List<java.lang.String> listInstallDirs(java.lang.String hostName, java.lang.String type) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
hostName
- The case insensitive host name. Must not be null
or an empty string.type
- The installable type, valid types including wlp, jre and other. Default is other.java.io.IOException
- If there was any problem completing the operation.java.lang.IllegalArgumentException
- If the parameter is not valid.java.lang.IllegalStateException
- If the host was unregistered.java.util.List<java.lang.String> listHosts() throws java.io.IOException, java.lang.IllegalStateException
java.io.IOException
- If there was any problem completing the operation.java.lang.IllegalStateException
java.util.List<java.lang.String> listUserDirs(java.lang.String hostName) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
hostName
- The case insensitive host name. Must not be null
or an empty string.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not validjava.lang.IllegalStateException
- If the host was unregistered.java.util.List<java.lang.String> listServers(java.lang.String hostName, java.lang.String wlpUserDir) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
hostName
- The case insensitive host name. Must not be null
or an empty string.wlpUserDir
- The canonical path for the user directory of server.
Must not be null
or an empty string. Must not have a trailing slash.
Must not be encoded.java.io.IOException
- If there was any problem completing the operationjava.lang.IllegalArgumentException
- If any of the parameters are not valid.java.lang.IllegalStateException
- If the host was unregistered