org.glassfish.api.admin

Annotation Type RestEndpoint

@Retention(value=RUNTIME)
public @interface RestEndpoint

Author:

Jason Lee

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends org.jvnet.hk2.config.ConfigBeanProxy>	configBean ConfigBean to which to attach the AdminCommand

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The description of the endpoint.
RestEndpoint.OpType	opType Rest operation type that should trigger a redirect to an actual asadmin command invocation.
RestParam[]	params A list of one or more @RestParam annotations representing the parameters to be used in the AdminCommand call
String	path This is the value of the last segment in the generated URL.
boolean	useForAuthorization Whether this RestEndpoint should be used for command authorization decisions automatically.

Element Detail

configBean

public abstract Class<? extends org.jvnet.hk2.config.ConfigBeanProxy> configBean

ConfigBean to which to attach the AdminCommand

Returns:

the name of the target ConfigBean

opType

public abstract RestEndpoint.OpType opType

Rest operation type that should trigger a redirect to an actual asadmin command invocation. The default is GET.

Returns:

the rest operation type for this redirect

Default:

org.glassfish.api.admin.RestEndpoint.OpType.GET

path

public abstract String path

This is the value of the last segment in the generated URL. If blank, this will default to the value of the name attribute on the commands @Service annotation

Returns:

Default:

""

description

public abstract String description

The description of the endpoint. This is used primarily in the REST HTML interface.

Returns:

Default:

""

params

public abstract RestParam[] params

A list of one or more @RestParam annotations representing the parameters to be used in the AdminCommand call

Returns:

Default:

{}

useForAuthorization

public abstract boolean useForAuthorization

Whether this RestEndpoint should be used for command authorization decisions automatically. Setting this to true causes the admin command framework automatically to use the configBean attribute to compute the resource name and the OpType to compute the action.

Returns:

Default:

false