Package net.officefloor.web.security.store

Class JndiLdapCredentialStore

java.lang.Object

net.officefloor.web.security.store.JndiLdapCredentialStore

All Implemented Interfaces:

CredentialStore

public class JndiLdapCredentialStore
extends Object
implements CredentialStore

CredentialStore for DirContext.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.web.security.store.CredentialStore

DEFAULT_ALGORITHM, NO_ALGORITHM

Constructor Summary

Constructors

Constructor	Description
JndiLdapCredentialStore(String algorithm, DirContext context, String entrySearchBaseDn, String rolesSearchBaseDn)	Initiate.

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()	Obtains the algorithm used to encrypt credentials within this CredentialStore.
CredentialEntry	retrieveCredentialEntry(String userId, String realm)	Retrieves the CredentialEntry.

Methods inherited from class java.lang.Object

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

Constructor Details

JndiLdapCredentialStore

public JndiLdapCredentialStore(String algorithm,
 DirContext context,
 String entrySearchBaseDn,
 String rolesSearchBaseDn)

Initiate.

Parameters:

algorithm - Algorithm.

context - DirContext.

entrySearchBaseDn - Base dn for searching for entries.

rolesSearchBaseDn - Base dn for searching for roles.

Method Details

getAlgorithm

public String getAlgorithm()

Description copied from interface: CredentialStore

Obtains the algorithm used to encrypt credentials within this CredentialStore.

Should the return be null, blank or CredentialStore.NO_ALGORITHM then the password is considered to be stored in plain text. This is however only useful for the BASIC authentication scheme due to the nature of the other authentication schemes (such as DIGEST).

It is expected that the credentials for DIGEST will be stored as the algorithm applied to userId:realm:password (as per RFC 2617). This is necessary as the password is never supplied and therefore for DIGEST this MUST return an algorithm.

Specified by:

getAlgorithm in interface CredentialStore

Returns:

Algorithm.

retrieveCredentialEntry

public CredentialEntry retrieveCredentialEntry(String userId,
 String realm)
                                        throws HttpException

Description copied from interface: CredentialStore

Retrieves the CredentialEntry.

Specified by:

retrieveCredentialEntry in interface CredentialStore

Parameters:

userId - User identifier.

realm - Realm. May be null (especially in the case for Basic authentication).

Returns:

CredentialEntry or null if no CredentialEntry exists for parameters.

Throws:

HttpException - If fails to retrieve CredentialEntry.