com.sun.n1.sps.model.executor
Interface Target


public interface Target

This class represents the target of an execution plan run. A target is composed of up to three distinct hosts: initial, current, and physical. In the default case, all three targets are the same. The initial host is the host specified by the client. The current host is the host redirected to by the plan. The physical host is the host on which the current host is contained. Variable references are resolved relative to the current host. The plan steps are run on the physical host.


Method Summary
 Host getCurrentHost()
          Returns the current target host.
 HostID getCurrentHostID()
          Returns the ID of the current target host.
 Host getInitialHost()
          Returns the initial target host.
 HostID getInitialHostID()
          Returns the ID of the initial target host.
 Host getPhysicalHost()
          Returns the physical target host.
 HostID getPhysicalHostID()
          Returns the ID of the physical target host.
 

Method Detail

getInitialHost

Host getInitialHost()
Returns the initial target host. The initial target host is the host specified by the client as the target of the plan run. Note that all targeted configuration variable references are resolved on the initial host.

Returns:
The initial host.

getInitialHostID

HostID getInitialHostID()
Returns the ID of the initial target host. The initial target host is the host specified by the client as the target of the plan run. Note that all targeted configuration variable references are resolved on the initial host.

Returns:
The ID of the initial host.

getCurrentHost

Host getCurrentHost()
Returns the current target host. The current target host is determined via the "current" attribute of the element of the plan being run, and is expressed as relationship with the initial host. By default, the current host is the same as the initial host.

Returns:
The current host.

getCurrentHostID

HostID getCurrentHostID()
Returns the ID of the current target host. The current target host changes whenever the plan retargets any of the steps. By default, the current host is the same as the initial host.

Returns:
The ID of the current host.

getPhysicalHost

Host getPhysicalHost()
Returns the physical target host. The physical target host is the root ancestor of the current host at plan run time. The physical host is the host on which plan steps are executed.

Returns:
The physical host.

getPhysicalHostID

HostID getPhysicalHostID()
Returns the ID of the physical target host. The physical target host is the root ancestor of the actual host at plan run time. The physical host is the host on which plan steps are executed.

Returns:
The ID of the physical host.