JBossRemotingRemoteCommunicator (RHQ Enterprise Agent-Server Communications Layer 4.10.0 API)

java.lang.Object
- org.rhq.enterprise.communications.command.client.JBossRemotingRemoteCommunicator

All Implemented Interfaces:

RemoteCommunicator
```
public class JBossRemotingRemoteCommunicator
extends Object
implements RemoteCommunicator
```
Provides basic functionality to all command clients that want to use JBoss/Remoting as the remoting framework.
This superclass provides the hooks by which users of the client can select the location of the remote server and the subsystem where the command is to be invoked.

Under the covers, a remoting client is created and maintained by this object. There is no need to call connect() since it will be done automatically when appropriate; however, it is good practice to tell this object to disconnect() its client when no longer necessary to issue commands to the remote server.

All subclasses should include a no-arg constructor so they can be built dynamically by the command line client.

Author:

John Mazzitelli

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_SUBSYSTEM
The default subsystem to use when sending messages via the JBoss/Remoting client.

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_SUBSYSTEM` The default subsystem to use when sending messages via the JBoss/Remoting client.

Constructor Summary

Constructors
Constructor and Description
`JBossRemotingRemoteCommunicator(org.jboss.remoting.InvokerLocator locator, String subsystem, Map<String,String> client_config)` Constructor for `JBossRemotingRemoteCommunicator` that allows you to specify the `invoker locator` to use.
`JBossRemotingRemoteCommunicator(String locatorUri)` Constructor for `JBossRemotingRemoteCommunicator` that allows you to indicate the `invoker locator` to use by specifying the locator's URI.
`JBossRemotingRemoteCommunicator(String locatorUri, Map<String,String> client_config)` Constructor for `JBossRemotingRemoteCommunicator` that allows you to indicate the `invoker locator` to use by specifying the locator's URI.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`connect()` Does nothing; send a request to connect.
`void`	`disconnect()` Disconnects this communicator object from the remote endpoint.
`Map<String,String>`	`getClientConfiguration()` Returns the map of name/value pairs of client configuration settings used when creating the client.
`FailureCallback`	`getFailureCallback()` Returns the failure callback currently configured within this object.
`InitializeCallback`	`getInitializeCallback()` Returns the initialize callback currently configured within this object.
`org.jboss.remoting.InvokerLocator`	`getInvokerLocator()` Returns the invoker locator that is to be used to find the remote JBoss/Remoting server.
`String`	`getRemoteEndpoint()` Returns a string representation of the remote endpoint this communicator is configured to talk to.
`String`	`getSubsystem()` Returns the value of the subsystem that will be used to target command invocations.
`boolean`	`isConnected()` Returns `true` if this object has established a live connection with the remote endpoint.
`CommandResponse`	`send(Command command)` Sends the given command to the remote endpoint by utilizing a remoting framework supported by the specific communicator implementation.
`CommandResponse`	`sendWithoutCallbacks(Command command)` This is the same as `RemoteCommunicator.send(Command)` except, on error, this method will not attempt to call the failure callback, if one was set.
`CommandResponse`	`sendWithoutInitializeCallback(Command command)` This is the same as `RemoteCommunicator.send(Command)` except this method will not attempt to call the `initialize callback`, thus allowing this method to be called from the initialize callback itself.
`void`	`setFailureCallback(FailureCallback callback)` Sets the given failure callback as the one that will be notified when this object sees a comm failure.
`void`	`setInitializeCallback(InitializeCallback callback)` Sets the given initialize callback as the one that will be notified when this object attempts to send its very first message after a `RemoteCommunicator.connect()`.
`void`	`setRemoteEndpoint(String endpoint)` Sets the invoker locator URI and creates a new locator that is to be used to find the remote JBoss/Remoting server for its subsequent command client invocations.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SUBSYSTEM
```
public static final String DEFAULT_SUBSYSTEM
```
    The default subsystem to use when sending messages via the JBoss/Remoting client.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - JBossRemotingRemoteCommunicator
```
public JBossRemotingRemoteCommunicator(String locatorUri)
                                throws MalformedURLException
```
    Constructor for JBossRemotingRemoteCommunicator that allows you to indicate the invoker locator to use by specifying the locator's URI. The subsystem will be set to the DEFAULT_SUBSYSTEM.
    
    Parameters:
    locatorUri - the locator's URI (must not be null)
    
    Throws:
    
    MalformedURLException - if failed to create the locator (see InvokerLocator.InvokerLocator(String))
  - JBossRemotingRemoteCommunicator
```
public JBossRemotingRemoteCommunicator(String locatorUri,
                               Map<String,String> client_config)
                                throws MalformedURLException
```
    Constructor for JBossRemotingRemoteCommunicator that allows you to indicate the invoker locator to use by specifying the locator's URI. The subsystem will be set to the DEFAULT_SUBSYSTEM. The given Map should contain Client configuration attributes.
    
    Parameters:
    locatorUri - the locator's URI (must not be null)
    client_config - the client configuration (may be null or empty)
    
    Throws:
    
    MalformedURLException - if failed to create the locator (see InvokerLocator.InvokerLocator(String))
  - JBossRemotingRemoteCommunicator
```
public JBossRemotingRemoteCommunicator(org.jboss.remoting.InvokerLocator locator,
                               String subsystem,
                               Map<String,String> client_config)
```
    Constructor for JBossRemotingRemoteCommunicator that allows you to specify the invoker locator to use. locator may be null, in which case, it must later be specified through #setInvokerLocator(InvokerLocator) before any client commands can be issued.
    
    Parameters:
    locator - the locator to use (may be null)
    subsystem - the subsystem (or command domain) in which commands will be invoked (may be null)
    client_config - the client configuration (may be null or empty)
- Method Detail
  - getInvokerLocator
```
public org.jboss.remoting.InvokerLocator getInvokerLocator()
```
    Returns the invoker locator that is to be used to find the remote JBoss/Remoting server. If null is returned, this communicator will not be able to issue commands.
    
    Returns:
    invoker locator used by this client to issue commands
  - setRemoteEndpoint
```
public void setRemoteEndpoint(String endpoint)
                       throws Exception
```
    Sets the invoker locator URI and creates a new locator that is to be used to find the remote JBoss/Remoting server for its subsequent command client invocations. Any existing remoting client is automatically disconnected. The client configuration properties will, however, remain the same as before - so the new clients that are created will have the same configuration attributes. See #setInvokerLocator(String, Map) if you want to reconfigure the client with different properties that are more appropriate for the new locator.
    
    Specified by:
    
    setRemoteEndpoint in interface RemoteCommunicator
    
    Parameters:
    locatorUri - the new invoker locator's URI to use for future command client invocations (must not be null)
    
    Throws:
    
    MalformedURLException - if failed to create the locator (see InvokerLocator.InvokerLocator(String))
    
    Exception - if the communicator could not point to the new remote endpoint
  - getSubsystem
```
public String getSubsystem()
```
    Returns the value of the subsystem that will be used to target command invocations. The subsystem is defined by the JBoss/Remoting API and can be used by the Command Framework to organize command processors into different domains.
    
    Returns:
    subsystem (may be null)
  - getFailureCallback
```
public FailureCallback getFailureCallback()
```
    Description copied from interface: RemoteCommunicator
    
    Returns the failure callback currently configured within this object.
    
    Specified by:
    
    getFailureCallback in interface RemoteCommunicator
    
    Returns:
    the callback (may be null)
  - setFailureCallback
```
public void setFailureCallback(FailureCallback callback)
```
    Description copied from interface: RemoteCommunicator
    
    Sets the given failure callback as the one that will be notified when this object sees a comm failure. You can pass in null if you don't need this object to notify anything when a failure is detected. The callback can be used to reconfigure this communicator and retry the failed message (useful to implement failover algorithms).
    
    Specified by:
    
    setFailureCallback in interface RemoteCommunicator
    
    Parameters:
    callback - the object that listens to failures and may trigger retries (may be null)
  - getInitializeCallback
```
public InitializeCallback getInitializeCallback()
```
    Description copied from interface: RemoteCommunicator
    
    Returns the initialize callback currently configured within this object.
    
    Specified by:
    
    getInitializeCallback in interface RemoteCommunicator
    
    Returns:
    the callback (may be null)
  - setInitializeCallback
```
public void setInitializeCallback(InitializeCallback callback)
```
    Description copied from interface: RemoteCommunicator
    
    Sets the given initialize callback as the one that will be notified when this object attempts to send its very first message after a RemoteCommunicator.connect(). This allows the callback to perform additional initialization procedures prior to the first message getting sent to the remote endpoint. The callback is free to send its own messages via RemoteCommunicator.sendWithoutCallbacks(Command) or RemoteCommunicator.sendWithoutInitializeCallback(Command).
    
    Specified by:
    
    setInitializeCallback in interface RemoteCommunicator
  - getRemoteEndpoint
```
public String getRemoteEndpoint()
```
    Description copied from interface: RemoteCommunicator
    
    Returns a string representation of the remote endpoint this communicator is configured to talk to.
    
    Specified by:
    
    getRemoteEndpoint in interface RemoteCommunicator
    
    Returns:
    remote endpoint string
  - getClientConfiguration
```
public Map<String,String> getClientConfiguration()
```
    Returns the map of name/value pairs of client configuration settings used when creating the client. The returned map is a copy - changing its contents has no effect on the clients that already have been or will be created by this object. Use #setInvokerLocator(InvokerLocator, Map) or #setInvokerLocator(String, Map) to change the map contents.
    
    Returns:
    copy of the configuration that will be used when creating clients (may be null or empty)
  - connect
```
public void connect()
             throws Exception
```
    Does nothing; send a request to connect.
    
    Specified by:
    
    connect in interface RemoteCommunicator
    
    Throws:
    
    Exception - if failed to connect to the remote endpoint for any reason
    See Also:
    RemoteCommunicator.disconnect()
  - disconnect
```
public void disconnect()
```
    Description copied from interface: RemoteCommunicator
    
    Disconnects this communicator object from the remote endpoint. Once disconnected, this communicator will not be able to send commands to the remote endpoint.
    Note that the user may later on change its mind and reconnect simply by calling RemoteCommunicator.connect().
    
    Specified by:
    
    disconnect in interface RemoteCommunicator
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: RemoteCommunicator
    
    Returns true if this object has established a live connection with the remote endpoint.
    
    Specified by:
    
    isConnected in interface RemoteCommunicator
    
    Returns:
    true if connected to a remote endpoint; false otherise
  - sendWithoutCallbacks
```
public CommandResponse sendWithoutCallbacks(Command command)
                                     throws Throwable
```
    Description copied from interface: RemoteCommunicator
    
    This is the same as RemoteCommunicator.send(Command) except, on error, this method will not attempt to call the failure callback, if one was set. This is useful when the caller wants to explicitly handle any failure that might occur without any interference with a failure callback. This method will also not attempt to call the initialize callback, thus allowing this method to be called from the initialize callback itself.
    
    Specified by:
    
    sendWithoutCallbacks in interface RemoteCommunicator
    
    Parameters:
    command - encapsulates the command that is to be executed (must not be null)
    
    Returns:
    the command response
    
    Throws:
    
    Throwable - on any error (either during the sending or execution of the command)
  - sendWithoutInitializeCallback
```
public CommandResponse sendWithoutInitializeCallback(Command command)
                                              throws Throwable
```
    Description copied from interface: RemoteCommunicator
    
    This is the same as RemoteCommunicator.send(Command) except this method will not attempt to call the initialize callback, thus allowing this method to be called from the initialize callback itself.
    
    Specified by:
    
    sendWithoutInitializeCallback in interface RemoteCommunicator
    
    Parameters:
    command - encapsulates the command that is to be executed (must not be null)
    
    Returns:
    the command response
    
    Throws:
    
    Throwable - on any error (either during the sending or execution of the command)
  - send
```
public CommandResponse send(Command command)
                     throws Throwable
```
    Description copied from interface: RemoteCommunicator
    
    Sends the given command to the remote endpoint by utilizing a remoting framework supported by the specific communicator implementation. This will transport the command to the remote endpoint. This is the method in which subclasses make the command-specific client calls necessary to invoke the command on the remote endpoint. If an error is detected by this method, and a failure callback is defined, this method will notify that callback of the problem and ask it if it should retry.
    
    Specified by:
    
    send in interface RemoteCommunicator
    
    Parameters:
    command - encapsulates the command that is to be executed (must not be null)
    
    Returns:
    the command response
    
    Throws:
    
    Throwable - on any error (either during the sending or execution of the command)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JBossRemotingRemoteCommunicator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SUBSYSTEM

Constructor Detail

JBossRemotingRemoteCommunicator

JBossRemotingRemoteCommunicator

JBossRemotingRemoteCommunicator

Method Detail

getInvokerLocator

setRemoteEndpoint

getSubsystem

getFailureCallback

setFailureCallback

getInitializeCallback

setInitializeCallback

getRemoteEndpoint

getClientConfiguration

connect

disconnect

isConnected

sendWithoutCallbacks

sendWithoutInitializeCallback

send

toString