Command (OpenAS2 Server 2.10.1 API)

All Superinterfaces:

Component

All Known Implementing Classes:

AddPartnerCommand, AddPartnershipCommand, AliasedCertCommand, AliasedLoggingCommand, AliasedPartnershipsCommand, BaseCommand, ClearCertsCommand, DeleteCertCommand, DeletePartnerCommand, DeletePartnershipCommand, ImportCertCommand, ImportCertInEncodedStreamCommand, ListCertCommand, ListPartnersCommand, ListPartnershipsCommand, MultiCommand, RefreshPartnershipsCommand, SetLogLevelCommand, StorePartnershipsCommand, ViewCertCommand, ViewPartnerCommand, ViewPartnershipCommand
```
public interface Command
extends Component
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CommandResult`	`execute(java.lang.Object[] params)`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getName()`	Returns a name for the component.
`Session`	`getSession()`	Returns the Session used to initialize this Component.
`java.lang.String`	`getUsage()`
`void`	`setDescription(java.lang.String desc)`
`void`	`setName(java.lang.String name)`
`void`	`setUsage(java.lang.String usage)`

Methods inherited from interface org.openas2.Component
destroy, getParameters, init

- Method Detail
  - setDescription
```
void setDescription(java.lang.String desc)
```
  - getDescription
```
java.lang.String getDescription()
```
  - setName
```
void setName(java.lang.String name)
```
  - getName
```
java.lang.String getName()
```
    Description copied from interface: Component
    
    Returns a name for the component. These names are not guaranteed to be unique, and are intended for display and logging. Generally this is the class name of the Component object, without package information.
    
    Specified by:
    
    getName in interface Component
    
    Returns:
    
    name of the component
  - getSession
```
Session getSession()
```
    Description copied from interface: Component
    
    Returns the Session used to initialize this Component. The returned session is also used to locate other components if needed.
    
    Specified by:
    
    getSession in interface Component
    
    Returns:
    
    this component's session
  - setUsage
```
void setUsage(java.lang.String usage)
```
  - getUsage
```
java.lang.String getUsage()
```
  - execute
```
CommandResult execute(java.lang.Object[] params)
```