org.opensaml.storage.impl

Class LDAPStorageService

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

org.opensaml.storage.AbstractStorageService

org.opensaml.storage.impl.LDAPStorageService

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, StorageCapabilities, StorageService

public class LDAPStorageService
extends AbstractStorageService

Implementation of StorageService that stores data in an LDAP. Does not support expiration or versioning at this time.

Field Summary

Fields

Modifier and Type	Field and Description
private org.ldaptive.pool.PooledConnectionFactory	connectionFactory LDAP connection factory.
private org.ldaptive.LdapAttribute[]	defaultAttributes Attributes to include in merge operations.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
LDAPStorageService(org.ldaptive.pool.PooledConnectionFactory factory, org.ldaptive.LdapAttribute... attrs) Creates a new LDAP storage service.

Method Summary

Modifier and Type	Method and Description
boolean	create(java.lang.String context, java.lang.String key, java.lang.String value, java.lang.Long expiration) Creates a new record in the store with an expiration.
private org.ldaptive.Response<java.lang.Void>	delete(java.lang.String dn) Executes a DeleteOperation on the supplied DN.
boolean	delete(java.lang.String context, java.lang.String key) Deletes an existing record from the store.
private org.ldaptive.Response<java.lang.Void>	deleteAttribute(java.lang.String dn, java.lang.String attrName) Executes a ModifyOperation on the supplied DN, removing the supplied attribute.
void	deleteContext(java.lang.String context) Forcibly removes all records in a given context along with any associated resources devoted to maintaining the context.
boolean	deleteWithVersion(long version, java.lang.String context, java.lang.String key) Deletes an existing record from the store if it currently has a specified version.
protected void	doDestroy()
protected void	doInitialize()
private org.ldaptive.Response<java.lang.Void>	merge(org.ldaptive.LdapEntry entry) Executes a MergeOperation with the supplied entry.
StorageRecord	read(java.lang.String context, java.lang.String key) Returns an existing record from the store, if one exists.
net.shibboleth.utilities.java.support.collection.Pair<java.lang.Long,StorageRecord>	read(java.lang.String context, java.lang.String key, long version) Returns an existing record from the store, along with its version.
void	reap(java.lang.String context) Manually trigger a cleanup of expired records.
private org.ldaptive.Response<org.ldaptive.SearchResult>	search(java.lang.String dn, java.lang.String... attrs) Executes a object level SearchOperation on the supplied DN, returning the supplied attributes.
boolean	update(java.lang.String context, java.lang.String key, java.lang.String value, java.lang.Long expiration) Updates an existing record in the store.
void	updateContextExpiration(java.lang.String context, java.lang.Long expiration) Updates the expiration time of all records in the context.
boolean	updateExpiration(java.lang.String context, java.lang.String key, java.lang.Long expiration) Updates expiration of an existing record in the store.
java.lang.Long	updateWithVersion(long version, java.lang.String context, java.lang.String key, java.lang.String value, java.lang.Long expiration) Updates an existing record in the store, if a version matches.

Methods inherited from class org.opensaml.storage.AbstractStorageService

create, create, delete, deleteWithVersion, getCapabilities, getCleanupInterval, getCleanupTask, getCleanupTaskTimer, getContextSize, getKeySize, getValueSize, read, setCleanupInterval, setCleanupTaskTimer, setContextSize, setKeySize, setValueSize, update, update, updateExpiration, updateWithVersion, updateWithVersion

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

private final org.slf4j.Logger log

Class logger.

connectionFactory

private org.ldaptive.pool.PooledConnectionFactory connectionFactory

LDAP connection factory.

defaultAttributes

private org.ldaptive.LdapAttribute[] defaultAttributes

Attributes to include in merge operations.

Constructor Detail

LDAPStorageService

public LDAPStorageService(@Nonnull
                          org.ldaptive.pool.PooledConnectionFactory factory,
                          org.ldaptive.LdapAttribute... attrs)

Creates a new LDAP storage service.

Parameters:

factory - to retrieve LDAP connections from

attrs - to include in all LDAP entries

Method Detail

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class AbstractStorageService

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractStorageService

create

public boolean create(@Nonnull @NotEmpty
                      java.lang.String context,
                      @Nonnull @NotEmpty
                      java.lang.String key,
                      @Nonnull @NotEmpty
                      java.lang.String value,
                      @Nullable @Positive
                      java.lang.Long expiration)
               throws java.io.IOException

Creates a new record in the store with an expiration.

Parameters:

context - a storage context label

key - a key unique to context

value - value to store

expiration - expiration for record, or null

Returns:

true iff record was inserted, false iff a duplicate was found

Throws:

java.io.IOException - if fatal errors occur in the insertion process

read

@Nullable
public StorageRecord read(@Nonnull @NotEmpty
                                    java.lang.String context,
                                    @Nonnull @NotEmpty
                                    java.lang.String key)
                             throws java.io.IOException

Returns an existing record from the store, if one exists.

Parameters:

context - a storage context label

key - a key unique to context

Returns:

the record read back, if present, or null

Throws:

java.io.IOException - if errors occur in the read process

read

@Nonnull
public net.shibboleth.utilities.java.support.collection.Pair<java.lang.Long,StorageRecord> read(@Nonnull @NotEmpty
                                                                                                         java.lang.String context,
                                                                                                         @Nonnull @NotEmpty
                                                                                                         java.lang.String key,
                                                                                                         @Positive
                                                                                                         long version)
                                                                                                  throws java.io.IOException

Returns an existing record from the store, along with its version.

The first member of the pair returned will contain the version of the record in the store, or will be null if no record exists. The second member will contain the record read back. If null, the record either didn't exist (if the first member was also null) or the record was the same version as that supplied by the caller.

Parameters:

context - a storage context label

key - a key unique to context

version - only return record if newer than supplied version

Returns:

a pair consisting of the version of the record read back, if any, and the record itself

Throws:

java.io.IOException - if errors occur in the read process

update

public boolean update(@Nonnull @NotEmpty
                      java.lang.String context,
                      @Nonnull @NotEmpty
                      java.lang.String key,
                      @Nonnull @NotEmpty
                      java.lang.String value,
                      @Nullable @Positive
                      java.lang.Long expiration)
               throws java.io.IOException

Updates an existing record in the store.

Parameters:

context - a storage context label

key - a key unique to context

value - updated value

expiration - expiration for record, or null

Returns:

true if the update succeeded, false if the record does not exist

Throws:

java.io.IOException - if errors occur in the update process

updateWithVersion

@Nullable
public java.lang.Long updateWithVersion(@Positive
                                                  long version,
                                                  @Nonnull @NotEmpty
                                                  java.lang.String context,
                                                  @Nonnull @NotEmpty
                                                  java.lang.String key,
                                                  @Nonnull @NotEmpty
                                                  java.lang.String value,
                                                  @Nullable @Positive
                                                  java.lang.Long expiration)
                                           throws java.io.IOException,
                                                  VersionMismatchException

Updates an existing record in the store, if a version matches.

Parameters:

version - only update if the current version matches this value

context - a storage context label

key - a key unique to context

value - updated value

expiration - expiration for record, or null

Returns:

the version of the record after update, null if no record exists

Throws:

java.io.IOException - if errors occur in the update process

VersionMismatchException - if the record has already been updated to a newer version

updateExpiration

public boolean updateExpiration(@Nonnull @NotEmpty
                                java.lang.String context,
                                @Nonnull @NotEmpty
                                java.lang.String key,
                                @Nullable @Positive
                                java.lang.Long expiration)
                         throws java.io.IOException

Updates expiration of an existing record in the store.

Parameters:

context - a storage context label

key - a key unique to context

expiration - expiration for record, or null

Returns:

true if the update succeeded, false if the record does not exist

Throws:

java.io.IOException - if errors occur in the update process

delete

public boolean delete(@Nonnull @NotEmpty
                      java.lang.String context,
                      @Nonnull @NotEmpty
                      java.lang.String key)
               throws java.io.IOException

Deletes an existing record from the store.

Parameters:

context - a storage context label

key - a key unique to context

Returns:

true iff the record existed and was deleted

Throws:

java.io.IOException - if errors occur in the deletion process

deleteWithVersion

public boolean deleteWithVersion(@Positive
                                 long version,
                                 @Nonnull @NotEmpty
                                 java.lang.String context,
                                 @Nonnull @NotEmpty
                                 java.lang.String key)
                          throws java.io.IOException,
                                 VersionMismatchException

Deletes an existing record from the store if it currently has a specified version.

Parameters:

version - record version to delete

context - a storage context label

key - a key unique to context

Returns:

true iff the record existed and was deleted

Throws:

java.io.IOException - if errors occur in the deletion process

VersionMismatchException - if the record has already been updated to a newer version

reap

public void reap(@Nonnull @NotEmpty
                 java.lang.String context)
          throws java.io.IOException

Manually trigger a cleanup of expired records. The method MAY return without guaranteeing that cleanup has already occurred.

Parameters:

context - a storage context label

Throws:

java.io.IOException - if errors occur in the cleanup process

updateContextExpiration

public void updateContextExpiration(@Nonnull @NotEmpty
                                    java.lang.String context,
                                    @Nullable @Positive
                                    java.lang.Long expiration)
                             throws java.io.IOException

Updates the expiration time of all records in the context.

Parameters:

context - a storage context label

expiration - a new expiration timestamp, or null

Throws:

java.io.IOException - if errors occur in the cleanup process

deleteContext

public void deleteContext(@Nonnull @NotEmpty
                          java.lang.String context)
                   throws java.io.IOException

Forcibly removes all records in a given context along with any associated resources devoted to maintaining the context.

Parameters:

context - a storage context label

Throws:

java.io.IOException - if errors occur in the cleanup process

merge

@Nonnull
private org.ldaptive.Response<java.lang.Void> merge(@Nonnull
                                                             org.ldaptive.LdapEntry entry)
                                                      throws org.ldaptive.LdapException

Executes a MergeOperation with the supplied entry.

Parameters:

entry - to merge

Returns:

response for the merge operation

Throws:

org.ldaptive.LdapException - if the operation fails

search

@Nonnull
private org.ldaptive.Response<org.ldaptive.SearchResult> search(@Nonnull
                                                                         java.lang.String dn,
                                                                         java.lang.String... attrs)
                                                                  throws org.ldaptive.LdapException

Executes a object level SearchOperation on the supplied DN, returning the supplied attributes.

Parameters:

dn - to search on

attrs - to return

Returns:

response for the search operation

Throws:

org.ldaptive.LdapException - if the operation fails

deleteAttribute

@Nonnull
private org.ldaptive.Response<java.lang.Void> deleteAttribute(@Nonnull
                                                                       java.lang.String dn,
                                                                       @Nonnull
                                                                       java.lang.String attrName)
                                                                throws org.ldaptive.LdapException

Executes a ModifyOperation on the supplied DN, removing the supplied attribute.

Parameters:

dn - to modify

attrName - to remove

Returns:

response for the modify operation

Throws:

org.ldaptive.LdapException - if the operation fails

delete

@Nonnull
private org.ldaptive.Response<java.lang.Void> delete(@Nonnull
                                                              java.lang.String dn)
                                                       throws org.ldaptive.LdapException

Executes a DeleteOperation on the supplied DN.

Parameters:

dn - to delete

Returns:

response for the delete operation

Throws:

org.ldaptive.LdapException - if the operation fails