net.officefloor.plugin.web.http.security.store

Class MockCredentialStoreManagedObjectSource

java.lang.Object

net.officefloor.frame.spi.managedobject.source.impl.AbstractAsyncManagedObjectSource<D,F>

net.officefloor.frame.spi.managedobject.source.impl.AbstractManagedObjectSource<None,None>

net.officefloor.plugin.web.http.security.store.MockCredentialStoreManagedObjectSource

All Implemented Interfaces:

ManagedObject, ManagedObjectSource<None,None>, CredentialStore

public class MockCredentialStoreManagedObjectSource
extends AbstractManagedObjectSource<None,None>
implements ManagedObject, CredentialStore

Provides mocking of a CredentialStore in a similar way MockHttpSecuritySource works.

Using this store allows the application to be built with its appropriate HttpSecuritySource authentication scheme. This mocks the backing CredentialStore for development and tests environments to avoid user management. This therefore avoids the need to change the application behaviour between environments (same HttpSecuritySource but differing configured CredentialStore).

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.frame.spi.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller, AbstractAsyncManagedObjectSource.Labeller, AbstractAsyncManagedObjectSource.MetaDataContext<D extends Enum<D>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_ALGORITHM Name of the Property for the algorithm.

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

DEFAULT_ALGORITHM, NO_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
MockCredentialStoreManagedObjectSource()

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm() Obtains the algorithm used to encrypt credentials within this CredentialStore.
protected ManagedObject	getManagedObject() Synchronously obtains the ManagedObject.
Object	getObject() Obtains the object being managed.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context) Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context) Overridden to load specifications.
CredentialEntry	retrieveCredentialEntry(String userId, String realm) Retrieves the CredentialEntry.

Methods inherited from class net.officefloor.frame.spi.managedobject.source.impl.AbstractManagedObjectSource

sourceManagedObject

Methods inherited from class net.officefloor.frame.spi.managedobject.source.impl.AbstractAsyncManagedObjectSource

getMetaData, getSpecification, init, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_ALGORITHM

public static final String PROPERTY_ALGORITHM

Name of the Property for the algorithm.

See Also:

Constant Field Values

Constructor Detail

MockCredentialStoreManagedObjectSource

public MockCredentialStoreManagedObjectSource()

Method Detail

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

getManagedObject

protected ManagedObject getManagedObject()
                                  throws Throwable

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<None,None>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.

getObject

public Object getObject()
                 throws Throwable

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

Throws:

Throwable - Indicating failed to obtain the object for use.

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 IOException

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:

IOException - If fails to retrieve CredentialEntry.