Package net.officefloor.web.rest.build

Interface RestArchitect

All Known Implementing Classes:

RestEmployer.RestArchitectImpl

public interface RestArchitect

Builds servicing of REST requests.

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.

Method Details

addRestMethodDecorator

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

Adds a RestMethodDecorator for the RestMethod instances.

Type Parameters:

M - Momento type.

Parameters:

decorator - RestMethodDecorator.

Returns:

MomentoKey to retrieve possibly set Momento on the RestMethod.

isRestAvailable

boolean isRestAvailable(String resourceDirectory)
                 throws Exception

Determines if REST endpoints are configured.

Parameters:

resourceDirectory - Directory containing the REST configuration.

Returns:

true if REST endpoint configuration available.

Throws:

Exception - If fails to check for REST configuration files.

addRestService

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

Adds servicing of a RestMethod.

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

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

Adds all REST services.

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.