org.apache.yoko.orb.OCI
Interface ConnectorOperations

All Known Subinterfaces:

Connector

public interface ConnectorOperations

An interface for Connector objects. A Connector is used by CORBA clients to initiate a connection to a server. It also provides operations for the management of IOR profiles.

See Also:

ConFactory, Transport

Method Summary

Transport	connect_timeout(int timeout) Similar to connect, but it is possible to specify a timeout.
Transport	connect() Used by CORBA clients to establish a connection to a CORBA server.
boolean	equal(Connector con) Find out whether this Connector is equal to another Connector.
ConnectorInfo	get_info() Returns the information object associated with the Connector.
ProfileInfo[]	get_usable_profiles(IOR ref, Policy[] policies) From the given IOR and list of policies, get basic information about all profiles for which this Connector can be used.
String	id() The plugin id.
int	tag() The profile id tag.

Method Detail

id

String id()

The plugin id.

tag

int tag()

The profile id tag.

connect

Transport connect()

Used by CORBA clients to establish a connection to a CORBA server. It returns a Transport object, which can be used for sending and receiving octet streams to and from the server.

Returns:

The new Transport object.

Throws:

TRANSIENT - If the server cannot be contacted.

COMM_FAILURE - In case of other errors.

connect_timeout

Transport connect_timeout(int timeout)

Similar to connect, but it is possible to specify a timeout. On return the caller can test whether there was a timeout by checking whether a nil object reference was returned.

Parameters:

timeout - The timeout value in milliseconds.

Returns:

The new Transport object.

Throws:

TRANSIENT - If the server cannot be contacted.

COMM_FAILURE - In case of other errors.

get_usable_profiles

ProfileInfo[] get_usable_profiles(IOR ref,
                                  Policy[] policies)

From the given IOR and list of policies, get basic information about all profiles for which this Connector can be used.

Parameters:

ref - The IOR from which the profiles are taken.

policies - The policies that must be satisfied.

Returns:

The sequence of basic information about profiles. If this sequence is empty, there is no profile in the IOR that matches this Connector and the list of policies.

equal

boolean equal(Connector con)

Find out whether this Connector is equal to another Connector. Two Connectors are considered equal if they are interchangeable.

Parameters:

con - The connector to compare with.

Returns:

TRUE if the Connectors are equal, FALSE otherwise.

get_info

ConnectorInfo get_info()

Returns the information object associated with the Connector.

Returns:

The Connector information object.