|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.ds.api.OneTimePasswordDeliveryMechanism
@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=true) @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class OneTimePasswordDeliveryMechanism
This class defines an API that must be implemented by extensions which
attempt to deliver one-time passwords (OTPs) to end users through some
out-of-band mechanism. The one-time passwords will have been generated by
the deliver one-time password extended request, and may be used to
authenticate to the server through the UNBOUNDID-DELIVERED-OTP SASL
mechanism.
dsconfig create-otp-delivery-mechanism \ --mechanism-name "{mechanism-name}" \ --type third-party \ --set enabled:true \ --set "extension-class:{class-name}" \ --set "extension-argument:{name=value}"where "{mechanism-name}" is the name to use for the one-time password instance, "{class-name}" is the fully-qualified name of the Java class that extends
com.unboundid.directory.sdk.ds.api.OneTimePasswordDeliveryMechanism
,
and "{name=value}" represents name-value pairs for any arguments to
provide to the one-time password delivery mechanism. If multiple arguments
should be provided to the OTP delivery mechanism, then the
"--set extension-argument:{name=value}
" option should be
provided multiple times.
Constructor Summary | |
---|---|
OneTimePasswordDeliveryMechanism()
Creates a new instance of this one-time password delivery mechanism. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(OneTimePasswordDeliveryMechanismConfig config,
com.unboundid.util.args.ArgumentParser parser,
java.util.List<java.lang.String> adminActionsRequired,
java.util.List<java.lang.String> messages)
Attempts to apply the configuration from the provided argument parser to this extension. |
void |
defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
Updates the provided argument parser to define any configuration arguments which may be used by this extension. |
abstract java.lang.String |
deliverOneTimePassword(java.lang.String oneTimePassword,
Entry userEntry,
java.lang.String targetRecipientID,
java.lang.StringBuilder message)
Attempts to deliver the provided one-time password to the specified user. |
void |
finalizeOTPDeliveryMechanism()
Performs any cleanup which may be necessary when this one-time password delivery mechanism is to be taken out of service. |
java.util.Map<java.util.List<java.lang.String>,java.lang.String> |
getExamplesArgumentSets()
Retrieves a map containing examples of configurations that may be used for this extension. |
abstract java.lang.String[] |
getExtensionDescription()
Retrieves a human-readable description for this extension. |
abstract java.lang.String |
getExtensionName()
Retrieves a human-readable name for this extension. |
void |
initializeOTPDeliveryMechanism(DirectoryServerContext serverContext,
OneTimePasswordDeliveryMechanismConfig config,
com.unboundid.util.args.ArgumentParser parser)
Initializes this one-time password delivery mechanism. |
boolean |
isConfigurationAcceptable(OneTimePasswordDeliveryMechanismConfig config,
com.unboundid.util.args.ArgumentParser parser,
java.util.List<java.lang.String> unacceptableReasons)
Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OneTimePasswordDeliveryMechanism()
initializeOTPDeliveryMechanism
method.
Method Detail |
---|
public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeOTPDeliveryMechanism(DirectoryServerContext serverContext, OneTimePasswordDeliveryMechanismConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.ldap.sdk.LDAPException
serverContext
- A handle to the server context for the server in
which this extension is running.config
- The general configuration for this OTP delivery
mechanism.parser
- The argument parser which has been initialized from
the configuration for this OTP delivery mechanism.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this OTP
delivery mechanism.public boolean isConfigurationAcceptable(OneTimePasswordDeliveryMechanismConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<OneTimePasswordDeliveryMechanismConfig>
config
- The general configuration for this extension.parser
- The argument parser that has been used to
parse the proposed configuration for this
extension.unacceptableReasons
- A list to which messages may be added to
provide additional information about why the
provided configuration is not acceptable.
true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public com.unboundid.ldap.sdk.ResultCode applyConfiguration(OneTimePasswordDeliveryMechanismConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<OneTimePasswordDeliveryMechanismConfig>
config
- The general configuration for this extension.parser
- The argument parser that has been used to
parse the new configuration for this
extension.adminActionsRequired
- A list to which messages may be added to
provide additional information about any
additional administrative actions that may
be required to apply some of the
configuration changes.messages
- A list to which messages may be added to
provide additional information about the
processing performed by this method.
SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizeOTPDeliveryMechanism()
public abstract java.lang.String deliverOneTimePassword(java.lang.String oneTimePassword, Entry userEntry, java.lang.String targetRecipientID, java.lang.StringBuilder message) throws com.unboundid.ldap.sdk.LDAPException
oneTimePassword
- The one-time password to be delivered.userEntry
- The entry for the user to whom the one-time
password should be delivered.targetRecipientID
- The target recipient ID that should be used for
the delivery, if possible. It may be
null
if there is no appropriate
identifier for this delivery mechanism or if
the delivery mechanism may choose which
recipient ID should be used. However, if it is
non-null
, then the delivery mechanism
must verify that the provided recipient ID is
valid for the associated user (e.g., for an
e-mail delivery mechanism, the recipient ID
would probably be an e-mail address, and the
delivery mechanism must verify that the provided
e-mail address is associated with the given
user account).message
- A buffer to which a message may be appended with
additional information about the password
delivery.
null
if there is no
appropriate identifier for this delivery mechanism that is needed
beyond the name of the delivery mechanism and the DN of the
recipient.
com.unboundid.ldap.sdk.LDAPException
- If a problem is encountered while attempting to
send the one-time password to the user.public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |