Package org.apache.juneau.rest.annotation

Annotation Type RestOp

@Target(METHOD)
@Retention(RUNTIME)
@Inherited
@ContextApply(RestOpContextApply.class)
@AnnotationGroup(RestOp.class)
public @interface RestOp

Identifies a REST operation Java method on a RestServlet implementation class.

See Also:

• @RestOp-Annotated Methods

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	clientVersion	Specifies whether this method can be called based on the client version.
String[]	consumes	Supported content media types.
Class<? extends RestConverter>[]	converters	Class-level response converters.
String	debug	Enable debug mode.
String	defaultAccept	Default Accept header.
String	defaultCharset	Default character encoding.
String	defaultContentType	Default Content-Type header.
String[]	defaultRequestAttributes	Default request attributes.
String[]	defaultRequestFormData	Specifies default values for form-data parameters.
String[]	defaultRequestHeaders	Default request headers.
String[]	defaultRequestQueryData	Specifies default values for query parameters.
String[]	defaultResponseHeaders	Default response headers.
String[]	description	Optional description for the exposed API.
Class<? extends Encoder>[]	encoders	Specifies the compression encoders for this method.
Class<? extends RestGuard>[]	guards	Method-level guards.
Class<? extends RestMatcher>[]	matchers	Method matchers.
String	maxInput	The maximum allowed input size (in bytes) on HTTP requests.
String	method	REST method name.
String[]	on	Dynamically apply this annotation to the specified methods.
Class<?>[]	parsers	Specifies the parsers for converting HTTP request bodies into POJOs for this method.
String[]	path	Optional path pattern for the specified method.
String[]	produces	Supported accept media types.
String	roleGuard	Role guard.
String	rolesDeclared	Declared roles.
Class<? extends Serializer>[]	serializers	Specifies the serializers for marshalling POJOs into response bodies for this method.
String	summary	Optional summary for the exposed API.
OpSwagger	swagger	Provides swagger-specific metadata on this method.
String	value	REST method name and path.

Element Details

clientVersion

String clientVersion

Specifies whether this method can be called based on the client version.

The client version is identified via the HTTP request header identified by @Rest(clientVersionHeader) which by default is "Client-Version".

This is a specialized kind of RestMatcher that allows you to invoke different Java methods for the same method/path based on the client version.

The format of the client version range is similar to that of OSGi versions.

In the following example, the Java methods are mapped to the same HTTP method and URL "/foobar".

// Call this method if Client-Version is at least 2.0. // Note that this also matches 2.0.1. @RestOp(method=GET, path="/foobar", clientVersion="2.0") public Object method1() {...} // Call this method if Client-Version is at least 1.1, but less than 2.0. @RestOp(method=GET, path="/foobar", clientVersion="[1.1,2.0)") public Object method2() {...} // Call this method if Client-Version is less than 1.1. @RestOp(method=GET, path="/foobar", clientVersion="[0,1.1)") public Object method3() {...}

It's common to combine the client version with transforms that will convert new POJOs into older POJOs for backwards compatibility.

// Call this method if Client-Version is at least 2.0. @RestOp(method=GET, path="/foobar", clientVersion="2.0") public NewPojo newMethod() {...} // Call this method if X-Client-Version is at least 1.1, but less than 2.0. @RestOp(method=GET, path="/foobar", clientVersion="[1.1,2.0)") @BeanConfig(swaps=NewToOldSwap.class) public NewPojo oldMethod() { return newMethod(); }

Note that in the previous example, we're returning the exact same POJO, but using a transform to convert it into an older form. The old method could also just return back a completely different object. The range can be any of the following:

• "[0,1.0)" = Less than 1.0. 1.0 and 1.0.0 does not match.
• "[0,1.0]" = Less than or equal to 1.0. Note that 1.0.1 will match.
• "1.0" = At least 1.0. 1.0 and 2.0 will match.

See Also:

• RestContext.Builder.clientVersionHeader(String)

Returns:

The annotation value.

Default:

""

consumes

String[] consumes

Supported content media types.

Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.

Notes:

• Supports SVL Variables (e.g. "$S{mySystemProperty}").

See Also:

• RestOpContext.Builder.consumes(MediaType...)

Returns:

The annotation value.

Default:

{}

converters

Class<? extends RestConverter>[] converters

Class-level response converters.

Associates one or more converters with this method.

See Also:

• RestOpContext.Builder.converters() - Registering converters with REST resources.

Returns:

The annotation value.

Default:

{}

debug

String debug

Enable debug mode.

Enables the following:

• HTTP request/response bodies are cached in memory for logging purposes.
• Request/response messages are automatically logged.

• "true" - Debug is enabled for all requests.
• "false" - Debug is disabled for all requests.
• "conditional" - Debug is enabled only for requests that have a Debug: true header.
• "" (or anything else) - Debug mode is inherited from class.

Notes:

• Supports SVL Variables (e.g. "$L{my.localized.variable}").

See Also:

• RestContext.Builder.debugEnablement()

Returns:

The annotation value.

Default:

""

defaultAccept

String defaultAccept

Default Accept header.

The default value for the Accept header if not specified on a request.

This is a shortcut for using defaultRequestHeaders() for just this specific header.

Returns:

The annotation value.

Default:

""

defaultCharset

String defaultCharset

Default character encoding.

The default character encoding for the request and response if not specified on the request.

Notes:

• Supports SVL Variables (e.g. "$S{mySystemProperty}").

See Also:

• RestContext.Builder.defaultCharset(Charset)
• RestOpContext.Builder.defaultCharset(Charset)
• Rest.defaultCharset()

Returns:

The annotation value.

Default:

""

defaultContentType

String defaultContentType

Default Content-Type header.

The default value for the Content-Type header if not specified on a request.

This is a shortcut for using defaultRequestHeaders() for just this specific header.

Returns:

The annotation value.

Default:

""

defaultRequestFormData

String[] defaultRequestFormData

Specifies default values for form-data parameters.

Strings are of the format "name=value".

Affects values returned by RestRequest.getFormParam(String) when the parameter is not present on the request.

Example:

@RestOp(method=POST, path="/*", defaultRequestFormData={"foo=bar"}) public String doPost(@FormData("foo") String foo) {...}

Notes:

• You can use either ':' or '=' as the key/value delimiter.
• Key and value is trimmed of whitespace.
• Supports SVL Variables (e.g. "$S{mySystemProperty}").

Returns:

The annotation value.

Default:

{}

defaultRequestQueryData

String[] defaultRequestQueryData

Specifies default values for query parameters.

Strings are of the format "name=value".

Affects values returned by RestRequest.getQueryParam(String) when the parameter is not present on the request.

Example:

@RestOp(method=GET, path="/*", defaultRequestQueryData={"foo=bar"}) public String doGet(@Query("foo") String foo) {...}

Notes:

• You can use either ':' or '=' as the key/value delimiter.
• Key and value is trimmed of whitespace.
• Supports SVL Variables (e.g. "$S{mySystemProperty}").

Returns:

The annotation value.

Default:

{}

defaultRequestAttributes

String[] defaultRequestAttributes

Default request attributes.

Specifies default values for request attributes if they're not already set on the request.

Affects values returned by the following methods:

• RestRequest.getAttribute(String).
• RestRequest.getAttributes().

Example:

// Defined via annotation resolving to a config file setting with default value. @Rest(defaultRequestAttributes={"Foo=bar", "Baz: $C{REST/myAttributeValue}"}) public class MyResource { // Override at the method level. @RestGet(defaultRequestAttributes={"Foo: bar"}) public Object myMethod() {...} }

Notes:

• Supports SVL Variables (e.g. "$L{my.localized.variable}").

See Also:

• RestContext.Builder.defaultRequestAttributes(NamedAttribute...)
• Rest.defaultRequestAttributes()