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:

• Validation. The Enterprise Server determines whether all required parameters are specified and returns an error if any required parameter is omitted.

• Injection. Before the command runs, the Enterprise Server injects each parameter into the required field or method before the command is run.

• Usage message generation. The Enterprise Server uses reflection to obtain the list of parameters for a command and to generate the usage message from this list.

• Localized string display. If the command supports internationalization and if localized strings are available, the Enterprise Server can automatically obtain the localized strings for a command and display them to the user.

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.