Package com.ibm.websphere.command

Class TargetPolicyDefault

java.lang.Object
com.ibm.websphere.command.TargetPolicyDefault
All Implemented Interfaces:
TargetPolicy, Serializable
public class TargetPolicyDefault extends Object implements TargetPolicy, Serializable
The TargetPolicyDefault class provides an implementation of the TargetPolicy interface. It provides serveral way to specify the target for a command, and it implements an evaluation routine for retrieving the target in its implementation of the getCommandTarget() method.

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.

  1. If the command contains a target object, use it.
  2. If the command contains a name for a target, use it.
  3. If there is a mapping registered on the TargetPolicyDefault object between the command and a target, use it.
  4. If there is a default target name defined on the TargetPolicyDefault object, use it.
  5. Return null if no target can be found.

The class sets the default target name to the LocalTarget class.

See Also:

  • Constructor Details

    • TargetPolicyDefault

      public TargetPolicyDefault()

  • Method Details

    • 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.
      1. If the command contains a target object, use it.
      2. If the command contains a name for a target, use it.
      3. If there is a mapping registered on the TargetPolicyDefault object between the command and a target, use it.
      4. If there is a default target name defined on the TargetPolicyDefault object, use it.
      5. 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 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(String commandBeanName, 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(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(String commandBeanName)
      Unregisters a single command-to-target mapping.
      Parameters:
      commandBeanName - The name of the command.