|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.emf.common.command.AbstractCommand
com.ibm.websphere.management.cmdframework.provider.AbstractAdminCommand
public abstract class AbstractAdminCommand
The class is the base class for any admin command implementation. Any specific admin command implementation should derive from this class and only override the methods that javadoc recommends to override.
Nested Class Summary | |
---|---|
class |
AbstractAdminCommand.CmdNotificationListener
|
Nested classes/interfaces inherited from class org.eclipse.emf.common.command.AbstractCommand |
---|
org.eclipse.emf.common.command.AbstractCommand.NonDirtying |
Field Summary | |
---|---|
static java.lang.String |
ASYNC_CUSTOM_TAG
|
protected com.ibm.ws.management.cmdframework.impl.TaskCommandSession |
asyncCmdSession
|
protected java.lang.Integer |
cmdMgrType
|
protected com.ibm.websphere.management.cmdframework.provider.CmdNotificationHandler |
cnh
|
static java.lang.String |
DYNAMIC_CUSTOM_TAG
|
protected java.util.HashMap<java.lang.Integer,java.util.Collection<java.lang.String>> |
listSetParamsTable
|
static java.lang.String |
PRIVATE_CUSTOM_TAG
|
Fields inherited from class org.eclipse.emf.common.command.AbstractCommand |
---|
description, isExecutable, isPrepared, label |
Constructor Summary | |
---|---|
AbstractAdminCommand(com.ibm.websphere.management.cmdframework.commanddata.CommandData inCommandData)
Constructs an instance of admin command based on its command data |
|
AbstractAdminCommand(com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata metadata)
|
Method Summary | |
---|---|
void |
cleanupUploadedFiles()
|
protected org.eclipse.emf.ecore.EObject |
createParamEObject()
Create an EObject to store the command's parameter values. |
com.ibm.websphere.management.cmdframework.commandmetadata.ParameterMetadata |
createParameterMetadata(java.lang.String pmName,
java.util.Hashtable featureList)
Create a ParameterMetadata object. |
abstract void |
execute()
Defines the execution logic of command. |
void |
execute(CommandHistory cmdHistory)
Executes the command and puts the command data into the command history. |
java.lang.String |
generateScript(java.lang.String lang)
Generates the corresponding wsadmin script for the specified scripting language. |
java.lang.Object[] |
getChoices(java.lang.String paramName)
Provides a default implement for the method which always returns null. |
java.lang.Integer |
getCmdMgrType()
|
protected com.ibm.websphere.management.cmdframework.commanddata.CommandData |
getCommandData()
|
com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata |
getCommandMetadata()
Returns the meta data for the command. |
static com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata |
getCommandMetadata(java.lang.String cmdName)
|
CommandResult |
getCommandResult()
Return a more user friendly version of command result. |
com.ibm.ws.management.cmdframework.impl.TaskCommandSession |
getCommandSession()
Creates and returns the unique identifier for this command instance. |
protected ConfigService |
getConfigService()
Convenient method to access ConfigService component. |
Session |
getConfigSession()
Returns user's config session. |
java.util.Locale |
getLocale()
return the user's locale. |
java.lang.String |
getName()
Returns a non-localized admin command name. |
java.lang.Object |
getOrigParameterValue(java.lang.String paramName)
Gets the original parameter value for the UploadFile or DownloadFile parameter. |
java.lang.Object |
getParameter(java.lang.String parameterName)
Gets the parameter value for the specified parameter. |
protected java.lang.Object |
getParameter(java.lang.String parameterName,
int rowIndex)
|
protected com.ibm.websphere.management.cmdframework.commandmetadata.ParameterMetadata |
getParameterMetadata(java.lang.String paramName)
returns the metadata for the specified parameter. |
java.util.Collection |
getResult()
Provides a default implementation for this method. |
java.lang.Object |
getTargetObject()
Returns the target object of the command. |
java.lang.Object[] |
getTargetObjectChoices()
Provides a default implement for the method which always returns null. |
protected com.ibm.websphere.management.cmdframework.commanddata.UserData |
getUserData()
Gets the user data for the command data. |
protected com.ibm.websphere.management.cmdframework.commanddata.CommandData |
initCommandData()
Construct proper type of command data instance. |
protected void |
initializeParameter(java.lang.String paramName,
java.lang.Object value)
|
protected void |
initializeParameter(java.lang.String paramName,
java.lang.Object value,
int rowIndex)
|
boolean |
isAsyncCommand()
Check if it is an async command, which is specified by command provider. |
boolean |
isDynamicStepCommand()
Check if it is a dynamic step command, which is specified by command provider. |
protected boolean |
isLocalMode()
|
protected boolean |
isParamReadonly(java.lang.String paramName)
|
boolean |
isPrivateParameter(java.lang.String paramName)
Check if it is a private parameter, which is specified by command provider. |
protected boolean |
isTable()
|
java.util.List |
listAllParameterName()
Returns all the parameter names including private one on the ParameterMetadata objects. |
java.util.List |
listParameterName()
Returns parameter names that are not private on the ParameterMetadata objects. |
java.util.Collection |
listSetParams()
Gets all the command parameters whose value are set. |
protected java.util.Collection |
listSetParams(int rowIndex)
|
void |
redo()
|
void |
resetCommandData(com.ibm.websphere.management.cmdframework.commanddata.CommandData cmdData)
Resets the command data for the command. |
protected void |
resetCommandMetadata(com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata newMetadata)
|
void |
save(java.io.OutputStream outputStream)
Serializes the command into the specified output stream. |
void |
sendNotification(CommandNotification cmdNotification)
|
void |
setCmdHandler(com.ibm.websphere.management.cmdframework.provider.CmdNotificationHandler handler)
Set the handler to handle command notifications |
void |
setCmdMgrType(java.lang.Integer cmdMgrType)
|
protected void |
setCommandMetadata(com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata cmdmetadata)
|
protected void |
setCommandResult(CommandResult thisResult)
|
void |
setCommandSession(com.ibm.ws.management.cmdframework.impl.TaskCommandSession session)
|
void |
setConfigSession(Session session)
Sets the user's config session. |
protected void |
setListSetParamsTable(int rowIndex,
java.lang.String paramName)
|
void |
setLocale(java.util.Locale locale)
Sets the caller's locale. |
void |
setOrigParameterValue(java.lang.String paramName,
java.lang.Object value)
Sets the original value for the UploadFile or DownloadFile parameter. |
void |
setParameter(java.lang.String paramName,
java.lang.Object value)
Sets the value for the specified parameter. |
protected void |
setParameter(java.lang.String paramName,
java.lang.Object value,
int rowIndex)
|
void |
setTargetObject(java.lang.Object obj)
Sets the target object for the command. |
protected void |
setupListener(java.lang.Object obj)
|
void |
validate()
Providers a default implmentation for the method. |
Methods inherited from class org.eclipse.emf.common.command.AbstractCommand |
---|
canExecute, canUndo, chain, dispose, getAffectedObjects, getDescription, getLabel, prepare, setDescription, setLabel, toString, undo |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.emf.common.command.Command |
---|
canExecute, canUndo, chain, dispose, getAffectedObjects, getDescription, getLabel, undo |
Field Detail |
---|
public static final java.lang.String ASYNC_CUSTOM_TAG
public static final java.lang.String DYNAMIC_CUSTOM_TAG
public static final java.lang.String PRIVATE_CUSTOM_TAG
protected com.ibm.websphere.management.cmdframework.provider.CmdNotificationHandler cnh
protected com.ibm.ws.management.cmdframework.impl.TaskCommandSession asyncCmdSession
protected java.lang.Integer cmdMgrType
protected java.util.HashMap<java.lang.Integer,java.util.Collection<java.lang.String>> listSetParamsTable
Constructor Detail |
---|
public AbstractAdminCommand(com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata metadata)
public AbstractAdminCommand(com.ibm.websphere.management.cmdframework.commanddata.CommandData inCommandData) throws CommandNotFoundException
inCommandData
- the command data for the command
CommandNotFoundException
- if the command is not found.Method Detail |
---|
public static com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata getCommandMetadata(java.lang.String cmdName) throws CommandNotFoundException
CommandNotFoundException
protected com.ibm.websphere.management.cmdframework.commanddata.CommandData initCommandData()
public java.util.Locale getLocale()
AdminCommand
getLocale
in interface AdminCommand
public void setLocale(java.util.Locale locale)
AdminCommand
setLocale
in interface AdminCommand
locale
- the caller's Locale.public java.lang.String getName()
AdminCommand
getName
in interface AdminCommand
public com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata getCommandMetadata()
AdminCommand
getCommandMetadata
in interface AdminCommand
protected com.ibm.websphere.management.cmdframework.commanddata.CommandData getCommandData()
protected void setCommandMetadata(com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata cmdmetadata)
public java.lang.Object getTargetObject()
AdminCommand
getTargetObject
in interface AdminCommand
public void setTargetObject(java.lang.Object obj) throws InvalidParameterValueException
AdminCommand
setTargetObject
in interface AdminCommand
obj
- the target object value
InvalidParameterValueException
public java.util.Collection listSetParams()
AdminCommand
listSetParams
in interface AdminCommand
protected java.util.Collection listSetParams(int rowIndex)
public java.lang.Object getParameter(java.lang.String parameterName) throws InvalidParameterNameException
AdminCommand
getParameter
in interface AdminCommand
parameterName
- the parameter name.
InvalidParameterNameException
public boolean isAsyncCommand()
AdminCommand
isAsyncCommand
in interface AdminCommand
public boolean isDynamicStepCommand()
AdminCommand
isDynamicStepCommand
in interface AdminCommand
public boolean isPrivateParameter(java.lang.String paramName) throws InvalidParameterNameException
AdminCommand
isPrivateParameter
in interface AdminCommand
paramName
- is the name of parameter.
InvalidParameterNameException
- if user specified an invalid parameter name.public java.util.List listAllParameterName()
AdminCommand
ParameterMetadata
objects.
listAllParameterName
in interface AdminCommand
public java.util.List listParameterName()
AdminCommand
ParameterMetadata
objects.
listParameterName
in interface AdminCommand
protected java.lang.Object getParameter(java.lang.String parameterName, int rowIndex) throws InvalidParameterNameException
InvalidParameterNameException
public void setParameter(java.lang.String paramName, java.lang.Object value) throws InvalidParameterValueException, InvalidParameterNameException
AdminCommand
setParameter
in interface AdminCommand
paramName
- the parameter name.value
- the parameter value.
InvalidParameterValueException
- if the parameter value is not valid.
InvalidParameterNameException
public void setOrigParameterValue(java.lang.String paramName, java.lang.Object value) throws InvalidParameterValueException, InvalidParameterNameException
AdminCommand
UploadFile
or DownloadFile
parameter.
setOrigParameterValue
in interface AdminCommand
paramName
- the parameter name.value
- the parameter value.
InvalidParameterValueException
- if the parameter value is not valid.
InvalidParameterNameException
public java.lang.Object getOrigParameterValue(java.lang.String paramName) throws InvalidParameterNameException
AdminCommand
UploadFile
or DownloadFile
parameter.
getOrigParameterValue
in interface AdminCommand
paramName
- the parameter name.
InvalidParameterNameException
protected void initializeParameter(java.lang.String paramName, java.lang.Object value) throws InvalidParameterValueException, InvalidParameterNameException
InvalidParameterValueException
InvalidParameterNameException
protected void setParameter(java.lang.String paramName, java.lang.Object value, int rowIndex) throws InvalidParameterValueException, InvalidParameterNameException
InvalidParameterValueException
InvalidParameterNameException
protected void initializeParameter(java.lang.String paramName, java.lang.Object value, int rowIndex) throws InvalidParameterValueException, InvalidParameterNameException
InvalidParameterValueException
InvalidParameterNameException
protected void setListSetParamsTable(int rowIndex, java.lang.String paramName)
protected boolean isTable()
public java.lang.Object[] getChoices(java.lang.String paramName)
getChoices
in interface AdminCommand
paramName
- the parameter name.
public java.lang.Object[] getTargetObjectChoices()
getTargetObjectChoices
in interface AdminCommand
public void validate() throws CommandValidationException
validate
in interface AdminCommand
CommandValidationException
public void setConfigSession(Session session)
AdminCommand
setConfigSession
in interface AdminCommand
session
- the user's admin session.public Session getConfigSession()
AdminCommand
getConfigSession
in interface AdminCommand
public CommandResult getCommandResult()
AdminCommand
getCommandResult
in interface AdminCommand
protected void setCommandResult(CommandResult thisResult)
public void save(java.io.OutputStream outputStream)
AdminCommand
save
in interface AdminCommand
outputStream
- the output stream that is used to serialize the command
datapublic abstract void execute()
execute
in interface org.eclipse.emf.common.command.Command
public void execute(CommandHistory cmdHistory)
AdminCommand
execute
in interface AdminCommand
cmdHistory
- an implementation of command historypublic void setCommandSession(com.ibm.ws.management.cmdframework.impl.TaskCommandSession session)
public com.ibm.ws.management.cmdframework.impl.TaskCommandSession getCommandSession()
public void setCmdHandler(com.ibm.websphere.management.cmdframework.provider.CmdNotificationHandler handler)
AdminCommand
setCmdHandler
in interface AdminCommand
handler
- handler for command notificationprotected void setupListener(java.lang.Object obj)
public java.util.Collection getResult()
getResult
in interface org.eclipse.emf.common.command.Command
getResult
in class org.eclipse.emf.common.command.AbstractCommand
public void sendNotification(CommandNotification cmdNotification)
public void redo()
redo
in interface org.eclipse.emf.common.command.Command
public void cleanupUploadedFiles()
protected org.eclipse.emf.ecore.EObject createParamEObject() throws CommandNotFoundException
CommandNotFoundException
protected com.ibm.websphere.management.cmdframework.commanddata.UserData getUserData()
public void resetCommandData(com.ibm.websphere.management.cmdframework.commanddata.CommandData cmdData)
cmdData
- the new command data.protected void resetCommandMetadata(com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata newMetadata)
public java.lang.String generateScript(java.lang.String lang) throws CommandException
AdminCommand
generateScript
in interface AdminCommand
lang
- the name of the scripting language.
CommandException
- if user specified scripting language is not supported.
XXX todo: more specific exception.protected com.ibm.websphere.management.cmdframework.commandmetadata.ParameterMetadata getParameterMetadata(java.lang.String paramName) throws InvalidParameterNameException
paramName
- name of parameter
InvalidParameterNameException
protected boolean isLocalMode()
public void setCmdMgrType(java.lang.Integer cmdMgrType)
public java.lang.Integer getCmdMgrType()
protected boolean isParamReadonly(java.lang.String paramName) throws InvalidParameterNameException
InvalidParameterNameException
protected ConfigService getConfigService()
public com.ibm.websphere.management.cmdframework.commandmetadata.ParameterMetadata createParameterMetadata(java.lang.String pmName, java.util.Hashtable featureList) throws InvalidParameterValueException, InvalidParameterNameException
AdminCommand
createParameterMetadata
in interface AdminCommand
pmName
- is the name of ParameterMetadata.featureList
- is a Hashtable of ParameterMetadata features (attributes) in feature id - value pair.
CommandMetadataPackage.PARAMETER_METADATA
for list of available features for PARAMETER_METADATA.
InvalidParameterValueException
- if the feature (attribute) value type is incorrect.
InvalidParameterNameException
- if the feature (attribute) id is invalid.BaseMetadata
,
ParameterMetadata
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |