EJBClientConfiguration (Red Hat JBoss Enterprise Application Platform 7.0.0.GA public API)

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

Nested Classes
Modifier and Type	Interface and Description
`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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.RemotingConnectionConfiguration>`	`getConnectionConfigurations()` Returns the connection configurations.
`DeploymentNodeSelector`	`getDeploymentNodeSelector()` Returns the `DeploymentNodeSelector` to be used for the `EJBClientContext` created out of this `EJBClientConfiguration`.
`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.
`long`	`getInvocationTimeout()` Returns the timeout, in milliseconds, that will be used for EJB invocations.
`long`	`getReconnectTasksTimeout()` Returns the wait timeout, in milliseconds, that will be used when the reconnect tasks are submitted.
`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
```
OptionMap getEndpointCreationOptions()
```
    Returns the endpoint creation options that will be used for creating the remoting endpoint. This method must not return null.
    
    Returns:
  - getRemoteConnectionProviderCreationOptions
```
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:
  - 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:
  - getInvocationTimeout
```
long getInvocationTimeout()
```
    Returns the timeout, in milliseconds, that will be used for EJB invocations. A value of zero or a negative value will imply a "wait forever" semantic where the invocation will never timeout and the client will wait for the invocation result indefinitely.
    
    Returns:
  - getReconnectTasksTimeout
```
long getReconnectTasksTimeout()
```
    Returns the wait timeout, in milliseconds, that will be used when the reconnect tasks are submitted. The reconnect tasks are submitted in parallel and hence the value returned by this method need not be the sum of time each reconnect task takes. The EJB client context will wait for a maximum of this amount of time in milliseconds, before giving up on the reconnect attempt. If all reconnect tasks finish before this timeout, then the EJB client context doesn't wait for any longer.
    If this method returns zero or a negative value, then a default of 10 second timeout will be used.
    
    Returns:
  - getDeploymentNodeSelector
```
DeploymentNodeSelector getDeploymentNodeSelector()
```
    Returns the DeploymentNodeSelector to be used for the EJBClientContext created out of this EJBClientConfiguration. If this method returns null, then it's upto the implementation to use some default DeploymentNodeSelector
    
    Returns:

Interface EJBClientConfiguration

Nested Class Summary

Method Summary

Method Detail

getEndpointName

getEndpointCreationOptions

getRemoteConnectionProviderCreationOptions

getCallbackHandler

getConnectionConfigurations

getClusterConfiguration

getInvocationTimeout

getReconnectTasksTimeout

getDeploymentNodeSelector