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, StorageCapabilitiesEx, StorageService

public class LDAPStorageService
extends AbstractStorageService
implements StorageCapabilitiesEx

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 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

Methods

Modifier and Type	Method and Description
boolean	create(String context, String key, String value, Long expiration)
private org.ldaptive.Response<Void>	delete(String dn) Executes a DeleteOperation on the supplied DN.
boolean	delete(String context, String key)
private org.ldaptive.Response<Void>	deleteAttribute(String dn, String attrName) Executes a ModifyOperation on the supplied DN, removing the supplied attribute.
void	deleteContext(String context)
boolean	deleteWithVersion(long version, String context, String key)
protected void	doDestroy()
protected void	doInitialize()
boolean	isClustered()
boolean	isServerSide()
private org.ldaptive.Response<Void>	merge(org.ldaptive.LdapEntry entry) Executes a MergeOperation with the supplied entry.
StorageRecord	read(String context, String key)
net.shibboleth.utilities.java.support.collection.Pair<Long,StorageRecord>	read(String context, String key, long version)
void	reap(String context)
private org.ldaptive.Response<org.ldaptive.SearchResult>	search(String dn, String... attrs) Executes a object level SearchOperation on the supplied DN, returning the supplied attributes.
boolean	update(String context, String key, String value, Long expiration)
void	updateContextExpiration(String context, Long expiration)
boolean	updateExpiration(String context, String key, Long expiration)
Long	updateWithVersion(long version, String context, String key, String value, Long expiration)

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 org.opensaml.storage.StorageCapabilities

getContextSize, getKeySize, getValueSize

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

getId

Field Detail

log

private final 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

isServerSide

public boolean isServerSide()

Specified by:

isServerSide in interface StorageCapabilitiesEx

isClustered

public boolean isClustered()

Specified by:

isClustered in interface StorageCapabilitiesEx

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
             String context,
             @Nonnull@NotEmpty
             String key,
             @Nonnull@NotEmpty
             String value,
             @Nullable@Positive
             Long expiration)
               throws IOException

Specified by:

create in interface StorageService

Throws:

IOException

read

@Nullable
public StorageRecord read(@Nonnull@NotEmpty
                          String context,
                          @Nonnull@NotEmpty
                          String key)
                   throws IOException

Specified by:

read in interface StorageService

Throws:

IOException

read

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

Specified by:

read in interface StorageService

Throws:

IOException

update

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

Specified by:

update in interface StorageService

Throws:

IOException

updateWithVersion

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

Specified by:

updateWithVersion in interface StorageService

Throws:

IOException

VersionMismatchException

updateExpiration

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

Specified by:

updateExpiration in interface StorageService

Throws:

IOException

delete

public boolean delete(@Nonnull@NotEmpty
             String context,
             @Nonnull@NotEmpty
             String key)
               throws IOException

Specified by:

delete in interface StorageService

Throws:

IOException

deleteWithVersion

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

Specified by:

deleteWithVersion in interface StorageService

Throws:

IOException

VersionMismatchException

reap

public void reap(@Nonnull@NotEmpty
        String context)
          throws IOException

Specified by:

reap in interface StorageService

Throws:

IOException

updateContextExpiration

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

Specified by:

updateContextExpiration in interface StorageService

Throws:

IOException

deleteContext

public void deleteContext(@Nonnull@NotEmpty
                 String context)
                   throws IOException

Specified by:

deleteContext in interface StorageService

Throws:

IOException

merge

@Nonnull
private org.ldaptive.Response<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
                                                              String dn,
                                                              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<Void> deleteAttribute(@Nonnull
                                                  String dn,
                                                  @Nonnull
                                                  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<Void> delete(@Nonnull
                                         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