CometDClient (DDF Reactor 2.11.5 API)

java.lang.Object
- org.codice.ddf.itests.common.cometd.CometDClient

public class CometDClient
extends Object

CometD client used to listen for messages on CometD channels and interact with DDF's CometD endpoint.

Below is an example on how to listen for messages on the notifications channel:

 // Creates a CometDClient that will connect to the CometD Server at the specified URL.
 CometDClient cometDClient = new CometDClient(cometDEndpointUrl);

 // Starts the cometDClient and performs the initial handshake with the CometD server
 cometDClient.start();

 // Subscribes to the notifications channel
 cometDClient.subscribe("/ddf/notifications/**"));

 // Retrieves messages on all subscribed channels (in this example, receives messages on
 // on the notifications channel).
 List messages = cometDClient.getAllMessages();

 // Shutdown the cometD Client and un-subscribes from all channels
 cometDClient.shutdown();

Constructor Summary

Constructors
Constructor and Description
`CometDClient(String url)` Creates a CometD client without authentication.
`CometDClient(String url, String realm, String username, String password)` Creates a CometD client with authentication.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelAllDownloads()` Cancels all resource downloads.
`void`	`cancelDownload(String downloadId)` Cancels a resource download.
`List<String>`	`getAllMessages()` Gets the list of messages received on all channels.
`List<String>`	`getAllMessagesInAscOrder()` Gets the list of messages received on all channels in time ascending order, i.e., from oldest to most recent.
`String`	`getClientId()` Gets the CometD client ID.
`Set<String>`	`getDownloadIds()`
`List<String>`	`getMessages(String channel)` Gets the list of messages received on a given channel.
`List<String>`	`getMessagesInAscOrder(String channel)` Gets the list of messages received on a given channel in time ascending order, i.e., from oldest to most recent.
`void`	`publish(String channel, Map<String,Object> message)` Publishes a message
`void`	`searchByMetacardId(String responseChannel, String source, String metacardId)` Publishes a search message for a specific metacard ID.
`Optional<String>`	`searchMessages(String searchCriterion)` Gets the first message that matches the search criterion
`void`	`shutdown()` Shuts down the client.
`void`	`start()` Starts the client.
`void`	`subscribe(String channel)` Subscribes to a channel.
`void`	`unsubscribe(String channel)` Un-subscribes from a channel.
`void`	`unsubscribeFromAllChannels()` Un-subscribes from all channels.

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

- Constructor Detail
  - CometDClient
```
public CometDClient(String url)
             throws Exception
```
    Creates a CometD client without authentication.
    
    Parameters:
    
    url - CometD endpoint
    
    Throws:
    
    Exception - thrown if client setup fails
  - CometDClient
```
public CometDClient(String url,
                    String realm,
                    String username,
                    String password)
             throws Exception
```
    Creates a CometD client with authentication.
    
    Parameters:
    
    url - CometD endpoint
    
    realm - security realm
    
    username - user name
    
    password - password
    
    Throws:
    
    Exception - thrown if client setup fails
- Method Detail
  - start
```
public void start()
           throws Exception
```
    Starts the client.
    
    Throws:
    
    Exception - thrown if the client fails to start
  - publish
```
public void publish(String channel,
                    Map<String,Object> message)
```
    Publishes a message
    
    Parameters:
    
    channel - channel to publish message to
    
    message - message to publish
  - subscribe
```
public void subscribe(String channel)
```
    Subscribes to a channel. Subscribing to the same channel multiple times has no effect.
    
    Parameters:
    
    channel - channel name
  - searchMessages
```
public Optional<String> searchMessages(String searchCriterion)
```
    Gets the first message that matches the search criterion
    
    Parameters:
    
    searchCriterion - a string that will be searched for in the messages
    
    Returns:
    
    the desired message if found
  - getMessages
```
public List<String> getMessages(String channel)
```
    Gets the list of messages received on a given channel.
    
    Parameters:
    
    channel - channel name
    
    Returns:
    
    list of message received since the client was started
  - getMessagesInAscOrder
```
public List<String> getMessagesInAscOrder(String channel)
```
    Gets the list of messages received on a given channel in time ascending order, i.e., from oldest to most recent.
    
    Parameters:
    
    channel - channel name
    
    Returns:
    
    list of message received since the client was started
  - getClientId
```
public String getClientId()
```
    Gets the CometD client ID.
    
    Returns:
    
    CometD client ID
  - getAllMessages
```
public List<String> getAllMessages()
```
    Gets the list of messages received on all channels.
    
    Returns:
    
    list of message received since the client was started
  - getAllMessagesInAscOrder
```
public List<String> getAllMessagesInAscOrder()
```
    Gets the list of messages received on all channels in time ascending order, i.e., from oldest to most recent.
    
    Returns:
    
    list of message received since the client was started
  - searchByMetacardId
```
public void searchByMetacardId(String responseChannel,
                               String source,
                               String metacardId)
```
    Publishes a search message for a specific metacard ID.
    
    Parameters:
    
    responseChannel - ID of the channel where the response should be sent
    
    source - source to query
    
    metacardId - ID of the metacard to retrieve
  - cancelDownload
```
public void cancelDownload(String downloadId)
```
    Cancels a resource download.
    
    Parameters:
    
    downloadId - ID of the download to cancel
  - cancelAllDownloads
```
public void cancelAllDownloads()
```
    Cancels all resource downloads.
  - unsubscribe
```
public void unsubscribe(String channel)
```
    Un-subscribes from a channel. Un-subscribing from the same channel multiple has no effect.
    
    Parameters:
    
    channel - channel name
  - unsubscribeFromAllChannels
```
public void unsubscribeFromAllChannels()
```
    Un-subscribes from all channels.
  - shutdown
```
public void shutdown()
              throws Exception
```
    Shuts down the client.
    
    Throws:
    
    Exception - thrown if the shutdown fails
  - getDownloadIds
```
public Set<String> getDownloadIds()
```

Class CometDClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CometDClient

CometDClient

Method Detail

start

publish

subscribe

searchMessages

getMessages

getMessagesInAscOrder

getClientId

getAllMessages

getAllMessagesInAscOrder

searchByMetacardId

cancelDownload

cancelAllDownloads

unsubscribe

unsubscribeFromAllChannels

shutdown

getDownloadIds