com.ibm.websphere.command
Class TargetPolicyDefault
- java.lang.Object
com.ibm.websphere.command.TargetPolicyDefault
All implemented interfaces:
TargetPolicy, java.io.Serializable
- public class TargetPolicyDefault
- extends java.lang.Object
- implements TargetPolicy, java.io.Serializable
The TargetPolicyDefault class allows a client to set the target of a command in several ways:
- The target can be set directly on the command by using the setCommandTarget() method in the TargetableCommand interface.
- The name of the target can be set directly on the command by using the setCommandTargetName() method on the TargetableCommand interface.
- A command can be mapped to a target using the local registerCommand() method. The TargetPolicyDefault class also provides methods for managing these mappings.
- A default target can be established by using the local setDefaultTargetName() method.
The getCommandTarget() method implements the following ordered steps for determining the target that to be returned for a given command. The getCommandTarget() method stops when it finds a target.
- If the command contains a target object, use it.
- If the command contains a name for a target, use it.
- If there is a mapping registered on the TargetPolicyDefault object between the command and a target, use it.
- If there is a default target name defined on the TargetPolicyDefault object, use it.
- Return null if no target can be found.
The class sets the default target name to the LocalTarget class.
See Also:
Field Summary
Modifier and Type | Field and Description |
---|---|
|
defaultTarget
The default target object, used if no other target is found.
|
|
defaultTargetName
The default target name, used if no other target is found.
|
|
mapping
Contains the registered mappings between commands and targets.
|
|
targetTable
Contains active targets.
|
Constructor Summary
Constructor and Description |
---|
TargetPolicyDefault()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
getCommandTarget(TargetableCommand command)
The getCommandTarget() method implements the method in the TargetPolicy
interface.
|
|
|
listMappings()
Lists all the command-to-target mappings.
|
|
registerCommand(java.lang.String commandBeanName,java.lang.String targetBeanName)
Registers a single command-to-target mapping.
|
|
setDefaultTargetName(java.lang.String defaultTargetName)
Sets the default target name, used if no other target is found.
|
|
unregisterCommand(java.lang.String commandBeanName)
Unregisters a single command-to-target mapping.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail
mapping
- protected java.util.Dictionary mapping
Contains the registered mappings between commands and targets.
The key is the name of the command; the value is the name of the target.
targetTable
- protected java.util.Hashtable targetTable
Contains active targets.
The key is the name of the target; the value is the target object.
defaultTargetName
- protected java.lang.String defaultTargetName
The default target name, used if no other target is found.
defaultTarget
- protected transient CommandTarget defaultTarget
The default target object, used if no other target is found.
Constructor Detail
TargetPolicyDefault
- public TargetPolicyDefault()
Method Detail
getCommandTarget
- public CommandTarget getCommandTarget( TargetableCommand command)
The getCommandTarget() method implements the method in the TargetPolicy
interface. This implementation uses the following ordered steps
for determining the target that to be returned for a given command.
It stops when it finds a target.
- If the command contains a target object, use it.
- If the command contains a name for a target, use it.
- If there is a mapping registered on the TargetPolicyDefault object between the command and a target, use it.
- If there is a default target name defined on the TargetPolicyDefault object, use it.
- Return null if no target can be found.
Specified by:
getCommandTarget
in interface TargetPolicy
Parameters:
command
- The TargetableCommand whose CommandTarget is needed. Returns:
The CommandTarget for the command.
listMappings
- public java.util.Dictionary listMappings( )
Lists all the command-to-target mappings.
Returns:
A Dictionary of mappings between command names and target names.
The key is the name of the command; the value is the name of the target.
registerCommand
- public void registerCommand(java.lang.String commandBeanName,
- java.lang.String targetBeanName)
Registers a single command-to-target mapping.
Parameters:
commandBeanName
- The name of the command. targetBeanName
- The name of the target. setDefaultTargetName
- public void setDefaultTargetName( java.lang.String defaultTargetName)
Sets the default target name, used if no other target is found.
This implementation uses the LocalTarget class as the default
target name.
Parameters:
defaultTargetName
- The name of the default target. unregisterCommand
- public void unregisterCommand(java.lang.String commandBeanName)
Unregisters a single command-to-target mapping.
Parameters:
commandBeanName
- The name of the command.