org.apache.yoko.orb.OCI
Interface TransportInfoOperations

All Known Subinterfaces:

TransportInfo, TransportInfo, TransportInfoOperations

All Known Implementing Classes:

TransportInfo_impl

public interface TransportInfoOperations

Information on an OCI Transport object. Objects of this type must be narrowed to a Transport information object for a concrete protocol implementation, for example to OCI::IIOP::TransportInfo in case the plug-in implements IIOP.

See Also:

Transport

Method Summary

AcceptorInfo	acceptor_info() The AcceptorInfo object for the Acceptor that created the Transport object that this TransportInfo object belongs to.
void	add_close_cb(CloseCB cb) Add a callback that is called before a connection is closed.
ConnectorInfo	connector_info() The ConnectorInfo object for the Connector that created the Transport object that this TransportInfo object belongs to.
String	describe() Returns a human readable description of the transport.
boolean	endpoint_alias_match(ConnectorInfo connInfo) Uses the BiDir SCL information in this TransportInfo to check whether we can be used as a BiDir connection alias instead of creating a new connection with the information specified in the ConnectorInfo paramater
ServiceContext[]	get_service_contexts(Policy[] policies) Returns a sequence of service contexts for this transport based on the policies.
void	handle_service_contexts(ServiceContext[] contexts) Handles service contexts that might be received during a request.
String	id() The plugin id.
short	origin() The origin indicates whether the transport was originally created by a server side accept or a client side connect.
boolean	received_bidir_SCL() Queries whether this' transport has received a BiDir SCL in a request.
void	remove_close_cb(CloseCB cb) Remove a close callback.
int	tag() The profile id tag.

Method Detail

id

String id()

The plugin id.

tag

int tag()

The profile id tag.

connector_info

ConnectorInfo connector_info()

The ConnectorInfo object for the Connector that created the Transport object that this TransportInfo object belongs to. If the Transport for this TransportInfo was not created by a Connector, this attribute is set to the nil object reference.

acceptor_info

AcceptorInfo acceptor_info()

The AcceptorInfo object for the Acceptor that created the Transport object that this TransportInfo object belongs to. If the Transport for this TransportInfo was not created by an Acceptor, this attribute is set to the nil object reference.

origin

short origin()

The origin indicates whether the transport was originally created by a server side accept or a client side connect. This is information is required for connection lifecycle management in bidirectional communications. This information cannot be inferred by the connector_info and acceptor_info attributes as they may both be set in a bidirectional case.

Returns:

CLIENT_SIDE if transport was initially created as a client side connection. SERVER_SIDE if transport was initially created to handle incoming requests.

describe

String describe()

Returns a human readable description of the transport.

Returns:

The description.

add_close_cb

void add_close_cb(CloseCB cb)

Add a callback that is called before a connection is closed. If the callback has already been registered, this method has no effect.

Parameters:

cb - The callback to add.

remove_close_cb

void remove_close_cb(CloseCB cb)

Remove a close callback. If the callback was not registered, this method has no effect.

Parameters:

cb - The callback to remove.

get_service_contexts

ServiceContext[] get_service_contexts(Policy[] policies)

Returns a sequence of service contexts for this transport based on the policies. Certain policies result in service contexts being applied to requests.

Parameters:

policies - The CORBA Policy list.

Returns:

The service contexts for the given polices.

handle_service_contexts

void handle_service_contexts(ServiceContext[] contexts)

Handles service contexts that might be received during a request. This allows transports to change their internal state or behavior during their runtime.

Parameters:

contexts - The service context list

received_bidir_SCL

boolean received_bidir_SCL()

Queries whether this' transport has received a BiDir SCL in a request.

endpoint_alias_match

boolean endpoint_alias_match(ConnectorInfo connInfo)

Uses the BiDir SCL information in this TransportInfo to check whether we can be used as a BiDir connection alias instead of creating a new connection with the information specified in the ConnectorInfo paramater