ContractDeployCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.scheduler.commands.AddJobCmdImpl
      - com.ibm.commerce.contract.commands.ContractDeployCmdImpl

All Implemented Interfaces:: AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, ContractDeployCmd, AddJobCmd, Protectable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class ContractDeployCmdImpl
extends AddJobCmdImpl
implements ContractDeployCmd

This is the default implementation of the ContractDeployCmd controller command.

Input parameters:

Name	Description
`contractId`	The contract ID. It is mandatory.
`targetStoreId`	The target store ID for `deploying` contract. It is mandatory.
`URL`	the redirect URL after the command be executed successfully.It is mandatory.

Output parameters:

None.

Behavior:

Deploys the specified contract to the specified store (WebSphere Commerce Enterprise only). If the contract is expired, an exception will be thrown. If a referenced policy is not available, an exception will be thrown. If a referenced policy is expired, an exception will be thrown.

Task command called:

ValidateBusinessPolicyInContractForStoreCmd

Access Beans used:

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASSNAME
The full name of this class.

static java.lang.String COPYRIGHT
The IBM copyright notice field.
- Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
  requestProperties, responseProperties, retriable, viewReqProperties
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.contract.commands.ContractDeployCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID
- Fields inherited from interface com.ibm.commerce.scheduler.commands.AddJobCmd
  defaultCommandClassName, NAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASSNAME` The full name of this class.
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

ContractDeployCmdImpl()
The constructor of this class

Constructors
Constructor and Description
`ContractDeployCmdImpl()` The constructor of this class

Method Summary

Methods
Modifier and Type	Method and Description
`AccessVector`	`getResources()` Gets the access vector accessed by this command.
`java.lang.String`	`getScheduledCommandName()` Gets the scheduled command name
`java.lang.String`	`getUrlName()` Gets the redirect URL
`void`	`performExecute()` Executes the business logic of this command implementation.
`void`	`setContractId(java.lang.Long contractId)` Sets the contract ID parameter
`void`	`setPropertiesForScheduler()` Sets the properties for scheduler
`void`	`setRequestProperties(TypedProperty aRequestProperties)` Sets the request properties of this command implementation.
`void`	`validateParameters()` Extracts and validates the input parameters of this command implementation.

Methods inherited from class com.ibm.commerce.scheduler.commands.AddJobCmdImpl
convertTime, getApplicationType, getAttempts, getCheckCommandId, getDelay, getEndTime, getErrorUrl, getHost, getInterfaceName, getInterval, getJobId, getJobInstanceId, getName, getPathInfo, getPriority, getQueryString, getSequence, getStartTime, getStoreId, getStringEndTime, getStringStartTime, getUrl, getUserRefNum, setApplicationType, setAttempts, setCheckCommandId, setDelay, setEndTime, setErrorUrl, setHost, setInterfaceName, setInterval, setJobId, setJobInfo, setName, setPathInfo, setPriority, setQueryString, setSequence, setStartTime, setStoreId, setStringEndTime, setStringStartTime, setUrl, setUserRefNum

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, 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, 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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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
```
public static final java.lang.String COPYRIGHT
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - CLASSNAME
```
public static final java.lang.String CLASSNAME
```
    The full name of this class.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ContractDeployCmdImpl
```
public ContractDeployCmdImpl()
```
    The constructor of this class
- Method Detail
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    Gets the access vector accessed by this command. The default implementation returns null indicating that no protectable resource is accessed by this command. It is the responsibilities of the command writer to return the protectable primary resource(s) and the corresponding actions accessed by this command.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AddJobCmdImpl
    
    Returns:
    
    a vector of resource action pairs
    
    Throws:
    
    ECException
    
    See Also:
    
    AccessVector
  - getScheduledCommandName
```
public java.lang.String getScheduledCommandName()
```
    Gets the scheduled command name
    
    Returns:
    
    scheduled command name
  - getUrlName
```
public java.lang.String getUrlName()
```
    Gets the redirect URL
    
    Returns:
    
    redirect URL
  - performExecute
```
public void performExecute()
                    throws ECException
```
    Executes the business logic of this command implementation.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AddJobCmdImpl
    
    Throws:
    
    ECException - Raised with message _ERR_CONTRACT_SYS_GENERIC whenever an error was occured
    
    See Also:
    
    AddJobCmdImpl.performExecute()
  - setContractId
```
public void setContractId(java.lang.Long contractId)
```
    Sets the contract ID parameter
    
    Specified by:
    
    setContractId in interface ContractDeployCmd
    
    Parameters:
    
    contractId - Contract ID
  - setPropertiesForScheduler
```
public void setPropertiesForScheduler()
```
    Sets the properties for scheduler
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
```
    Sets the request properties of this command implementation.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class AddJobCmdImpl
    
    Parameters:
    
    aRequestProperties - Request Properties name-value pairs are: redirect URL, contract Id and target store Id. They are all required.
    
    Throws:
    
    ECApplicationException - Raised with message _ERR_MISSING_CMD_PARAMETER if contract Id or store Id was not found. Raised with message _ERR_NUMBER_FORMAT_EXCEPTION if contract Id or store Id is not in the correct format (number).
    
    See Also:
    
    AddJobCmdImpl.setRequestProperties(TypedProperty)
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    Extracts and validates the input parameters of this command implementation.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AddJobCmdImpl
    
    Throws:
    
    ECApplicationException - Raised with message _ERR_CONTRACT_ALREADY_DEPLOY_TO_THE_STORE if the contract has been deployed to the store. Raised with message _ERR_WRONG_CONTRACT_STATE if the contract is not in the desired state (normally, a Draft and Deploy Failed contract can be deployed). Raised with message _ERR_CONTRACT_EXPIRED if the contract is expired. Raised with message _ERR_INVALID_CONTRACT_EXPIRED_DATE if the expiration date of the contract is invalid. Raised with message _ERR_CONTRACT_SYS_GENERIC when other unknown error occurs.
    
    ECException
    
    See Also:
    
    AddJobCmdImpl.validateParameters()

Class ContractDeployCmdImpl

Input parameters:

Output parameters:

Behavior:

Task command called:

Access Beans used:

Field Summary

Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.contract.commands.ContractDeployCmd

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

Fields inherited from interface com.ibm.commerce.scheduler.commands.AddJobCmd

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.scheduler.commands.AddJobCmdImpl

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

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

Methods inherited from interface com.ibm.commerce.command.AccCommand

Methods inherited from interface com.ibm.commerce.command.ECCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.commerce.security.Protectable

Field Detail

COPYRIGHT

CLASSNAME

Constructor Detail

ContractDeployCmdImpl

Method Detail

getResources

getScheduledCommandName

getUrlName

performExecute

setContractId

setPropertiesForScheduler

setRequestProperties

validateParameters