7.5.6. EJB Client Properties
The following tables list properties that can be configured programmatically or in the jboss-ejb-client.properties
file.
The following table lists properties that are vaild for the whole library within the same scope.
Table 7.1. Global Properties
Property Name | Description |
---|---|
endpoint.name |
Name of the client endpoint. If not set, the default value is
client-endpoint
This can be helpful to distinguish different endpoint settings because the thread name contains this property.
|
remote.connectionprovider.create.options.org.xnio.Options.SSL_ENABLED |
Boolean value that specifies whether the SSL protocol is enabled for all connections.
|
deployment.node.selector |
The fully qualified name of the implementation of
org.jboss.ejb.client.DeploymentNodeSelector .
This is used to load balance the invocation for the EJBs.
|
invocation.timeout |
The timeout for the EJB handshake or method invocation request/response cycle. The value is in milliseconds.
The invocation of any method throws a
java.util.concurrent.TimeoutException if the execution takes longer than the timeout period. The execution completes and the server is not interrupted.
|
reconnect.tasks.timeout |
The timeout for the background reconnect tasks. The value is in milliseconds.
If a number of connections are down, the next client EJB invocation will use an algorithm to decide if a reconnect is necessary to find the right node.
|
org.jboss.ejb.client.scoped.context |
Boolean value that specifies whether to enable the scoped EJB client context. The default value is
false .
If set to
true , the EJB Client will use the scoped context that is tied to the JNDI context. Otherwise the EJB client context will use the global selector in the JVM to determine the properties used to call the remote EJB and host.
|
The connection properties start with the prefix remote.connection.CONNECTION_NAME
where the CONNECTION_NAME is a local identifer only used to uniquely identify the connection.
Table 7.2. Connection Properties
Property Name | Description |
---|---|
remote.connections |
A comma-separated list of active
connection-names . Each connection is configured by using this name.
|
|
The host name or IP for the connection.
|
|
The port for the connection. The default value is 4447.
|
|
The user name used to authenticate connection security.
|
|
The password used to authenticate the user.
|
|
The timeout period for the initial connection. After that, the reconnect task will periodicaly check whether the connection can be established. The value is in milliseconds.
|
|
Full qualified name of the
CallbackHandler class. It will be used to establish the connection and can not changed as long as the connection is open.
|
channel.options.org.jboss.remoting3.RemotingOptions.MAX_OUTBOUND_MESSAGES
|
Integer value specifying the maximum number of outbound requests. The default is 80.
There is only one connection from the client (JVM) to the server to handle all invocations.
|
connect.options.org.xnio.Options.SASL_POLICY_NOANONYMOUS
|
Boolean value that determines whether credentials must be provided by the client to connect successfully. The default value is
true .
If set to
true , the client must provide credentials. If set to false , invocation is allowed as long as the remoting connector does not request a security realm.
|
connect.options.org.xnio.Options.SASL_DISALLOWED_MECHANISMS
|
Disables certain SASL mechanisms used for authenticating during connection creation.
JBOSS_LOCAL_USER means the silent authentication mechanism, used when the client and server are on the same machine, is disabled.
|
connect.options.org.xnio.Options.SASL_POLICY_NOPLAINTEXT
|
Boolean value that enables or disables the use of plain text messages during the authentication. If using JAAS, it must be set to false to allow a plain text password.
|
connect.options.org.xnio.Options.SSL_ENABLED
|
Boolean value that specifies whether the SSL protocol is enabled for this connection.
|
connect.options.org.jboss.remoting3.RemotingOptions.HEARTBEAT_INTERVAL
|
Interval to send a heartbeat between client and server to preven automatic close, for example, in the case of a firewall. The value is in milliseconds.
|
If the initial connection connects to a clustered environment, the topology of the cluster is received automatically and asynchronously. These properties are used to connect to each received member. Each property starts with the prefix remote.cluster.CLUSTER_NAME
where the CLUSTER_NAME refers to the related to the servers Infinispan subsystem configuration.
Table 7.3. Cluster Properties
Property Name | Description |
---|---|
clusternode.selector
|
The fully qualified name of the implementation of
org.jboss.ejb.client.ClusterNodeSelector .
This class, rather than
org.jboss.ejb.clientDeploymentNodeSelector , is used to load balance EJB invocations in a clustered environment. If the cluster is completely down, the invocation will fail with No ejb receiver available .
|
channel.options.org.jboss.remoting3.RemotingOptions.MAX_OUTBOUND_MESSAGES
|
Integer value specifying the maximum number of outbound requests that can be made to the entire cluster.
|
node.NODE_NAME. channel.options.org.jboss.remoting3.RemotingOptions.MAX_OUTBOUND_MESSAGES
|
Integer value specifying the maximum number of outbound requests that can be made to this specific cluster-node.
|