org.forgerock.api.annotations

Annotation Type Delete

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

Indicates an CREST delete method on an annotated POJO. This annotation can only be used on collection resource request handlers.

The annotated method's return type must be:

• A Promise<Resource, ? extends ResourceException> promise.

The method should take the following parameters:

• A string parameter for the instance identifier.

The method may also take the following parameters:

• A org.forgerock.json.resource.DeleteRequest for the request.
• A Context to be given the context.

See Also:

RequestHandler, SingletonProvider, CollectionProvider

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Operation	operationDescription Describe the standard operation details of this action.

Element Detail

operationDescription

public abstract Operation operationDescription

Describe the standard operation details of this action.