public interface OpenidmAccountStatusNotificationHandlerCfg
extends org.forgerock.opendj.server.config.server.AccountStatusNotificationHandlerCfg
The Openidm Account Status Notification Handler is an account status notification handler that listens to two kind of changes: password change and password reset. The changes are either immediately sent to OpenIDM or first stored locally and sent later to OpenIDM at the provided interval. The communication with OpenIDM is done through HTTP or HTTPS, with optional SSL client authentication.
| Modifier and Type | Method and Description |
|---|---|
void |
addOpenidmChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<OpenidmAccountStatusNotificationHandlerCfg> listener)
Register to be notified when this Openidm Account Status Notification Handler is changed.
|
Class<? extends OpenidmAccountStatusNotificationHandlerCfg> |
configurationClass()
Gets the configuration class associated with this Openidm Account Status Notification Handler.
|
SortedSet<org.forgerock.opendj.ldap.schema.AttributeType> |
getAttributeType()
Gets the "attribute-type" property.
|
org.forgerock.opendj.ldap.DN |
getCertificateSubjectDN()
Gets the "certificate-subject-dn" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getKeyManagerProvider()
Gets the "key-manager-provider" property.
|
org.forgerock.opendj.ldap.DN |
getKeyManagerProviderDN()
Gets the "key-manager-provider" property as a DN.
|
String |
getLogFile()
Gets the "log-file" property.
|
OpenidmAccountStatusNotificationHandlerCfgDefn.OpenidmCompatMode |
getOpenidmCompatMode()
Gets the "openidm-compat-mode" property.
|
String |
getOpenidmPassword()
Gets the "openidm-password" property.
|
String |
getOpenidmUrl()
Gets the "openidm-url" property.
|
String |
getOpenidmUsername()
Gets the "openidm-username" property.
|
String |
getPasswordAttribute()
Gets the "password-attribute" property.
|
String |
getPrivateKeyAlias()
Gets the "private-key-alias" property.
|
String |
getQueryId()
Gets the "query-id" property.
|
String |
getSSLCertNickname()
Gets the "ssl-cert-nickname" property.
|
String |
getTrustManagerProvider()
Gets the "trust-manager-provider" property.
|
org.forgerock.opendj.ldap.DN |
getTrustManagerProviderDN()
Gets the "trust-manager-provider" property as a DN.
|
long |
getUpdateInterval()
Gets the "update-interval" property.
|
void |
removeOpenidmChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<OpenidmAccountStatusNotificationHandlerCfg> listener)
Deregister an existing Openidm Account Status Notification Handler configuration change listener.
|
Class<? extends OpenidmAccountStatusNotificationHandlerCfg> configurationClass()
configurationClass in interface org.forgerock.opendj.server.config.server.AccountStatusNotificationHandlerCfgconfigurationClass in interface org.forgerock.opendj.config.Configurationvoid addOpenidmChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<OpenidmAccountStatusNotificationHandlerCfg> listener)
listener - The Openidm Account Status Notification Handler configuration change listener.void removeOpenidmChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<OpenidmAccountStatusNotificationHandlerCfg> listener)
listener - The Openidm Account Status Notification Handler configuration change listener.SortedSet<org.forgerock.opendj.ldap.schema.AttributeType> getAttributeType()
Specifies the attribute types that this plug-in will send along with the password change.
Zero or more attribute types can be specified.
org.forgerock.opendj.ldap.DN getCertificateSubjectDN()
Specifies the subject DN of the certificate used by OpenIDM.
The subject DN is used to retrieve the OpenIDM certificate in the truststore. This certificate's public key is necessary to encrypt the JSON content sent to OpenIDM.
String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Openidm Account Status Notification Handler implementation.
getJavaClass in interface org.forgerock.opendj.server.config.server.AccountStatusNotificationHandlerCfgString getKeyManagerProvider()
Specifies the name of the key manager that should be used with this Openidm Account Status Notification Handler.
It must be provided when ssl-cert-nickname is provided, and must contain a certificate corresponding to the nickname.
org.forgerock.opendj.ldap.DN getKeyManagerProviderDN()
Specifies the name of the key manager that should be used with this Openidm Account Status Notification Handler.
It must be provided when ssl-cert-nickname is provided, and must contain a certificate corresponding to the nickname.
String getLogFile()
Specifies the log file location where the changed passwords are written when the plug-in cannot contact OpenIDM.
The default location is the logs directory of the server instance, using the file name "pwsync". Passwords in this file will be encrypted.
OpenidmAccountStatusNotificationHandlerCfgDefn.OpenidmCompatMode getOpenidmCompatMode()
Specifies OpenIDM Compatibility Mode.
String getOpenidmPassword()
Specifies the password to use for HTTP Basic Authentication.
The password must be provided when client certification is not activated, i.e. when no ssl-cert-nickname is provided.
String getOpenidmUrl()
Specifies the URL to OpenIDM endpoint.
The URL can be either HTTP or HTTPS.
String getOpenidmUsername()
Specifies the username to use for HTTP Basic Authentication.
The username must be provided when client certification is not activated, i.e. when no ssl-cert-nickname is provided.
String getPasswordAttribute()
Specifies the attribute type used to hold user passwords in JSON returned to OpenIDM.
This attribute type must be defined in the managed object schema in OpenIDM, and it must have either the user password or auth password syntax.
String getPrivateKeyAlias()
Specifies the alias of the private key that should be used by OpenIDM to decrypt the encrypted JSON content of the requests.
The encryption of the JSON content sent to OpenIDM requires this alias.
String getQueryId()
Specifies the query-id for the patch-by-query request.
This must match the query ID defined in the managed object service in OpenIDM.
String getSSLCertNickname()
Specifies the SSL certificate nickname, which is the alias under which is stored the client certificate in the keystore. It must be provided to activate SSL client authentication when requesting OpenIDM.
The SSL certificate nickname is necessary to ensure that the appropriate client certificate is retrieved from the keystore when SSL client authentication is required and multiples certificates are present in the keystore.
String getTrustManagerProvider()
Specifies the name of the trust manager that should be used with the Openidm Account Status Notification Handler.
It must contain the OpenIDM certificate with the subject DN equals to the certificate-subject-dn property.
org.forgerock.opendj.ldap.DN getTrustManagerProviderDN()
Specifies the name of the trust manager that should be used with the Openidm Account Status Notification Handler.
It must contain the OpenIDM certificate with the subject DN equals to the certificate-subject-dn property.
long getUpdateInterval()
Specifies the interval when passwords update notifications are sent.
If this value is 0, then updates are sent synchronously. If this value is strictly superior to zero, then updates are first stored locally, then sent asynchronously by a background thread.
Copyright © 2017-2020 Wren Security. All Rights Reserved.