com.sun.n1.sps.model.component
Interface TargetRef


public interface TargetRef

A TargetRef provides a means of connecting targetable components to their associated hosts.


Method Summary
 ConnectionType getConnection()
          Returns the connection type.
 Component getDeclaringComponent()
          Returns the targetable component that uses this TargetRef to connect it to a host.
 java.lang.String getHostName()
          Returns the name of the associated host.
 java.lang.String getIPAddr()
          Returns the IP address or null if the target is a virtual host.
 java.lang.String getPort()
          Returns the port or null if target is a virtual host.
 java.lang.String getTypeName()
          Returns the type of the associated host.
 boolean isVirtual()
          Determines if the associated host is a virtual host.
 

Method Detail

getHostName

java.lang.String getHostName()
Returns the name of the associated host.

Returns:
hostname as String

getTypeName

java.lang.String getTypeName()
Returns the type of the associated host.

Returns:
host type as String.

getConnection

ConnectionType getConnection()
Returns the connection type. Returns null if the target is a virtual host, or if this TargetRef has not been generated.

Returns:
The connection type enumerated value.

getIPAddr

java.lang.String getIPAddr()
Returns the IP address or null if the target is a virtual host.

Returns:
IP address as String.

getPort

java.lang.String getPort()
Returns the port or null if target is a virtual host.

Returns:
port as String.

isVirtual

boolean isVirtual()
Determines if the associated host is a virtual host.

Returns:
True if referant host is virtual, false otherwise.

getDeclaringComponent

Component getDeclaringComponent()
Returns the targetable component that uses this TargetRef to connect it to a host.

Returns:
The component that is associated with this TargetRef.