|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.Backend
org.opends.server.backends.TrustStoreBackend
public class TrustStoreBackend
This class defines a backend used to provide an LDAP view of public keys stored in a key store.
Constructor Summary | |
---|---|
TrustStoreBackend()
Creates a new backend. |
Method Summary | |
---|---|
void |
addEntry(Entry entry,
AddOperation addOperation)
Adds the provided entry to this backend. |
ConfigChangeResult |
applyConfigurationChange(TrustStoreBackendCfg cfg)
Applies the configuration changes to this change listener. |
void |
configureBackend(Configuration config)
Configure this backend based on the information in the provided configuration. |
void |
createBackup(BackupConfig backupConfig)
Creates a backup of the contents of this backend in a form that may be restored at a later date if necessary. |
static void |
createPINFile(java.lang.String path,
java.lang.String pin)
Creates a PIN file on the specified path. |
void |
deleteEntry(DN entryDN,
DeleteOperation deleteOperation)
Removes the specified entry from this backend. |
void |
exportLDIF(LDIFExportConfig exportConfig)
Exports the contents of this backend to LDIF. |
void |
finalizeBackend()
Performs any necessary work to finalize this backend, including closing any underlying databases or connections and deregistering any suffixes that it manages with the Directory Server. |
DN[] |
getBaseDNs()
Retrieves the set of base-level DNs that may be used within this backend. |
Entry |
getEntry(DN entryDN)
Retrieves the requested entry from this backend. |
long |
getEntryCount()
Retrieves the total number of entries contained in this backend, if that information is available. |
java.security.Key |
getKey(java.lang.String alias)
Returns the key associated with the given alias, using the trust store pin to recover it. |
javax.net.ssl.KeyManager[] |
getKeyManagers()
Retrieves a set of KeyManager objects that may be used for
interactions requiring access to a key manager. |
java.util.HashSet<java.lang.String> |
getSupportedControls()
Retrieves the OIDs of the controls that may be supported by this backend. |
java.util.HashSet<java.lang.String> |
getSupportedFeatures()
Retrieves the OIDs of the features that may be supported by this backend. |
javax.net.ssl.TrustManager[] |
getTrustManagers()
Retrieves a set of TrustManager objects that may be used
for interactions requiring access to a trust manager. |
ConditionResult |
hasSubordinates(DN entryDN)
Indicates whether the requested entry has any subordinates. |
LDIFImportResult |
importLDIF(LDIFImportConfig importConfig)
Imports information from an LDIF file into this backend. |
void |
initializeBackend()
Initializes this backend based on the information provided when the backend was configured. |
boolean |
isConfigurationChangeAcceptable(TrustStoreBackendCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
boolean |
isIndexed(AttributeType attributeType,
IndexType indexType)
Indicates whether search operations which target the specified attribute in the indicated manner would be considered indexed in this backend. |
boolean |
isLocal()
Indicates whether the data associated with this backend may be considered local (i.e., in a repository managed by the Directory Server) rather than remote (i.e., in an external repository accessed by the Directory Server but managed through some other means). |
static DN |
makeChildDN(DN parentDN,
AttributeType rdnAttrType,
java.lang.String rdnStringValue)
Create a new child DN from a given parent DN. |
long |
numSubordinates(DN entryDN,
boolean subtree)
Retrieves the number of subordinates for the requested entry. |
void |
preloadEntryCache()
Attempts to pre-load all the entries stored within this backend into the entry cache. |
void |
removeBackup(BackupDirectory backupDirectory,
java.lang.String backupID)
Removes the specified backup if it is possible to do so. |
void |
renameEntry(DN currentDN,
Entry entry,
ModifyDNOperation modifyDNOperation)
Moves and/or renames the provided entry in this backend, altering any subordinate entries as necessary. |
void |
replaceEntry(Entry entry,
ModifyOperation modifyOperation)
Replaces the specified entry with the provided entry in this backend. |
void |
restoreBackup(RestoreConfig restoreConfig)
Restores a backup of the contents of this backend. |
void |
search(SearchOperation searchOperation)
Processes the specified search in this backend. |
boolean |
supportsBackup()
Indicates whether this backend provides a backup mechanism of any kind. |
boolean |
supportsBackup(BackupConfig backupConfig,
java.lang.StringBuilder unsupportedReason)
Indicates whether this backend provides a mechanism to perform a backup of its contents in a form that can be restored later, based on the provided configuration. |
boolean |
supportsLDIFExport()
Indicates whether this backend provides a mechanism to export the data it contains to an LDIF file. |
boolean |
supportsLDIFImport()
Indicates whether this backend provides a mechanism to import its data from an LDIF file. |
boolean |
supportsRestore()
Indicates whether this backend provides a mechanism to restore a backup. |
Methods inherited from class org.opends.server.api.Backend |
---|
addSubordinateBackend, entryExists, getBackendID, getBackendMonitor, getParentBackend, getSubordinateBackends, getWritabilityMode, handlesEntry, handlesEntry, hasSubSuffix, isConfigurationAcceptable, isIndexed, isIndexed, isPrivateBackend, removeSubordinateBackend, removeSubSuffix, setBackendID, setBackendMonitor, setParentBackend, setPrivateBackend, setSubordinateBackends, setWritabilityMode, supportsControl, supportsFeature |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TrustStoreBackend()
super()
to invoke this constructor.
Method Detail |
---|
public void configureBackend(Configuration config) throws ConfigException
configureBackend
in class Backend
config
- The configuration of this backend.
ConfigException
- If there is an error in the configuration.public void initializeBackend() throws ConfigException, InitializationException
initializeBackend
in class Backend
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem occurs during
initialization that is not
related to the server
configuration.Backend.configureBackend(org.opends.server.admin.Configuration)
public void finalizeBackend()
finalizeBackend
in class Backend
public DN[] getBaseDNs()
getBaseDNs
in class Backend
public long getEntryCount()
getEntryCount
in class Backend
public boolean isLocal()
isLocal
in class Backend
true
if the data associated with this backend
may be considered local, or false
if it is
remote.public boolean isIndexed(AttributeType attributeType, IndexType indexType)
true
for the specified
attribute and index type.
isIndexed
in class Backend
attributeType
- The attribute type for which to make the
determination.indexType
- The index type for which to make the
determination.
true
if search operations targeting the
specified attribute in the indicated manner should be
considered indexed, or false
if not.public Entry getEntry(DN entryDN) throws DirectoryException
getEntry
in class Backend
entryDN
- The distinguished name of the entry to retrieve.
null
if the entry does
not exist.
DirectoryException
- If a problem occurs while trying to
retrieve the entry.public void addEntry(Entry entry, AddOperation addOperation) throws DirectoryException
addEntry
in class Backend
entry
- The entry to add to this backend.addOperation
- The add operation with which the new entry
is associated. This may be null
for adds performed internally.
DirectoryException
- If a problem occurs while trying to
add the entry.public void deleteEntry(DN entryDN, DeleteOperation deleteOperation) throws DirectoryException
deleteEntry
in class Backend
entryDN
- The DN of the entry to remove from this
backend.deleteOperation
- The delete operation with which this
action is associated. This may be
null
for deletes performed
internally.
DirectoryException
- If a problem occurs while trying to
remove the entry.public void replaceEntry(Entry entry, ModifyOperation modifyOperation) throws DirectoryException
replaceEntry
in class Backend
entry
- The new entry to use in place of the
existing entry with the same DN.modifyOperation
- The modify operation with which this
action is associated. This may be
null
for modifications performed
internally.
DirectoryException
- If a problem occurs while trying to
replace the entry.public void renameEntry(DN currentDN, Entry entry, ModifyDNOperation modifyDNOperation) throws DirectoryException
renameEntry
in class Backend
currentDN
- The current DN of the entry to be
replaced.entry
- The new content to use for the entry.modifyDNOperation
- The modify DN operation with which
this action is associated. This may
be null
for modify DN
operations performed internally.
DirectoryException
- If a problem occurs while trying to
perform the rename.public void search(SearchOperation searchOperation) throws DirectoryException
SearchOperation.returnEntry
method. The caller is not
required to have any locks when calling this operation.
search
in class Backend
searchOperation
- The search operation to be processed.
DirectoryException
- If a problem occurs while processing
the search.public java.util.HashSet<java.lang.String> getSupportedControls()
getSupportedControls
in class Backend
public java.util.HashSet<java.lang.String> getSupportedFeatures()
getSupportedFeatures
in class Backend
public boolean supportsLDIFExport()
supportsLDIFExport
in class Backend
true
if this backend provides an LDIF export
mechanism, or false
if not.public void exportLDIF(LDIFExportConfig exportConfig) throws DirectoryException
supportsLDIFExport
returns
true
. Note that the server will not explicitly
initialize this backend before calling this method.
exportLDIF
in class Backend
exportConfig
- The configuration to use when performing
the export.
DirectoryException
- If a problem occurs while performing
the LDIF export.public boolean supportsLDIFImport()
supportsLDIFImport
in class Backend
true
if this backend provides an LDIF import
mechanism, or false
if not.public LDIFImportResult importLDIF(LDIFImportConfig importConfig) throws DirectoryException
supportsLDIFImport
returns true
. Note that the server will not explicitly
initialize this backend before calling this method.
importLDIF
in class Backend
importConfig
- The configuration to use when performing
the import.
DirectoryException
- If a problem occurs while performing
the LDIF import.public boolean supportsBackup()
true
for backends that
it is not possible to archive directly (e.g., those that don't
store their data locally, but rather pass through requests to
some other repository).
supportsBackup
in class Backend
true
if this backend provides any kind of backup
mechanism, or false
if it does not.public boolean supportsBackup(BackupConfig backupConfig, java.lang.StringBuilder unsupportedReason)
supportsBackup
in class Backend
backupConfig
- The configuration of the backup for
which to make the determination.unsupportedReason
- A buffer to which a message can be
appended
explaining why the requested backup is
not supported.
true
if this backend provides a mechanism for
performing backups with the provided configuration, or
false
if not.public void createBackup(BackupConfig backupConfig) throws DirectoryException
supportsBackup
returns true
.
Note that the server will not explicitly initialize this backend
before calling this method.
createBackup
in class Backend
backupConfig
- The configuration to use when performing
the backup.
DirectoryException
- If a problem occurs while performing
the backup.public void removeBackup(BackupDirectory backupDirectory, java.lang.String backupID) throws DirectoryException
removeBackup
in class Backend
backupDirectory
- The backup directory structure with
which the specified backup is
associated.backupID
- The backup ID for the backup to be
removed.
DirectoryException
- If it is not possible to remove the
specified backup for some reason
(e.g., no such backup exists or
there are other backups that are
dependent upon it).public boolean supportsRestore()
supportsRestore
in class Backend
true
if this backend provides a mechanism for
restoring backups, or false
if not.public void restoreBackup(RestoreConfig restoreConfig) throws DirectoryException
supportsRestore
returns
true
. Note that the server will not explicitly
initialize this backend before calling this method.
restoreBackup
in class Backend
restoreConfig
- The configuration to use when performing
the restore.
DirectoryException
- If a problem occurs while performing
the restore.public ConditionResult hasSubordinates(DN entryDN) throws DirectoryException
hasSubordinates
in class Backend
entryDN
- The distinguished name of the entry.
ConditionResult.TRUE
if the entry has one or more
subordinates or ConditionResult.FALSE
otherwise
or ConditionResult.UNDEFINED
if it can not be
determined.
DirectoryException
- If a problem occurs while trying to
retrieve the entry.public long numSubordinates(DN entryDN, boolean subtree) throws DirectoryException
numSubordinates
in class Backend
entryDN
- The distinguished name of the entry.subtree
- true
to include all entries from the
requested entry to the lowest level in the
tree or false
to only include
the entries immediately below the requested
entry.
DirectoryException
- If a problem occurs while trying to
retrieve the entry.public boolean isConfigurationChangeAcceptable(TrustStoreBackendCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<TrustStoreBackendCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationChange(TrustStoreBackendCfg cfg)
applyConfigurationChange
in interface ConfigurationChangeListener<TrustStoreBackendCfg>
cfg
- The new configuration containing the changes.
public static DN makeChildDN(DN parentDN, AttributeType rdnAttrType, java.lang.String rdnStringValue)
parentDN
- The DN of the parent.rdnAttrType
- The attribute type of the RDN.rdnStringValue
- The string value of the RDN.
public javax.net.ssl.KeyManager[] getKeyManagers() throws DirectoryException
KeyManager
objects that may be used for
interactions requiring access to a key manager.
KeyManager
objects that may be used for
interactions requiring access to a key manager.
DirectoryException
- If a problem occurs while attempting to obtain
the set of key managers.public javax.net.ssl.TrustManager[] getTrustManagers() throws DirectoryException
TrustManager
objects that may be used
for interactions requiring access to a trust manager.
TrustManager
objects that may be used
for interactions requiring access to a trust manager.
DirectoryException
- If a problem occurs while attempting
to obtain the set of trust managers.public java.security.Key getKey(java.lang.String alias) throws DirectoryException
alias
- The alias name.
DirectoryException
- If an error occurs while retrieving the key.public static void createPINFile(java.lang.String path, java.lang.String pin) throws java.io.IOException
path
- the path where the PIN file will be created.pin
- The PIN to store in the file.
java.io.IOException
- if something goes wrong.public void preloadEntryCache() throws java.lang.UnsupportedOperationException
preloadEntryCache
in class Backend
java.lang.UnsupportedOperationException
- if backend does not
support this operation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |