org.rhq.common.jbossas.client.controller

Class SocketBindingJBossASClient

java.lang.Object

org.rhq.common.jbossas.client.controller.JBossASClient

org.rhq.common.jbossas.client.controller.SocketBindingJBossASClient

public class SocketBindingJBossASClient
extends JBossASClient

Provides convenience methods associated with socket binding management.

Author:

John Mazzitelli

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BINDING_AJP
static String	DEFAULT_BINDING_HTTP
static String	DEFAULT_BINDING_HTTPS
static String	DEFAULT_BINDING_JACORB
static String	DEFAULT_BINDING_JACORB_SSL
static String	DEFAULT_BINDING_MESSAGING
static String	DEFAULT_BINDING_MESSAGING_THRUPUT
static String	DEFAULT_BINDING_MGMT_HTTP
static String	DEFAULT_BINDING_MGMT_HTTPS
static String	DEFAULT_BINDING_MGMT_NATIVE
static String	DEFAULT_BINDING_OSGI_HTTP
static String	DEFAULT_BINDING_REMOTING
static String	DEFAULT_BINDING_TXN_RECOVERY_ENV
static String	DEFAULT_BINDING_TXN_STATUS_MGR
static String	INTERFACE
static String	JBOSS_SYSPROP_PORT_OFFSET
static String	PORT
static String	PORT_OFFSET
static String	SOCKET_BINDING
static String	SOCKET_BINDING_GROUP
static String	STANDARD_SOCKETS

Fields inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

ADD, ADDRESS, BATCH, BATCH_STEPS, FAILURE_DESCRIPTION, log, NAME, OPERATION, OUTCOME, OUTCOME_SUCCESS, PERSISTENT, READ_ATTRIBUTE, READ_RESOURCE, REMOVE, RESULT, SUBSYSTEM, SYSTEM_PROPERTY, VALUE, WRITE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
SocketBindingJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	setPortOffset(String socketBindingGroupName, String sysPropName, int offset) Sets the port offset for the socket bindings found in the named socket binding group.
void	setSocketBindingInterfaceExpression(String socketBindingGroupName, String socketBindingName, String sysPropName, String interfaceName) Sets the interface name for the named socket binding found in the named socket binding group.
void	setSocketBindingPort(String socketBindingGroupName, String socketBindingName, int port) Sets the port number for the named socket binding found in the named socket binding group.
void	setSocketBindingPort(String socketBindingGroupName, String socketBindingName, String interfaceName) Sets the interface name for the named socket binding found in the named socket binding group.
void	setSocketBindingPortExpression(String socketBindingGroupName, String socketBindingName, String sysPropName, int port) Sets the port number for the named socket binding found in the named socket binding group.
void	setStandardPortOffset(int offset) Sets the port offset for the socket bindings found in the standard socket binding group.
void	setStandardSocketBindingInterface(String socketBindingName, String interfaceName) Sets the interface name for the named standard socket binding.
void	setStandardSocketBindingInterfaceExpression(String socketBindingName, String sysPropName, String interfaceName) Sets the interface name for the named standard socket binding.
void	setStandardSocketBindingPort(String socketBindingName, int port) Sets the port number for the named standard socket binding.
void	setStandardSocketBindingPortExpression(String socketBindingName, String sysPropName, int port) Sets the port number for the named standard socket binding.

Methods inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

createBatchRequest, createReadAttributeRequest, createReadAttributeRequest, createRequest, createWriteAttributeRequest, execute, findNodeInList, getFailureDescription, getModelControllerClient, getResultListAsStrings, getResults, getStringAttribute, getStringAttribute, isSuccess, readResource, readResource, remove, setPossibleExpression

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_BINDING_GROUP

public static final String SOCKET_BINDING_GROUP

See Also:

Constant Field Values

SOCKET_BINDING

public static final String SOCKET_BINDING

See Also:

Constant Field Values

PORT

public static final String PORT

See Also:

Constant Field Values

INTERFACE

public static final String INTERFACE

See Also:

Constant Field Values

PORT_OFFSET

public static final String PORT_OFFSET

See Also:

Constant Field Values

STANDARD_SOCKETS

public static final String STANDARD_SOCKETS

See Also:

Constant Field Values

JBOSS_SYSPROP_PORT_OFFSET

public static final String JBOSS_SYSPROP_PORT_OFFSET

See Also:

Constant Field Values

DEFAULT_BINDING_MGMT_NATIVE

public static final String DEFAULT_BINDING_MGMT_NATIVE

See Also:

Constant Field Values

DEFAULT_BINDING_MGMT_HTTP

public static final String DEFAULT_BINDING_MGMT_HTTP

See Also:

Constant Field Values

DEFAULT_BINDING_MGMT_HTTPS

public static final String DEFAULT_BINDING_MGMT_HTTPS

See Also:

Constant Field Values

DEFAULT_BINDING_AJP

public static final String DEFAULT_BINDING_AJP

See Also:

Constant Field Values

DEFAULT_BINDING_HTTP

public static final String DEFAULT_BINDING_HTTP

See Also:

Constant Field Values

DEFAULT_BINDING_HTTPS

public static final String DEFAULT_BINDING_HTTPS

See Also:

Constant Field Values

DEFAULT_BINDING_JACORB

public static final String DEFAULT_BINDING_JACORB

See Also:

Constant Field Values

DEFAULT_BINDING_JACORB_SSL

public static final String DEFAULT_BINDING_JACORB_SSL

See Also:

Constant Field Values

DEFAULT_BINDING_MESSAGING

public static final String DEFAULT_BINDING_MESSAGING

See Also:

Constant Field Values

DEFAULT_BINDING_MESSAGING_THRUPUT

public static final String DEFAULT_BINDING_MESSAGING_THRUPUT

See Also:

Constant Field Values

DEFAULT_BINDING_OSGI_HTTP

public static final String DEFAULT_BINDING_OSGI_HTTP

See Also:

Constant Field Values

DEFAULT_BINDING_REMOTING

public static final String DEFAULT_BINDING_REMOTING

See Also:

Constant Field Values

DEFAULT_BINDING_TXN_RECOVERY_ENV

public static final String DEFAULT_BINDING_TXN_RECOVERY_ENV

See Also:

Constant Field Values

DEFAULT_BINDING_TXN_STATUS_MGR

public static final String DEFAULT_BINDING_TXN_STATUS_MGR

See Also:

Constant Field Values

Constructor Detail

SocketBindingJBossASClient

public SocketBindingJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Detail

setStandardPortOffset

public void setStandardPortOffset(int offset)
                           throws Exception

Sets the port offset for the socket bindings found in the standard socket binding group. This will configure the offset to be allowed to be overridden by the standard JBOSS_SYSPROP_PORT_OFFSET system property.

Parameters:

offset - the new port offset

Throws:

Exception

setPortOffset

public void setPortOffset(String socketBindingGroupName,
                 String sysPropName,
                 int offset)
                   throws Exception

Sets the port offset for the socket bindings found in the named socket binding group. If sysPropName is null, this simply sets the offset explicitly to the given offset. If sysPropName is not null, this sets the offset to the expression "${sysPropName:offset}". You typically will want to use the standard JBOSS_SYSPROP_PORT_OFFSET system property name as the sysPropName to follow the normal out-of-box JBossAS configuration, though you don't have to.

Parameters:

socketBindingGroupName - name of the socket binding group whose port offset is to be set

sysPropName - the name of the system property whose value is to be the port offset

offset - the default port offset if the sysPropName is not defined

Throws:

Exception

setStandardSocketBindingPort

public void setStandardSocketBindingPort(String socketBindingName,
                                int port)
                                  throws Exception

Sets the port number for the named standard socket binding.

Parameters:

socketBindingName - the name of the standard socket binding whose port is to be set

port - the new port number

Throws:

Exception

setStandardSocketBindingPortExpression

public void setStandardSocketBindingPortExpression(String socketBindingName,
                                          String sysPropName,
                                          int port)
                                            throws Exception

Sets the port number for the named standard socket binding. If sysPropName is null, this simply sets the port number explicitly to the given port number. If sysPropName is not null, this sets the port to the expression "${sysPropName:port}".

Parameters:

socketBindingName - the name of the standard socket binding whose port is to be set

sysPropName - the name of the system property whose value is to be the port number

port - the default port number if the sysPropName is not defined

Throws:

Exception

setSocketBindingPort

public void setSocketBindingPort(String socketBindingGroupName,
                        String socketBindingName,
                        int port)
                          throws Exception

Sets the port number for the named socket binding found in the named socket binding group.

Parameters:

socketBindingGroupName - the name of the socket binding group that has the named socket binding

socketBindingName - the name of the socket binding whose port is to be set

port - the new port number

Throws:

Exception

setSocketBindingPortExpression

public void setSocketBindingPortExpression(String socketBindingGroupName,
                                  String socketBindingName,
                                  String sysPropName,
                                  int port)
                                    throws Exception

Sets the port number for the named socket binding found in the named socket binding group. If sysPropName is null, this simply sets the port number explicitly to the given port number. If sysPropName is not null, this sets the port to the expression "${sysPropName:port}".

Parameters:

socketBindingGroupName - the name of the socket binding group that has the named socket binding

socketBindingName - the name of the socket binding whose port is to be set

sysPropName - the name of the system property whose value is to be the port number

port - the default port number if the sysPropName is not defined

Throws:

Exception

setStandardSocketBindingInterface

public void setStandardSocketBindingInterface(String socketBindingName,
                                     String interfaceName)
                                       throws Exception

Sets the interface name for the named standard socket binding.

Parameters:

socketBindingName - the name of the standard socket binding whose interface is to be set

interfaceName - the new interface name

Throws:

Exception

setStandardSocketBindingInterfaceExpression

public void setStandardSocketBindingInterfaceExpression(String socketBindingName,
                                               String sysPropName,
                                               String interfaceName)
                                                 throws Exception

Sets the interface name for the named standard socket binding. If sysPropName is null, this simply sets the interface name explicitly. If sysPropName is not null, this sets the interface to the expression "${sysPropName:interfaceName}".

Parameters:

socketBindingName - the name of the standard socket binding whose interface is to be set

sysPropName - the name of the system property whose value is to be the interface name

interfaceName - the default interface name if the sysPropName is not defined

Throws:

Exception

setSocketBindingPort

public void setSocketBindingPort(String socketBindingGroupName,
                        String socketBindingName,
                        String interfaceName)
                          throws Exception

Sets the interface name for the named socket binding found in the named socket binding group.

Parameters:

socketBindingGroupName - the name of the socket binding group that has the named socket binding

socketBindingName - the name of the socket binding whose interface is to be set

interfaceName - the new interface name

Throws:

Exception

setSocketBindingInterfaceExpression

public void setSocketBindingInterfaceExpression(String socketBindingGroupName,
                                       String socketBindingName,
                                       String sysPropName,
                                       String interfaceName)
                                         throws Exception

Sets the interface name for the named socket binding found in the named socket binding group. If sysPropName is null, this simply sets the interface name explicitly to the given name. If sysPropName is not null, this sets the interface name to the expression "${sysPropName:interfaceName}".

Parameters:

socketBindingGroupName - the name of the socket binding group that has the named socket binding

socketBindingName - the name of the socket binding whose interface is to be set

sysPropName - the name of the system property whose value is to be the interface name

interfaceName - the default interface name if the sysPropName is not defined

Throws:

Exception