|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.ds.api.CipherStreamProvider
@Extensible @DirectoryServerExtension @IdentityBrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class CipherStreamProvider
This class defines an API that must be implemented by extensions which
provide access to cipher input streams and cipher output streams to be used
by the server in order to read and write encrypted data.
dsconfig create-cipher-stream-provider \ --provider-name "{provider-name}" \ --type third-party \ --set enabled:true \ --set "extension-class:{class-name}" \ --set "extension-argument:{name=value}"where "{provider-name}" is the name to use for the cipher stream provider instance, "{class-name}" is the fully-qualified name of the Java class that extends
com.unboundid.directory.sdk.ds.api.CipherStreamProvider
,
and "{name=value}" represents name-value pairs for any arguments to
provide to the cipher stream provider. If multiple arguments should be
provided to the cipher stream provider, then the
"--set extension-argument:{name=value}
" option should be
provided multiple times.
Constructor Summary | |
---|---|
CipherStreamProvider()
Creates a new instance of this cipher stream provider. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(CipherStreamProviderConfig 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. |
abstract javax.crypto.CipherInputStream |
createCipherInputStream(java.io.InputStream source)
Wraps the provided input stream in a cipher input stream that can be used to decrypt data read from the given stream. |
abstract javax.crypto.CipherOutputStream |
createCipherOutputStream(java.io.OutputStream target)
Wraps the provided output stream in a cipher output stream that can be used to encrypt data written to the given stream. |
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. |
void |
finalizeCipherStreamProvider()
Performs any cleanup which may be necessary when this cipher stream provider 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 |
initializeCipherStreamProvider(DirectoryServerContext serverContext,
CipherStreamProviderConfig config,
com.unboundid.util.args.ArgumentParser parser)
Initializes this cipher stream provider. |
boolean |
isConfigurationAcceptable(CipherStreamProviderConfig 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 CipherStreamProvider()
initializeCipherStreamProvider
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 initializeCipherStreamProvider(DirectoryServerContext serverContext, CipherStreamProviderConfig 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 cipher stream
provider.parser
- The argument parser which has been initialized from
the configuration for this cipher stream provider.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this cipher
stream provider.public boolean isConfigurationAcceptable(CipherStreamProviderConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<CipherStreamProviderConfig>
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(CipherStreamProviderConfig 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<CipherStreamProviderConfig>
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 finalizeCipherStreamProvider()
public abstract javax.crypto.CipherInputStream createCipherInputStream(java.io.InputStream source) throws com.unboundid.ldap.sdk.LDAPException
source
- The input stream to be wrapped with a cipher input stream.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while creating the cipher input
stream.public abstract javax.crypto.CipherOutputStream createCipherOutputStream(java.io.OutputStream target) throws com.unboundid.ldap.sdk.LDAPException
target
- The output stream to be wrapped with a cipher output
stream.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while creating the cipher
output stream.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 |