sirius.web.controller

Annotation Type Routed

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Routed

Attaches a URI to a Controller method.

For conflicting URIs like /foo/:1 should handle everything but /foo/special, use a priority below PriorityCollector.DEFAULT_PRIORITY for /foo/special

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Returns the URI pattern which describes matching request.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	jsonCall Determines if the annotated method is used to generate a JSON response.
boolean	preDispatchable Determines if the annotated method supports pre-dispatching.
int	priority Sets the priority used for this route.

Element Detail

value

public abstract String value

Returns the URI pattern which describes matching request.

The pattern should start with a / character, which is also use to separate path elements. Each element can be one of the following:

• a string literal like "hello". This must match the part in the request URI
• a parameter index like :1. This will copy the path-element from the request into the n-th method parameter
• a attribute expression like #{name}: This will copy the path-element form the request into an request attribute (WebContext.setAttribute(String, Object)
• an i18n string like ${i18n.key}: This will be transalted using NLS. The resulting string must match the part in the request URI
• a * can be used to accept any path element in the request URI
• a ** behaves like a variac parameter. It can only occur at the end of the expression and the method has to provide a List<String> subPath as last parameter which will contain all matched elements

Returns:

the URI pattern describing which requests to handle

priority

public abstract int priority

Sets the priority used for this route.

For non-conflicting URIs, this can be skipped. For everything else, the lower the better ;-)

Returns:

the priority used to sort the order of invocation of all rules. The default is PriorityCollector.DEFAULT_PRIORITY.

Default:

100

preDispatchable

public abstract boolean preDispatchable

Determines if the annotated method supports pre-dispatching.

A pre-dispatchable method takes care of the requests payload itself. Therefore the method must declare an additional parameter of type InputStreamHandler which will be used to consume the data sent via POST or PUT.

Returns:

true if the method is pre-dispatchable, false otherwise

Default:

false

jsonCall

public abstract boolean jsonCall

Determines if the annotated method is used to generate a JSON response.

This can be used to handle AJAX requests directly within a controller. In such simple cases if is often feasible to keep the logic in one place (controller) instead for creating a StructuredService.

A method having jsonCall set to true has to accept JSONStructuredOutput as 2nd parameter. This parameter is filled with a pre-initialized output writer, which has JSONStructuredOutput.beginResult() and JSONStructuredOutput.endResult() automatically called.

Also the properties success and error are automatically filled. In case on an exception within the controller method, a result with success, errro and message is automatically created.

Note: If implementing method does fork a new thread and pass the given output along, the method must return a Promise or Future so that the dispatcher knowns when the generated output is complete.

Returns:

true if the method is used to create a JSON response for an AJAX call, false otherwise

Default:

false