public abstract class BaseCommand extends BaseComponent implements Command
Modifier and Type | Field and Description |
---|---|
static String |
PARAM_DESCRIPTION |
static String |
PARAM_NAME |
static String |
PARAM_USAGE |
Constructor and Description |
---|
BaseCommand() |
Modifier and Type | Method and Description |
---|---|
abstract CommandResult |
execute(Object[] params) |
abstract String |
getDefaultDescription() |
abstract String |
getDefaultName() |
abstract String |
getDefaultUsage() |
String |
getDescription() |
String |
getName()
Returns a name for the component.
|
String |
getUsage() |
void |
init(Session session,
Map<String,String> parameters)
Component lifecycle hook.
|
void |
setDescription(String desc) |
void |
setName(String name) |
void |
setUsage(String usage) |
destroy, getParameter, getParameter, getParameterInt, getParameters, getSession, setParameter, setParameter
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getSession
destroy, getParameters
public static final String PARAM_NAME
public static final String PARAM_DESCRIPTION
public static final String PARAM_USAGE
public void init(Session session, Map<String,String> parameters) throws OpenAS2Exception
Component
init
in interface Component
init
in class BaseComponent
session
- the component uses this object to access other componentsparameters
- configuration values for the componentOpenAS2Exception
- If an error occurs while initializing the componentSession
public String getDescription()
getDescription
in interface Command
public void setDescription(String desc)
setDescription
in interface Command
public String getName()
Component
public abstract String getDefaultName()
public abstract String getDefaultDescription()
public abstract String getDefaultUsage()
public abstract CommandResult execute(Object[] params)
Copyright © 2018. All rights reserved.