FileDocCategorySizeDatePackage
ContactInfo.javaAPI DocJava SE 5 API7367Fri Aug 26 14:54:34 BST 2005com.sun.corba.se.pept.transport

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

Fields Summary
Constructors Summary
Methods Summary
public com.sun.corba.se.pept.transport.ConnectioncreateConnection()
Used to get a {@link com.sun.corba.se.pept.transport.Connection Connection} to send and receive messages on the specific transport represented by this ContactInfo.

return
{@link com.sun.corba.se.pept.transport.Connection Connection}

public com.sun.corba.se.pept.encoding.InputObjectcreateInputObject(com.sun.corba.se.pept.broker.Broker broker, com.sun.corba.se.pept.protocol.MessageMediator messageMediator)
Used to get a {@link com.sun.corba.se.pept.encoding.InputObject InputObject} for the specific encoding represented by this ContactInfo.

return
{@link com.sun.corba.se.pept.encoding.InputObject InputObject}

public com.sun.corba.se.pept.protocol.MessageMediatorcreateMessageMediator(com.sun.corba.se.pept.broker.Broker broker, com.sun.corba.se.pept.transport.ContactInfo contactInfo, com.sun.corba.se.pept.transport.Connection connection, java.lang.String methodName, boolean isOneWay)
Used to get a {@link com.sun.corba.se.pept.protocol.MessageMeidator MessageMediator} to hold internal data for a message to be sent using the specific encoding, protocol, transport combination represented by this ContactInfo.

return
{@link com.sun.corba.se.pept.protocol.MessageMediator MessageMediator}

public com.sun.corba.se.pept.protocol.MessageMediatorcreateMessageMediator(com.sun.corba.se.pept.broker.Broker broker, com.sun.corba.se.pept.transport.Connection connection)
Used to get a {@link com.sun.corba.se.pept.protocol.MessageMeidator MessageMediator} to hold internal data for a message received using the specific encoding, protocol, transport combination represented by this ContactInfo.

return
{@link com.sun.corba.se.pept.protocol.MessageMeidator MessageMediator}

public com.sun.corba.se.pept.encoding.OutputObjectcreateOutputObject(com.sun.corba.se.pept.protocol.MessageMediator messageMediator)
Used to get a {@link com.sun.corba.se.pept.encoding.OutputObject OutputObject} for the specific encoding represented by this ContactInfo.

return
{@link com.sun.corba.se.pept.encoding.OutputObject OutputObject}

public com.sun.corba.se.pept.protocol.MessageMediatorfinishCreatingMessageMediator(com.sun.corba.se.pept.broker.Broker broker, com.sun.corba.se.pept.transport.Connection connection, com.sun.corba.se.pept.protocol.MessageMediator messageMediator)
Used to finish creating a {@link com.sun.corba.se.pept.protocol.MessageMeidator MessageMediator} with internal data for a message received using the specific encoding, protocol, transport combination represented by this ContactInfo.

return
{@link com.sun.corba.se.pept.protocol.MessageMediator MessageMediator}

public com.sun.corba.se.pept.broker.BrokergetBroker()
The {@link com.sun.corba.se.pept.broker.Broker Broker} associated with an invocation.

return
{@link com.sun.corba.se.pept.broker.Broker Broker}

public com.sun.corba.se.pept.protocol.ClientRequestDispatchergetClientRequestDispatcher()
Used to get a {@link com.sun.corba.se.pept.protocol.ClientRequestDispatcher ClientRequestDispatcher} used to handle the specific protocol represented by this ContactInfo.

return
{@link com.sun.corba.se.pept.protocol.ClientRequestDispatcher ClientRequestDispatcher}

public com.sun.corba.se.pept.transport.OutboundConnectionCachegetConnectionCache()
Get the {@link com.sun.corba.se.pept.transport.Outbound.ConnectionCache OutboundConnectionCache} used by this ContactInfo PEPt uses separate caches for each type of ContactInfo as given by {@link #getConnectionCacheType}. {@link #setConnectionCache} and {@link #getConnectionCache} support an optimzation to avoid hashing to find that cache.

return
{@link com.sun.corba.se.pept.transport.ConnectionCache ConnectionCache}

public java.lang.StringgetConnectionCacheType()
PEPt uses separate caches for each type of ContactInfo as given by getConnectionCacheType.

return
{@link java.lang.String}

public com.sun.corba.se.pept.transport.ContactInfoListgetContactInfoList()
The parent {@link com.sun.corba.se.pept.broker.ContactInfoList ContactInfoList} for this ContactInfo.

return
{@link com.sun.corba.se.pept.broker.ContactInfoList ContactInfoList}

public inthashCode()
Used to lookup artifacts associated with this ContactInfo.

return
the hash value.

public booleanisConnectionBased()
Used to determine if a {@link com.sun.corba.se.pept.transport.Connection Connection} will be present in an invocation. For example, it may be false in the case of shared-memory Input/OutputObjects.

return
true if a {@link com.sun.corba.se.pept.transport.Connection Connection} will be used for an invocation.

public voidsetConnectionCache(com.sun.corba.se.pept.transport.OutboundConnectionCache connectionCache)
Set the {@link com.sun.corba.se.pept.transport.Outbound.ConnectionCache OutboundConnectionCache} to be used by this ContactInfo. PEPt uses separate caches for each type of ContactInfo as given by {@link #getConnectionCacheType}. {@link #setConnectionCache} and {@link #getConnectionCache} support an optimzation to avoid hashing to find that cache.

param
connectionCache.

public booleanshouldCacheConnection()
Used to determine if the {@link com.sun.corba.se.pept.transport.Connection Connection} used for a request should be cached. If true then PEPt will attempt to reuse an existing {@link com.sun.corba.se.pept.transport.Connection Connection}. If one is not found it will create a new one and cache it for future use.

return
true if {@link com.sun.corba.se.pept.transport.Connection Connection}s created by this ContactInfo should be cached.