public interface ControllerCommand extends com.ibm.websphere.command.CacheableCommand, AccCommand
WebController
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
defaultCommandClassName
Modifier and Type | Method and Description |
---|---|
boolean |
checkPermission()
Deprecated.
This method has been replaced by
ECCommand.getResources() |
void |
execute()
This method invokes the
performExecute() method of the command. |
boolean |
getGeneric()
This method gets the generic property for this command.
|
TypedProperty |
getRequestProperties()
This method gets the request properties set by the
setRequestProperties() method. |
TypedProperty |
getResolvedRequestProperties()
This method gets the resolved request properties associated with this command.
|
TypedProperty |
getResponseProperties()
This method gets the response properties associated with this command.
|
boolean |
getRetriable()
This method gets the retriable property for this command.
|
TypedProperty |
getViewInputProperties()
This method retrieves the request properties and passes them on to the view command.
|
boolean |
isGeneric()
This method checks to see whether this is a generic command.
|
boolean |
isRetriable()
This method checks to see whether this command is retriable on rollback exceptions.
|
TypedProperty |
mergeProperties(TypedProperty reqProp)
This method merges the properties passed to the request with the default properties defined in the command configuration.
|
void |
setGeneric(boolean value)
This method sets the generic property of this command.
|
void |
setRequestProperties(TypedProperty requestProperties)
This method sets the request properties.
|
void |
setRetriable(boolean value)
This method sets the retriable property for this command.
|
void |
setViewInputProperties(TypedProperty requestProperties)
This method sets the input properties to be passed to the view command.
|
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
fulfills, getOwner
static final java.lang.String COPYRIGHT
boolean checkPermission() throws ECException
ECCommand.getResources()
checkResourcePermission()
in this version.
Command writers should not implement this method but implement the getResources()
method instead.
The default implementation returns true
.true
if this user has permission to perform the operation on the resource and false
otherwise.ECException
void execute() throws ECException
performExecute()
method of the command.execute
in interface com.ibm.websphere.command.Command
execute
in interface ECCommand
ECException
boolean getGeneric()
true
if this command can be called by a generic user and false
otherwise.TypedProperty getRequestProperties()
setRequestProperties()
method.TypedProperty getResolvedRequestProperties()
Hashtable
of name/value pairs of interpreted request properties.
This method needs to be implemented for all commands that accept wild card parameter values
and where user traffic data monitoring is desired.
The command will return only the properties with expanded parameter values.TypedProperty getResponseProperties()
Hashtable
of name value pairs.
The controller command should return a view command name for returning
response data.
For example, it could contain the following properties:
EC_VIEWTASKNAME
(viewTaskName
) - The name of a view command/view task. This is a required parameter.EC_DOCPATHNAME
(docname
) - The name of a JSP
to be forwarded.EC_TEXTDOCUMENT
(textDocument
)- An InputStream
for the text document to be returned.EC_RAWDOCUMENT
(rawDocument
)- An InputStream
for the raw document to be returned.EC_REDIRECTURL
(redirecturl
) - The name of a redirect urlThe response properties are combined with any default parameters defined in the properties
column of the URL
configuration before passing on to the view command.
boolean getRetriable()
false
.true
if this command is retriable and false
otherwise.TypedProperty getViewInputProperties()
boolean isGeneric()
false
for all controller commands and true
for all view commands.true
if this command can be called by a generic user and false
otherwise.boolean isRetriable()
true
if this command is retriable and false
otherwise.TypedProperty mergeProperties(TypedProperty reqProp)
reqProp
- This is an object that represents the request input properties.void setGeneric(boolean value)
value
- This is a boolean
value; true
if the command is a generic command and false
otherwise.void setRequestProperties(TypedProperty requestProperties) throws ECException
WebController
calls this method before invoking the execute method to
set the request properties for this command.
It is the responsibility of the command writer to extract the
required input parameters from the request properties and perform parameter checking.requestProperties
- This is an object that represents the request properties.ECException
void setRetriable(boolean value)
retriable
properties in the PROPERTIES
column of the CMDREG
table, only when that entry exists in the database table, otherwise,<CommandRegistryRetriableProperty defaultValue="0" (or "false") />
is defined in
the wc-server.xml
file, then the command factory will use this setting as the default retriable configuration.value
- This is a boolean
value; true
if retriable and false
otherwise.void setViewInputProperties(TypedProperty requestProperties) throws ECException
requestProperties
- This is an object that represents the request properties.ECException