Package org.glassfish.api.admin
Annotation Interface RestEndpoint
- Author:
- Jason Lee
-
Nested Class Summary
-
Required Element Summary
Modifier and TypeRequired ElementDescriptionClass<? extends org.jvnet.hk2.config.ConfigBeanProxy>
ConfigBean to which to attach the AdminCommand -
Optional Element Summary
Modifier and TypeOptional ElementDescriptionThe description of the endpoint.Rest operation type that should trigger a redirect to an actual asadmin command invocation.A list of one or more @RestParam annotations representing the parameters to be used in the AdminCommand callThis is the value of the last segment in the generated URL.boolean
Whether this RestEndpoint should be used for command authorization decisions automatically.
-
Element Details
-
configBean
Class<? extends org.jvnet.hk2.config.ConfigBeanProxy> configBeanConfigBean to which to attach the AdminCommand- Returns:
- the name of the target ConfigBean
-
-
-
opType
RestEndpoint.OpType opTypeRest 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:
- GET
-
path
String pathThis 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
String descriptionThe description of the endpoint. This is used primarily in the REST HTML interface.- Returns:
- Default:
- ""
-
params
RestParam[] paramsA list of one or more @RestParam annotations representing the parameters to be used in the AdminCommand call- Returns:
- Default:
- {}
-
useForAuthorization
boolean useForAuthorizationWhether 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
-