Package net.officefloor.web.rest.build

Class RestEmployer.RestArchitectImpl

java.lang.Object

net.officefloor.web.rest.build.RestEmployer.RestArchitectImpl

All Implemented Interfaces:

RestArchitect

Enclosing class:

RestEmployer

protected static class RestEmployer.RestArchitectImpl
extends Object
implements RestArchitect

RestArchitect implementation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestArchitectImpl(OfficeArchitect officeArchitect, WebArchitect webArchitect, ComposeArchitect composeArchitect, OfficeSourceContext officeSourceContext)

Method Summary

Modifier and Type	Method	Description
<M> MomentoKey<M>	addRestMethodDecorator(RestMethodDecorator<M> decorator)	Adds a RestMethodDecorator for the RestMethod instances.
RestEndpoint	addRestService(boolean isSecure, HttpMethod method, String restPath, String compositionLocation, PropertyList properties, RestConfiguration endpointConfiguration)	Adds servicing of a RestMethod.
Map<String,RestEndpoint>	addRestServices(boolean isSecure, String resourceDirectory, PropertyList properties)	Adds all REST services.
boolean	isRestAvailable(String resourceDirectory)	Determines if REST endpoints are configured.

Methods inherited from class java.lang.Object

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

Constructor Details

RestArchitectImpl

protected RestArchitectImpl(OfficeArchitect officeArchitect,
 WebArchitect webArchitect,
 ComposeArchitect composeArchitect,
 OfficeSourceContext officeSourceContext)

Parameters:

officeArchitect - OfficeArchitect.

webArchitect - WebArchitect.

composeArchitect - ComposeArchitect.

officeSourceContext - OfficeSourceContext.

Method Details

isRestAvailable

public boolean isRestAvailable(String resourceDirectory)
                        throws Exception

Description copied from interface: RestArchitect

Determines if REST endpoints are configured.

Specified by:

isRestAvailable in interface RestArchitect

Parameters:

resourceDirectory - Directory containing the REST configuration.

Returns:

true if REST endpoint configuration available.

Throws:

Exception - If fails to check for REST configuration files.

addRestMethodDecorator

public <M> MomentoKey<M> addRestMethodDecorator(RestMethodDecorator<M> decorator)

Description copied from interface: RestArchitect

Adds a RestMethodDecorator for the RestMethod instances.

Specified by:

addRestMethodDecorator in interface RestArchitect

Type Parameters:

M - Momento type.

Parameters:

decorator - RestMethodDecorator.

Returns:

MomentoKey to retrieve possibly set Momento on the RestMethod.

addRestService

public RestEndpoint addRestService(boolean isSecure,
 HttpMethod method,
 String restPath,
 String compositionLocation,
 PropertyList properties,
 RestConfiguration endpointConfiguration)
                            throws Exception

Description copied from interface: RestArchitect

Adds servicing of a RestMethod.

Specified by:

addRestService in interface RestArchitect

Parameters:

isSecure - Indicates whether request must be over HTTPS.

method - HttpMethod.

restPath - REST path.

compositionLocation - Location of composition to handle the RestMethod.

properties - PropertyList to configure servicing.

endpointConfiguration - RestConfiguration for the RestEndpoint.

Returns:

RestEndpoint.

Throws:

Exception - If fails to load RestEndpoint.

addRestServices

public Map<String,RestEndpoint> addRestServices(boolean isSecure,
 String resourceDirectory,
 PropertyList properties)
                                         throws Exception

Description copied from interface: RestArchitect

Adds all REST services.

Specified by:

addRestServices in interface RestArchitect

Parameters:

isSecure - Indicates if must be over HTTPS.

resourceDirectory - Directory containing the REST configuration.

properties - PropertyList to configure servicing.

Returns:

RestEndpoint instances by their path.

Throws:

Exception - If fails to load RestEndpoint instances.