org.jboss.com.sun.corba.se.pept.transport

Interface ContactInfo

public interface ContactInfo

The primary PEPt client-side plug-in point and enabler for altenate encodings, protocols and transports.

ContactInfo is a factory for client-side artifacts used to construct and send a message (and possibly receive and process a response).

Author:

Harold Carr

Method Summary

Methods

Modifier and Type	Method and Description
Connection	createConnection() Used to get a Connection to send and receive messages on the specific transport represented by this ContactInfo.
InputObject	createInputObject(Broker broker, MessageMediator messageMediator) Used to get a InputObject for the specific encoding represented by this ContactInfo.
MessageMediator	createMessageMediator(Broker broker, Connection connection) Used to get a MessageMediator to hold internal data for a message received using the specific encoding, protocol, transport combination represented by this ContactInfo.
MessageMediator	createMessageMediator(Broker broker, ContactInfo contactInfo, Connection connection, String methodName, boolean isOneWay) Used to get a MessageMediator to hold internal data for a message to be sent using the specific encoding, protocol, transport combination represented by this ContactInfo.
OutputObject	createOutputObject(MessageMediator messageMediator) Used to get a OutputObject for the specific encoding represented by this ContactInfo.
MessageMediator	finishCreatingMessageMediator(Broker broker, Connection connection, MessageMediator messageMediator) Used to finish creating a MessageMediator with internal data for a message received using the specific encoding, protocol, transport combination represented by this ContactInfo.
Broker	getBroker() The Broker associated with an invocation.
ClientRequestDispatcher	getClientRequestDispatcher() Used to get a ClientRequestDispatcher used to handle the specific protocol represented by this ContactInfo.
OutboundConnectionCache	getConnectionCache() Get the OutboundConnectionCache used by this ContactInfo PEPt uses separate caches for each type of ContactInfo as given by getConnectionCacheType().
String	getConnectionCacheType() PEPt uses separate caches for each type of ContactInfo as given by getConnectionCacheType.
ContactInfoList	getContactInfoList() The parent ContactInfoList for this ContactInfo .
int	hashCode() Used to lookup artifacts associated with this ContactInfo.
boolean	isConnectionBased() Used to determine if a Connection will be present in an invocation.
void	setConnectionCache(OutboundConnectionCache connectionCache) Set the OutboundConnectionCache to be used by this ContactInfo.
boolean	shouldCacheConnection() Used to determine if the Connection used for a request should be cached.

Method Detail

getBroker

Broker getBroker()

The Broker associated with an invocation.

Returns:

Broker

getContactInfoList

ContactInfoList getContactInfoList()

The parent ContactInfoList for this ContactInfo .

Returns:

ContactInfoList

getClientRequestDispatcher

ClientRequestDispatcher getClientRequestDispatcher()

Used to get a ClientRequestDispatcher used to handle the specific protocol represented by this ContactInfo.

Returns:

ClientRequestDispatcher

isConnectionBased

boolean isConnectionBased()

Used to determine if a Connection will be present in an invocation. For example, it may be false in the case of shared-memory Input/OutputObjects.

Returns:

true if a Connection will be used for an invocation.

shouldCacheConnection

boolean shouldCacheConnection()

Used to determine if the Connection used for a request should be cached. If true then PEPt will attempt to reuse an existing Connection. If one is not found it will create a new one and cache it for future use.

Returns:

true if Connections created by this ContactInfo should be cached.

getConnectionCacheType

String getConnectionCacheType()

PEPt uses separate caches for each type of ContactInfo as given by getConnectionCacheType.

Returns:

String

setConnectionCache

void setConnectionCache(OutboundConnectionCache connectionCache)

Set the OutboundConnectionCache to be used by this ContactInfo. PEPt uses separate caches for each type of ContactInfo as given by getConnectionCacheType(). setConnectionCache(org.jboss.com.sun.corba.se.pept.transport.OutboundConnectionCache) and getConnectionCache() support an optimzation to avoid hashing to find that cache.

Parameters:

connectionCache - .

getConnectionCache

OutboundConnectionCache getConnectionCache()

Get the OutboundConnectionCache used by this ContactInfo PEPt uses separate caches for each type of ContactInfo as given by getConnectionCacheType(). setConnectionCache(org.jboss.com.sun.corba.se.pept.transport.OutboundConnectionCache) and getConnectionCache() support an optimzation to avoid hashing to find that cache.

Returns:

ConnectionCache

createConnection

Connection createConnection()

Used to get a Connection to send and receive messages on the specific transport represented by this ContactInfo.

Returns:

Connection

createMessageMediator

MessageMediator createMessageMediator(Broker broker,
                                    ContactInfo contactInfo,
                                    Connection connection,
                                    String methodName,
                                    boolean isOneWay)

Used to get a MessageMediator to hold internal data for a message to be sent using the specific encoding, protocol, transport combination represented by this ContactInfo.

Returns:

MessageMediator

createMessageMediator

MessageMediator createMessageMediator(Broker broker,
                                    Connection connection)

Used to get a MessageMediator to hold internal data for a message received using the specific encoding, protocol, transport combination represented by this ContactInfo.

Returns:

MessageMediator

finishCreatingMessageMediator

MessageMediator finishCreatingMessageMediator(Broker broker,
                                            Connection connection,
                                            MessageMediator messageMediator)

Used to finish creating a MessageMediator with internal data for a message received using the specific encoding, protocol, transport combination represented by this ContactInfo.

Returns:

MessageMediator

createInputObject

InputObject createInputObject(Broker broker,
                            MessageMediator messageMediator)

Used to get a InputObject for the specific encoding represented by this ContactInfo.

Returns:

InputObject

createOutputObject

OutputObject createOutputObject(MessageMediator messageMediator)

Used to get a OutputObject for the specific encoding represented by this ContactInfo.

Returns:

OutputObject

hashCode

int hashCode()

Used to lookup artifacts associated with this ContactInfo.

Overrides:

hashCode in class Object

Returns:

the hash value.