org.jboss.as.protocol

Class ProtocolConnectionManager

java.lang.Object

org.jboss.as.protocol.ProtocolConnectionManager

public final class ProtocolConnectionManager
extends Object

A basic connection manager, notifying clients when the connection is closed or shutdown. The ProtocolConnectionManager.ConnectTask can be used to implement different (re-)connection strategies.

Author:

Emanuel Muckenhuber

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProtocolConnectionManager.ConnectionOpenHandler Handler for notifications that a connection has been opened
static interface	ProtocolConnectionManager.ConnectTask Task used to establish the connection.

Field Summary

Fields

Modifier and Type	Field and Description
static ProtocolConnectionManager.ConnectTask	DISCONNECTED A ConnectTask that can be returned from ProtocolConnectionManager.ConnectTask.connectionClosed() to terminate further attempts to connect.

Method Summary

Modifier and Type	Method and Description
org.jboss.remoting3.Connection	connect() Get the connection.
static ProtocolConnectionManager	create(org.jboss.remoting3.Connection connection, ProtocolConnectionManager.ConnectionOpenHandler openHandler) Create a new connection manager, based on an existing connection.
static ProtocolConnectionManager	create(ProtocolConnectionConfiguration configuration, ProtocolConnectionManager.ConnectionOpenHandler openHandler) Create a new connection manager, which will try to connect using the protocol connection configuration.
static ProtocolConnectionManager	create(ProtocolConnectionConfiguration configuration, ProtocolConnectionManager.ConnectionOpenHandler openHandler, ProtocolConnectionManager.ConnectTask next) Create a new connection manager, which will try to connect using the protocol connection configuration.
static ProtocolConnectionManager	create(ProtocolConnectionManager.ConnectTask connectTask) Create a new connection manager.
org.jboss.remoting3.Connection	getConnection() Get the connection.
boolean	isConnected() Check if connected.
void	shutdown() Shutdown the connection manager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISCONNECTED

public static final ProtocolConnectionManager.ConnectTask DISCONNECTED

A ConnectTask that can be returned from ProtocolConnectionManager.ConnectTask.connectionClosed() to terminate further attempts to connect.

Method Detail

isConnected

public boolean isConnected()

Check if connected.

Returns:

true if the connection is open, false otherwise

connect

public org.jboss.remoting3.Connection connect()
                                       throws IOException

Get the connection. If not connected, the ConnectTask will be used to establish a connection.

Returns:

the connection

Throws:

IOException

getConnection

public org.jboss.remoting3.Connection getConnection()

Get the connection.

Returns:

the connection

shutdown

public void shutdown()

Shutdown the connection manager.

create

public static ProtocolConnectionManager create(org.jboss.remoting3.Connection connection,
                                               ProtocolConnectionManager.ConnectionOpenHandler openHandler)

Create a new connection manager, based on an existing connection.

Parameters:

connection - the existing connection

openHandler - a connection open handler

Returns:

the connected manager

create

public static ProtocolConnectionManager create(ProtocolConnectionConfiguration configuration,
                                               ProtocolConnectionManager.ConnectionOpenHandler openHandler)

Create a new connection manager, which will try to connect using the protocol connection configuration.

Parameters:

configuration - the connection configuration

openHandler - the connection open handler

Returns:

the connection manager

create

public static ProtocolConnectionManager create(ProtocolConnectionConfiguration configuration,
                                               ProtocolConnectionManager.ConnectionOpenHandler openHandler,
                                               ProtocolConnectionManager.ConnectTask next)

Create a new connection manager, which will try to connect using the protocol connection configuration.

Parameters:

configuration - the connection configuration

openHandler - the connection open handler

next - the next connect connectTask used once disconnected

Returns:

the connection manager

create

public static ProtocolConnectionManager create(ProtocolConnectionManager.ConnectTask connectTask)

Create a new connection manager.

Parameters:

connectTask - the connect connectTask

Returns:

the connection manager