org.glassfish.common.util.admin

Class GenericCommandModel

java.lang.Object

org.glassfish.api.admin.CommandModel

org.glassfish.common.util.admin.GenericCommandModel

public class GenericCommandModel
extends org.glassfish.api.admin.CommandModel

Nested Class Summary

Nested classes/interfaces inherited from class org.glassfish.api.admin.CommandModel

org.glassfish.api.admin.CommandModel.ParamModel

Constructor Summary

Constructors

Constructor and Description
GenericCommandModel(Class<?> targetType, boolean useAnnotations, org.glassfish.api.admin.ExecuteOn cluster, org.glassfish.api.I18n i18n, LocalStringManager localStrings, org.jvnet.hk2.config.DomDocument document, String commandName, boolean managedJob, Class<?>... extraTypes) GenericCommandModel constructor.

Method Summary

Modifier and Type	Method and Description
void	add(org.glassfish.api.admin.CommandModel.ParamModel model)
org.glassfish.api.admin.ExecuteOn	getClusteringAttributes()
Class<?>	getCommandClass()
String	getCommandName()
String	getLocalizedDescription()
org.glassfish.api.admin.CommandModel.ParamModel	getModelFor(String paramName)
Collection<String>	getParametersNames()
String	getUsageText()
boolean	isManagedJob()

Methods inherited from class org.glassfish.api.admin.CommandModel

getParameters, getParamName, unknownOptionsAreOperands

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericCommandModel

public GenericCommandModel(Class<?> targetType,
                           boolean useAnnotations,
                           org.glassfish.api.admin.ExecuteOn cluster,
                           org.glassfish.api.I18n i18n,
                           LocalStringManager localStrings,
                           org.jvnet.hk2.config.DomDocument document,
                           String commandName,
                           boolean managedJob,
                           Class<?>... extraTypes)

GenericCommandModel constructor.

Parameters:

targetType - the ConfigBeanProxy class that may have additional @Param annotations for the command,

useAnnotations - if true, use the annotations on the targetType class to define the parameters

cluster - the @ExecuteOn annotation, if any

i18n - the @I18n annotation, if any

localStrings - where to find strings for the command

document - the DomDocument for the command

commandName - the name of the command

supportsProgress - true only if command working with ProgressStatus

extraTypes - any extra types that might also define parameters for the command

Method Detail

getLocalizedDescription

public String getLocalizedDescription()

Specified by:

getLocalizedDescription in class org.glassfish.api.admin.CommandModel

getUsageText

public String getUsageText()

Specified by:

getUsageText in class org.glassfish.api.admin.CommandModel

getCommandName

public String getCommandName()

Specified by:

getCommandName in class org.glassfish.api.admin.CommandModel

getModelFor

public org.glassfish.api.admin.CommandModel.ParamModel getModelFor(String paramName)

Specified by:

getModelFor in class org.glassfish.api.admin.CommandModel

getParametersNames

public Collection<String> getParametersNames()

Specified by:

getParametersNames in class org.glassfish.api.admin.CommandModel

getCommandClass

public Class<?> getCommandClass()

Specified by:

getCommandClass in class org.glassfish.api.admin.CommandModel

getClusteringAttributes

public org.glassfish.api.admin.ExecuteOn getClusteringAttributes()

Specified by:

getClusteringAttributes in class org.glassfish.api.admin.CommandModel

add

public void add(org.glassfish.api.admin.CommandModel.ParamModel model)

Specified by:

add in class org.glassfish.api.admin.CommandModel

isManagedJob

public boolean isManagedJob()

Specified by:

isManagedJob in class org.glassfish.api.admin.CommandModel