gov.cca
Interface ConnectionInfo


public interface ConnectionInfo

This interface abstracts the information needed to understand the topology and status of a connection within the local context. This deliberately does not expose information about direct vs proxy aspects, network status, etc as those are implementation specific. This does not have anything to do with multiplex connections, as in the multiplex, this interface will characterize any single line.


Method Summary
 ComponentID getProvider()
           
 java.lang.String getProviderPortName()
           
 ComponentID getUser()
           
 java.lang.String getUserPortName()
           
 boolean isInUse()
           
 

Method Detail

getUser

ComponentID getUser()
Returns:
The id of the "caller" component in the connection.

getUserPortName

java.lang.String getUserPortName()
Returns:
The name of the port used in the "caller" component.

getProvider

ComponentID getProvider()
Returns:
The id of the "callee" component in the connection.

getProviderPortName

java.lang.String getProviderPortName()
Returns:
The name of the port provided in the "callee" component.

isInUse

boolean isInUse()
Returns:
true if the using component has an unreleased getPort(getUserPortName()); meaning this connection may be in use.