RestoreOriginalUserSetInSessionCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

RestoreOriginalUserSetInSessionCmdImpl
```
public interface RestoreOriginalUserSetInSessionCmd
extends ControllerCommand
```
This command is used by a user to switch their identity from a forUserId back to their original identity.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` Copyright field.
`static java.lang.String`	`defaultCommandClassName` Default command implementation class.
`static java.lang.String`	`ERRTASK_NAME` The error view that would be forwarded to, on errors.
`static java.lang.String`	`NAME` Command name.
`static java.lang.String`	`VIEW_NAME` The view that would be forwarded to on successful execution, if a URL is not defined.

Fields inherited from interface com.ibm.websphere.command.Command
serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getURL()` The URL to redirect to, on successful execution of the command.
`void`	`restoreOrginalUserId()` Switches from the forUserId, which is currently used for execution, back to the original administrative identity.

Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    Copyright field.
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    Command name.
    
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    Default command implementation class.
    
    See Also:
    
    Constant Field Values
  - VIEW_NAME
```
static final java.lang.String VIEW_NAME
```
    The view that would be forwarded to on successful execution, if a URL is not defined.
    
    See Also:
    
    Constant Field Values
  - ERRTASK_NAME
```
static final java.lang.String ERRTASK_NAME
```
    The error view that would be forwarded to, on errors.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - restoreOrginalUserId
```
void restoreOrginalUserId()
                   throws ECException
```
    Switches from the forUserId, which is currently used for execution, back to the original administrative identity.
    
    Throws:
    
    ECException - is thrown if there are any problems during this operation
  - getURL
```
java.lang.String getURL()
```
    The URL to redirect to, on successful execution of the command.
    
    Returns:
    
    The URL to redirect to on success.