de.minee.rest.annotation

Annotation Type RestResource

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface RestResource

Marks a Field as fully managed RestResource.

If you create a RestServlet like the following example, a valid resource path could be http://localhost:8080/rest/type/name depending on your context root.

 @WebServlet("/rest/*")
 public class Rest extends RestServlet {
        @RestResource("/type/{name}")
        MyType gallery;
 }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Operation[]	allowedOperations Sets the Http Operations that are allowed on the Resource.
Class<? extends Parser>[]	consumes
Class<? extends Renderer>[]	produces
String	value Sub-Path of the Resource.

Element Detail

value

public abstract String value

Sub-Path of the Resource.

Returns:

Sub-Path of the Resource

Default:

""

allowedOperations

public abstract Operation[] allowedOperations

Sets the Http Operations that are allowed on the Resource. Allowed values or combinations are: GET Retrieve one Object or a list of Objects from the exact resource URI. PUT Create new or edit existing Object over the exact resource URI. POST Create new or edit existing Object over the sub path /create or /edit. DELETE Delete a specific Object or a group of Objects. The Objects that get deleted are the same that can be retrieved with GET under the same resource URI. ALL Allow all 4 Operations mentioned above. Default is ALL

Returns:

Default:

de.minee.rest.Operation.ALL

consumes

public abstract Class<? extends Parser>[] consumes

Default:

{}

produces

public abstract Class<? extends Renderer>[] produces

Default:

{}