Package net.officefloor.web.state

Class HttpApplicationStateManagedObjectSource

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

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

net.officefloor.web.state.HttpApplicationStateManagedObjectSource

All Implemented Interfaces:

ManagedObject, ManagedObjectSource<None,None>, HttpApplicationState

@PrivateSource
public class HttpApplicationStateManagedObjectSource
extends AbstractManagedObjectSource<None,None>
implements ManagedObject, HttpApplicationState

ManagedObjectSource for the HttpRequestState.

Author:

Daniel Sagenschneider

Nested Class Summary

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

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Constructor Summary

Constructors

Constructor	Description
HttpApplicationStateManagedObjectSource(String contextPath)	Instantiate.

Method Summary

Modifier and Type	Method	Description
String	createApplicationClientPath(String path)	Creates the client path for this application.
String	createApplicationClientUrl(boolean isSecure, String path, ServerHttpConnection connection)	Creates the client URL for this application.
String	extractApplicationPath(ServerHttpConnection connection)	Extracts the application path from the HttpRequest.
Object	getAttribute(String name)	Obtains the Object that is bound to the name.
Iterator<String>	getAttributeNames()	Obtains an Iterator to the names of the bound Object instances.
String	getContextPath()	Obtains the context path for the application.
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.
void	removeAttribute(String name)	Removes the bound Object by the name.
void	setAttribute(String name, Object object)	Binds the Object to the name.

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

sourceManagedObject

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

getSpecification, init, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

HttpApplicationStateManagedObjectSource

public HttpApplicationStateManagedObjectSource(String contextPath)

Instantiate.

Parameters:

contextPath - Context path.

Method Details

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.

getContextPath

public String getContextPath()

Description copied from interface: HttpApplicationState

Obtains the context path for the application.

Specified by:

getContextPath in interface HttpApplicationState

Returns:

Context path for the application.

createApplicationClientUrl

public String createApplicationClientUrl(boolean isSecure,
 String path,
 ServerHttpConnection connection)

Description copied from interface: HttpApplicationState

Creates the client URL for this application.

This includes protocol, domain and port.

Specified by:

createApplicationClientUrl in interface HttpApplicationState

Parameters:

isSecure - Indicates if the URL is secure.

path - Path including query string and fragment for the URL.

connection - ServerHttpConnection.

Returns:

Client URL for the application.

createApplicationClientPath

public String createApplicationClientPath(String path)

Description copied from interface: HttpApplicationState

Creates the client path for this application.

This is the public path on the server, and does NOT protocol, domain nor port.

Specified by:

createApplicationClientPath in interface HttpApplicationState

Parameters:

path - Path including query string and fragment for the path.

Returns:

Client path for the application.

extractApplicationPath

public String extractApplicationPath(ServerHttpConnection connection)
                              throws HttpException

Description copied from interface: HttpApplicationState

Extracts the application path from the HttpRequest.

Specified by:

extractApplicationPath in interface HttpApplicationState

Parameters:

connection - ServerHttpConnection.

Returns:

Application path.

Throws:

HttpException - If invalid path for this application.

getAttribute

public Object getAttribute(String name)

Description copied from interface: HttpApplicationState

Obtains the Object that is bound to the name.

Specified by:

getAttribute in interface HttpApplicationState

Parameters:

name - Name.

Returns:

Object bound to the name or null if no Object bound by the name.

getAttributeNames

public Iterator<String> getAttributeNames()

Description copied from interface: HttpApplicationState

Obtains an Iterator to the names of the bound Object instances.

Specified by:

getAttributeNames in interface HttpApplicationState

Returns:

Iterator to the names of the bound Object instances.

setAttribute

public void setAttribute(String name,
 Object object)

Description copied from interface: HttpApplicationState

Binds the Object to the name.

Specified by:

setAttribute in interface HttpApplicationState

Parameters:

name - Name.

object - Object.

removeAttribute

public void removeAttribute(String name)

Description copied from interface: HttpApplicationState

Removes the bound Object by the name.

Specified by:

removeAttribute in interface HttpApplicationState

Parameters:

name - Name of bound Object to remove.