org.jboss.ejb.client
Interface EJBClientConfiguration

All Known Implementing Classes:

PropertiesBasedEJBClientConfiguration

public interface EJBClientConfiguration

EJBClientConfiguration is responsible for providing the configurations that will be used for creating EJB receivers and managing the EJB client context. Some of these configurations are related to remoting endpoints, connections which will be used to create RemotingConnectionEJBReceivers for the EJBClientContext

Author:

Jaikiran Pai

Nested Class Summary

static interface	EJBClientConfiguration.ClusterConfiguration Holds cluster specific configurations
static interface	EJBClientConfiguration.ClusterNodeConfiguration Holds the cluster node specific configuration
static interface	EJBClientConfiguration.CommonConnectionCreationConfiguration Holds the common configurations that are required for connection creation
static interface	EJBClientConfiguration.RemotingConnectionConfiguration Holds the connection specific configurations

Method Summary

CallbackHandler	getCallbackHandler() Returns the default CallbackHandler that will be used while creating remoting connections.
EJBClientConfiguration.ClusterConfiguration	getClusterConfiguration(String clusterName) Returns a cluster configuration corresponding to the passed clusterName.
Iterator<EJBClientConfiguration.ClusterConfiguration>	getClusterConfigurations() Returns the cluster configurations.
Iterator<EJBClientConfiguration.RemotingConnectionConfiguration>	getConnectionConfigurations() Returns the connection configurations.
org.xnio.OptionMap	getEndpointCreationOptions() Returns the endpoint creation options that will be used for creating the remoting endpoint.
String	getEndpointName() Returns the endpoint name to be used for creating the remoting endpoint.
org.xnio.OptionMap	getRemoteConnectionProviderCreationOptions() Returns the options that will be used for creating a remote connection provider.

Method Detail

getEndpointName

String getEndpointName()

Returns the endpoint name to be used for creating the remoting endpoint. This method must not return null

Returns:

getEndpointCreationOptions

org.xnio.OptionMap getEndpointCreationOptions()

Returns the endpoint creation options that will be used for creating the remoting endpoint. This method must not return null.

Returns:

getRemoteConnectionProviderCreationOptions

org.xnio.OptionMap getRemoteConnectionProviderCreationOptions()

Returns the options that will be used for creating a remote connection provider. This method must not return null.

Returns:

getCallbackHandler

CallbackHandler getCallbackHandler()

Returns the default CallbackHandler that will be used while creating remoting connections. Individual connection configurations, cluster configurations, cluster node configurations can override the CallbackHandler to be used while creating the connections

This method must not return null.

Returns:

getConnectionConfigurations

Iterator<EJBClientConfiguration.RemotingConnectionConfiguration> getConnectionConfigurations()

Returns the connection configurations. If there are no such configurations, then this method will return an empty Iterator

Returns:

getClusterConfigurations

Iterator<EJBClientConfiguration.ClusterConfiguration> getClusterConfigurations()

Returns the cluster configurations. If there are no such configurations, then this method will return an empty Iterator

Returns:

getClusterConfiguration

EJBClientConfiguration.ClusterConfiguration getClusterConfiguration(String clusterName)

Returns a cluster configuration corresponding to the passed clusterName. Returns null if no such cluster configuration exists.

Parameters:

clusterName - The name of the cluster

Returns: