Package org.glassfish.api.admin

Annotation Type RestEndpoint

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element 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 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

        Class<? extends org.jvnet.hk2.config.ConfigBeanProxy> configBean
        ConfigBean to which to attach the AdminCommand
        Returns:
        the name of the target ConfigBean

      • opType

        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

        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

        String description
        The description of the endpoint. This is used primarily in the REST HTML interface.
        Returns:
        Default:
        ""

      • params

        RestParam[] params
        A list of one or more @RestParam annotations representing the parameters to be used in the AdminCommand call
        Returns:
        Default:
        {}

      • useForAuthorization

        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