Package net.officefloor.web.security.type

Class HttpSecurityManagedObjectAdapterSource<O extends java.lang.Enum<O>>

java.lang.Object

net.officefloor.web.security.type.HttpSecurityManagedObjectAdapterSource<O>

All Implemented Interfaces:

ManagedObjectSource<O,Indexed>

@PrivateSource
public class HttpSecurityManagedObjectAdapterSource<O extends java.lang.Enum<O>>
extends java.lang.Object
implements ManagedObjectSource<O,Indexed>

Adapts the HttpSecuritySource to be a ManagedObjectSource.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
HttpSecurityManagedObjectAdapterSource()	Should only be used within doOperation(HttpSecuritySource, Runnable).
HttpSecurityManagedObjectAdapterSource(HttpSecuritySource<?,?,?,O,?> httpSecuritySource, java.util.function.Supplier<PropertyList> propertyListFactory)	Initiate.

Method Summary

Modifier and Type	Method	Description
static <A,AC extends java.io.Serializable,C,O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> void	doOperation(HttpSecuritySource<A,AC,C,O,F> httpSecuritySource, java.lang.Runnable operation)	Undertakes the operation for the HttpSecuritySource.
HttpSecuritySourceMetaData<?,?,?,O,?>	getHttpSecuritySourceMetaData()	Obtains the HttpSecuritySourceMetaData.
HttpSecuritySupportingManagedObjectImpl<?>[]	getHttpSecuritySupportingManagedObjects()	Obtains the HttpSecuritySupportingManagedObjectImpl instances for the HttpSecuritySource.
ManagedObjectSourceSpecification	getSpecification()	Obtains the specification for this.
ManagedObjectSourceMetaData<O,Indexed>	init(ManagedObjectSourceContext<Indexed> context)	Initialises the ManagedObjectSource.
void	sourceManagedObject(ManagedObjectUser user)	Sources a ManagedObject from this ManagedObjectSource.
void	start(ManagedObjectExecuteContext<Indexed> context)	Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.
void	stop()	Called to notify that the OfficeFloor is being closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSecurityManagedObjectAdapterSource

public HttpSecurityManagedObjectAdapterSource()
                                       throws java.lang.IllegalStateException

Should only be used within doOperation(HttpSecuritySource, Runnable).

Throws:

java.lang.IllegalStateException - If not being loaded within operation context.

HttpSecurityManagedObjectAdapterSource

public HttpSecurityManagedObjectAdapterSource(HttpSecuritySource<?,?,?,O,?> httpSecuritySource,
                                              java.util.function.Supplier<PropertyList> propertyListFactory)

Initiate.

Parameters:

httpSecuritySource - HttpSecuritySource.

propertyListFactory - Factory to create a PropertyList.

Method Detail

doOperation

public static <A,AC extends java.io.Serializable,C,O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> void doOperation(HttpSecuritySource<A,AC,C,O,F> httpSecuritySource,
                                                                                                                                                     java.lang.Runnable operation)

Undertakes the operation for the HttpSecuritySource.

Type Parameters:

A - Authentication type.

AC - Access control type.

C - Credentials type.

O - Dependency keys type.

F - Flow keys type.

Parameters:

httpSecuritySource - HttpSecuritySource.

operation - Runnable containing the operation to undertake.

getHttpSecuritySourceMetaData

public HttpSecuritySourceMetaData<?,?,?,O,?> getHttpSecuritySourceMetaData()

Obtains the HttpSecuritySourceMetaData.

Returns:

HttpSecuritySourceMetaData.

getHttpSecuritySupportingManagedObjects

public HttpSecuritySupportingManagedObjectImpl<?>[] getHttpSecuritySupportingManagedObjects()

Obtains the HttpSecuritySupportingManagedObjectImpl instances for the HttpSecuritySource.

Returns:

HttpSecuritySupportingManagedObjectImpl instances for the HttpSecuritySource.

getSpecification

public ManagedObjectSourceSpecification getSpecification()

Description copied from interface: ManagedObjectSource

Obtains the specification for this.

This will be called before any other methods, therefore this method must be able to return the specification immediately after a default constructor instantiation.

Specified by:

getSpecification in interface ManagedObjectSource<O extends java.lang.Enum<O>,Indexed>

Returns:

Specification of this.

init

public ManagedObjectSourceMetaData<O,Indexed> init(ManagedObjectSourceContext<Indexed> context)
                                                  throws java.lang.Exception

Description copied from interface: ManagedObjectSource

Initialises the ManagedObjectSource.

Specified by:

init in interface ManagedObjectSource<O extends java.lang.Enum<O>,Indexed>

Parameters:

context - ManagedObjectSourceContext to use in initialising.

Returns:

Meta-data to describe this.

Throws:

java.lang.Exception - Should the ManagedObjectSource fail to configure itself from the input properties.

start

public void start(ManagedObjectExecuteContext<Indexed> context)
           throws java.lang.Exception

Description copied from interface: ManagedObjectSource

Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

On invocation of this method, ProcessState instances may be invoked via the ManagedObjectExecuteContext.

Specified by:

start in interface ManagedObjectSource<O extends java.lang.Enum<O>,Indexed>

Parameters:

context - ManagedObjectExecuteContext to use in starting this ManagedObjectSource.

Throws:

java.lang.Exception - Should the ManagedObjectSource fail to start execution.

sourceManagedObject

public void sourceManagedObject(ManagedObjectUser user)

Description copied from interface: ManagedObjectSource

Sources a ManagedObject from this ManagedObjectSource.

Specified by:

sourceManagedObject in interface ManagedObjectSource<O extends java.lang.Enum<O>,Indexed>

Parameters:

user - ManagedObjectUser interested in using the ManagedObject.

stop

public void stop()

Description copied from interface: ManagedObjectSource

Called to notify that the OfficeFloor is being closed.

On return from this method, no further ProcessState instances may be invoked.

Specified by:

stop in interface ManagedObjectSource<O extends java.lang.Enum<O>,Indexed>