Sun GlassFish Enterprise Server v3 Prelude Add-On Component Development Guide

Identifying a Parameter of an asadmin Command

Identifying a parameter of an asadmin command enables Enterprise Server to perform the following operations at runtime on the parameter:

To identify a parameter of a command, annotate the declaration of the item that is associated with the parameter with the org.glassfish.api.Param annotation. This item is either the field or setter method that is associated with the parameter.

To specify the properties of the parameter, use the elements of the @Param annotation as explained in the sections that follow.