Package net.officefloor.web.rest.build

Interface RestMethodDecoratorContext<M>

public interface RestMethodDecoratorContext<M>

Context for the RestMethod.

Method Summary

Modifier and Type	Method	Description
void	addHttpInputInterceptor(HttpInputInterceptor interceptor)	Allows intercepting functionality before the servicing OfficeSectionInput is invoked.
ComposeArchitect	getComposeArchitect()	Obtains the ComposeArchitect.
<T> T	getConfiguration(String itemName, Class<T> type)	Obtains additional configuration for the RestMethod.
HttpMethod	getHttpMethod()	Obtains the HttpMethod.
OfficeArchitect	getOfficeArchitect()	Obtains the OfficeArchitect.
OfficeSourceContext	getOfficeSourceContext()	Obtains the OfficeSourceContext.
RestPathContext	getPath()	Obtains the REST path for this RestMethodDecoratorContext.
WebArchitect	getWebArchitect()	Obtains the WebArchitect.
boolean	isSecure()	Indicates if secure (e.g.
void	setMomento(M momento)	Optionally sets a Momento on the RestMethod.
void	setSecure(boolean isSecure)	Allows overriding if secure.

Method Details

isSecure

boolean isSecure()

Indicates if secure (e.g. HTTPS).

Returns:

true if secure.

setSecure

void setSecure(boolean isSecure)

Allows overriding if secure.

Parameters:

isSecure - Specify if secure.

getPath

RestPathContext getPath()

Obtains the REST path for this RestMethodDecoratorContext.

Returns:

REST path for this RestMethodDecoratorContext.

getHttpMethod

HttpMethod getHttpMethod()

Obtains the HttpMethod.

Returns:

HttpMethod.

getConfiguration

<T> T getConfiguration(String itemName,
 Class<T> type)

Obtains additional configuration for the RestMethod.

This for example is CORS specific configuration for the RestMethod.

Type Parameters:

T - Type of configuration.

Parameters:

itemName - Name of configuration item.

type - Type of configuration.

Returns:

Configuration item.

addHttpInputInterceptor

void addHttpInputInterceptor(HttpInputInterceptor interceptor)

Allows intercepting functionality before the servicing OfficeSectionInput is invoked.

Parameters:

interceptor - HttpInputInterceptor.

setMomento

void setMomento(M momento)

Optionally sets a Momento on the RestMethod.

Parameters:

momento - Momento on the RestMethod available via the MomentoKey.

getOfficeArchitect

OfficeArchitect getOfficeArchitect()

Obtains the OfficeArchitect.

Returns:

OfficeArchitect.

getWebArchitect

WebArchitect getWebArchitect()

Obtains the WebArchitect.

Returns:

WebArchitect.

getComposeArchitect

ComposeArchitect getComposeArchitect()

Obtains the ComposeArchitect.

Returns:

ComposeArchitect.

getOfficeSourceContext

OfficeSourceContext getOfficeSourceContext()

Obtains the OfficeSourceContext.

Returns:

OfficeSourceContext.