com.tibco.eftl

Interface ConnectionListener

public interface ConnectionListener

Connection event handler.

Implement this interface to process connection events.

Supply an instance when you call EFTL.connect(String, java.util.Properties, ConnectionListener).

Field Summary

Fields

Modifier and Type	Field and Description
static int	BAD_DATA Invalid message from server.
static int	BAD_PAYLOAD Invalid network data.
static int	BAD_SUBSCRIPTION_ID Bad subscription identifier.
static int	CONNECTION_ERROR Connection error.
static int	FAILED_TLS_HANDSHAKE The client could not establish a secure connection to the eFTL server.
static int	FORCE_CLOSE Force close.
static int	MESSAGE_TOO_LARGE Message too large.
static int	NORMAL Normal close.
static int	NOT_AUTHENTICATED Not authenticated.
static int	POLICY_VIOLATION Policy violation.
static int	PROTOCOL Protocol error.
static int	PUBLISH_DISALLOWED This user is not allowed to publish messages.
static int	SERVER_ERROR eFTL server error.
static int	SHUTDOWN The server closed the connection because the server is exiting.

Method Summary

Modifier and Type	Method and Description
void	onConnect(Connection connection) A new connection to the eFTL server is ready to use.
void	onDisconnect(Connection connection, int code, java.lang.String reason) A connection to the eFTL server has closed.
void	onError(Connection connection, int code, java.lang.String reason) An error prevented an operation.
void	onReconnect(Connection connection) A connection to the eFTL server has re-opened and is ready to use.

Field Detail

NORMAL

static final int NORMAL

Normal close.

Your program closed the connection by calling Connection.disconnect(). Programs can continue clean-up procedures.

See Also:

Constant Field Values

SHUTDOWN

static final int SHUTDOWN

The server closed the connection because the server is exiting.

See Also:

Constant Field Values

PROTOCOL

static final int PROTOCOL

Protocol error. Please report this error to TIBCO support staff.

See Also:

Constant Field Values

BAD_DATA

static final int BAD_DATA

Invalid message from server. Please report this error to TIBCO support staff.

See Also:

Constant Field Values

CONNECTION_ERROR

static final int CONNECTION_ERROR

Connection error.

Programs may attempt to reconnect.

See Also:

Constant Field Values

BAD_PAYLOAD

static final int BAD_PAYLOAD

Invalid network data. Please report this error to TIBCO support staff.

See Also:

Constant Field Values

POLICY_VIOLATION

static final int POLICY_VIOLATION

Policy violation. Please report this error to TIBCO support staff.

See Also:

Constant Field Values

MESSAGE_TOO_LARGE

static final int MESSAGE_TOO_LARGE

Message too large.

The eFTL server closed the connection because the program sent a message that exceeds the channel's maximum message size. (Administrators can configure this limit.)

Programs may attempt to reconnect.

See Also:

Constant Field Values

SERVER_ERROR

static final int SERVER_ERROR

eFTL server error. Please report this error to TIBCO support staff.

See Also:

Constant Field Values

FAILED_TLS_HANDSHAKE

static final int FAILED_TLS_HANDSHAKE

The client could not establish a secure connection to the eFTL server.

Possible diagnoses:

• The client rejected the server certificate.
• Encryption protocols do not match.

See Also:

Constant Field Values

FORCE_CLOSE

static final int FORCE_CLOSE

Force close.

The eFTL server closed the connection because another client with the same client identifier has connected.

See Also:

Constant Field Values

NOT_AUTHENTICATED

static final int NOT_AUTHENTICATED

Not authenticated.

The eFTL server could not authenticate the client's username and passsword.

See Also:

Constant Field Values

BAD_SUBSCRIPTION_ID

static final int BAD_SUBSCRIPTION_ID

Bad subscription identifier.

The server detected an invalid subscription identifier. Please report this error to TIBCO support staff.

See Also:

Constant Field Values

PUBLISH_DISALLOWED

static final int PUBLISH_DISALLOWED

This user is not allowed to publish messages.

Administrators configure permission to publish.

See Also:

Constant Field Values

Method Detail

onConnect

void onConnect(Connection connection)

A new connection to the eFTL server is ready to use.

The eFTL library invokes this method only after your program calls EFTL.connect(java.lang.String, java.util.Properties, com.tibco.eftl.ConnectionListener) (and not after Connection.reconnect(java.util.Properties)).

Parameters:

connection - This connection is ready to use.

onReconnect

void onReconnect(Connection connection)

A connection to the eFTL server has re-opened and is ready to use.

The eFTL library invokes this method only after your program calls Connection.reconnect(java.util.Properties) (and not after EFTL.connect(java.lang.String, java.util.Properties, com.tibco.eftl.ConnectionListener)).

Parameters:

connection - This connection is ready to use.

onDisconnect

void onDisconnect(Connection connection,
                  int code,
                  java.lang.String reason)

A connection to the eFTL server has closed.

Possible codes include:

• NORMAL
• SHUTDOWN
• CONNECTION_ERROR
• POLICY_VIOLATION
• MESSAGE_TOO_LARGE
• SERVER_ERROR
• FORCE_CLOSE
• NOT_AUTHENTICATED

Parameters:

connection - This connection has closed.

code - This code categorizes the condition. Application programs may use this value in response logic.

reason - This string provides more detail. Application programs may use this value in error reporting and logging.

onError

void onError(Connection connection,
             int code,
             java.lang.String reason)

An error prevented an operation. The connection remains open.

Your implementation could alert the user.

Possible codes include:

• BAD_SUBSCRIPTION_ID
• PUBLISH_DISALLOWED

Parameters:

connection - This connection reported an error.

code - This code categorizes the error. Application programs may use this value in response logic.

reason - This string provides more detail. Application programs may use this value in error reporting and logging.