UrlTrackerHubConnection

java.lang.Object
- org.astrogrid.samp.web.UrlTrackerHubConnection

All Implemented Interfaces:

HubConnection
```
class UrlTrackerHubConnection
extends java.lang.Object
implements HubConnection
```
HubConnection wrapper implementation which intercepts all incoming and outgoing communications, scans them for URLs in the payload, and notifies a supplied UrlTracker object.

Since:

22 Jul 2011

Author:

Mark Taylor

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`UrlTrackerHubConnection.UrlTrackerCallableClient` CallableClient wrapper implementation which intercepts communications, scans the payloads for URLs, and informs an associated UrlTracker.

Field Summary

Fields
Modifier and Type Field and Description

private HubConnection base_

private UrlTracker urlTracker_

Fields
Modifier and Type	Field and Description
`private HubConnection`	`base_`
`private UrlTracker`	`urlTracker_`

Constructor Summary

Constructors
Constructor and Description

UrlTrackerHubConnection(HubConnection base, UrlTracker urlTracker)
Constructor.

Constructors
Constructor and Description
`UrlTrackerHubConnection(HubConnection base, UrlTracker urlTracker)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`call(java.lang.String recipientId, java.lang.String msgTag, java.util.Map msg)` Sends a message to a given client expecting a response.
`java.util.Map`	`callAll(java.lang.String msgTag, java.util.Map msg)` Sends a message to all subscribed clients expecting responses.
`Response`	`callAndWait(java.lang.String recipientId, java.util.Map msg, int timeout)` Sends a message synchronously to a client, waiting for the response.
`void`	`declareMetadata(java.util.Map meta)` Declares this registered client's metadata.
`void`	`declareSubscriptions(java.util.Map subs)` Declares this registered client's MType subscriptions.
`Metadata`	`getMetadata(java.lang.String clientId)` Returns the metadata for another registered client.
`RegInfo`	`getRegInfo()` Returns the registration information associated with this connection.
`java.lang.String[]`	`getRegisteredClients()` Returns the list of client public IDs for those clients currently registered.
`java.util.Map`	`getSubscribedClients(java.lang.String mtype)` Returns a map of subscriptions for a given MType.
`Subscriptions`	`getSubscriptions(java.lang.String clientId)` Returns the subscriptions for another registered client.
`private boolean`	`isUrl(java.lang.String str)` Determines whether a given string is apparently a URL.
`void`	`notify(java.lang.String recipientId, java.util.Map msg)` Sends a message to a given client without wanting a response.
`java.util.List`	`notifyAll(java.util.Map msg)` Sends a message to all subscribed clients without wanting a response.
`void`	`ping()` Tests whether the connection is currently open.
`void`	`reply(java.lang.String msgId, java.util.Map response)` Supplies a response to a previously received message.
`private java.net.URL[]`	`scanForUrls(java.util.Map map)` Recursively scans a map for items that look like URLs and returns them as an array.
`private void`	`scanForUrls(java.lang.Object item, java.util.Collection urlSet)` Recursively scans a SAMP data item for items that look like URLs and appends them into a supplied list.
`private java.util.Map`	`scanIncoming(java.util.Map map)` Recursively scans a SAMP map for items that look like URLs, and notifies the tracker that they are incoming.
`private java.util.Map`	`scanOutgoing(java.util.Map map)` Recursively scans a SAMP map for items that look like URLs, and notifies the tracker that they are outgoing.
`void`	`setCallable(CallableClient callable)` Tells the hub how it can perform callbacks on the client by providing a CallableClient object.
`void`	`unregister()` Unregisters the client and terminates this connection.

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

- Field Detail
  - base_
```
private final HubConnection base_
```
  - urlTracker_
```
private final UrlTracker urlTracker_
```
- Constructor Detail
  - UrlTrackerHubConnection
```
public UrlTrackerHubConnection(HubConnection base,
                               UrlTracker urlTracker)
```
    Constructor.
    
    Parameters:
    
    base - connection on which this one is based
    
    urlTracker - tracker for URL usage
- Method Detail
  - scanIncoming
```
private java.util.Map scanIncoming(java.util.Map map)
```
    Recursively scans a SAMP map for items that look like URLs, and notifies the tracker that they are incoming. As a convenience the input map is returned.
    
    Parameters:
    
    map - map to scan
    
    Returns:
    
    the input map, unchanged
  - scanOutgoing
```
private java.util.Map scanOutgoing(java.util.Map map)
```
    Recursively scans a SAMP map for items that look like URLs, and notifies the tracker that they are outgoing. As a convenience the input map is returned.
    
    Parameters:
    
    map - map to scan
    
    Returns:
    
    the input map, unchanged
  - scanForUrls
```
private java.net.URL[] scanForUrls(java.util.Map map)
```
    Recursively scans a map for items that look like URLs and returns them as an array.
    
    Parameters:
    
    map - map to scan
    
    Returns:
    
    array of URLs found in map
  - scanForUrls
```
private void scanForUrls(java.lang.Object item,
                         java.util.Collection urlSet)
```
    Recursively scans a SAMP data item for items that look like URLs and appends them into a supplied list.
    
    Parameters:
    
    item - SAMP data item (String, List or Map)
    
    urlSet - list of URL objects to which URLs can be added
  - isUrl
```
private boolean isUrl(java.lang.String str)
```
    Determines whether a given string is apparently a URL.
    
    Parameters:
    
    str - string to test
    
    Returns:
    
    true iff str looks like a URL
  - setCallable
```
public void setCallable(CallableClient callable)
                 throws SampException
```
    Description copied from interface: HubConnection
    
    Tells the hub how it can perform callbacks on the client by providing a CallableClient object. This is required before the client can declare subscriptions or make asynchronous calls.
    
    Specified by:
    
    setCallable in interface HubConnection
    
    Parameters:
    
    callable - callable client
    
    Throws:
    
    SampException
  - notify
```
public void notify(java.lang.String recipientId,
                   java.util.Map msg)
            throws SampException
```
    Description copied from interface: HubConnection
    
    Sends a message to a given client without wanting a response.
    
    Specified by:
    
    notify in interface HubConnection
    
    Parameters:
    
    recipientId - public-id of client to receive message
    
    msg - Message-like map
    
    Throws:
    
    SampException
  - notifyAll
```
public java.util.List notifyAll(java.util.Map msg)
                         throws SampException
```
    Description copied from interface: HubConnection
    
    Sends a message to all subscribed clients without wanting a response.
    
    Specified by:
    
    notifyAll in interface HubConnection
    
    Parameters:
    
    msg - Message-like map
    
    Returns:
    
    list of public-ids for clients to which the notify will be sent
    
    Throws:
    
    SampException
  - call
```
public java.lang.String call(java.lang.String recipientId,
                             java.lang.String msgTag,
                             java.util.Map msg)
                      throws SampException
```
    Description copied from interface: HubConnection
    
    Sends a message to a given client expecting a response. The receiveResponse method of this connection's CallableClient will be called with a response at some time in the future.
    Only permitted if this client is already callable.
    
    Specified by:
    
    call in interface HubConnection
    
    Parameters:
    
    recipientId - public-id of client to receive message
    
    msgTag - arbitrary string tagging this message for caller's benefit
    
    msg - Message-like map
    
    Returns:
    
    message ID
    
    Throws:
    
    SampException
  - callAll
```
public java.util.Map callAll(java.lang.String msgTag,
                             java.util.Map msg)
                      throws SampException
```
    Description copied from interface: HubConnection
    
    Sends a message to all subscribed clients expecting responses. The receiveResponse method of this connection's CallableClient will be called with responses at some time in the future.
    Only permitted if this client is already callable.
    
    Specified by:
    
    callAll in interface HubConnection
    
    Parameters:
    
    msgTag - arbitrary string tagging this message for caller's benefit
    
    msg - Message-like map
    
    Returns:
    
    public-id->msg-id map for clients to which an attempt to send the call will be made
    
    Throws:
    
    SampException
  - callAndWait
```
public Response callAndWait(java.lang.String recipientId,
                            java.util.Map msg,
                            int timeout)
                     throws SampException
```
    Description copied from interface: HubConnection
    
    Sends a message synchronously to a client, waiting for the response. If more seconds elapse than the value of the timeout parameter, an exception will result.
    
    Specified by:
    
    callAndWait in interface HubConnection
    
    Parameters:
    
    recipientId - public-id of client to receive message
    
    msg - Message-like map
    
    timeout - timeout in seconds, or <0 for no timeout
    
    Returns:
    
    response
    
    Throws:
    
    SampException
  - reply
```
public void reply(java.lang.String msgId,
                  java.util.Map response)
           throws SampException
```
    Description copied from interface: HubConnection
    
    Supplies a response to a previously received message.
    
    Specified by:
    
    reply in interface HubConnection
    
    Parameters:
    
    msgId - ID associated with earlier send
    
    response - Response-like map
    
    Throws:
    
    SampException
  - getRegInfo
```
public RegInfo getRegInfo()
```
    Description copied from interface: HubConnection
    
    Returns the registration information associated with this connection.
    
    Specified by:
    
    getRegInfo in interface HubConnection
    
    Returns:
    
    registration info
  - ping
```
public void ping()
          throws SampException
```
    Description copied from interface: HubConnection
    
    Tests whether the connection is currently open.
    
    Specified by:
    
    ping in interface HubConnection
    
    Throws:
    
    SampException - if the hub has disappeared or communications are disrupted in some other way
  - unregister
```
public void unregister()
                throws SampException
```
    Description copied from interface: HubConnection
    
    Unregisters the client and terminates this connection.
    
    Specified by:
    
    unregister in interface HubConnection
    
    Throws:
    
    SampException
  - declareMetadata
```
public void declareMetadata(java.util.Map meta)
                     throws SampException
```
    Description copied from interface: HubConnection
    
    Declares this registered client's metadata.
    
    Specified by:
    
    declareMetadata in interface HubConnection
    
    Parameters:
    
    meta - Metadata-like map
    
    Throws:
    
    SampException
  - getMetadata
```
public Metadata getMetadata(java.lang.String clientId)
                     throws SampException
```
    Description copied from interface: HubConnection
    
    Returns the metadata for another registered client.
    
    Specified by:
    
    getMetadata in interface HubConnection
    
    Parameters:
    
    clientId - public id for another registered client
    
    Returns:
    
    metadata map
    
    Throws:
    
    SampException
  - declareSubscriptions
```
public void declareSubscriptions(java.util.Map subs)
                          throws SampException
```
    Description copied from interface: HubConnection
    
    Declares this registered client's MType subscriptions.
    Only permitted if this client is already callable.
    
    Specified by:
    
    declareSubscriptions in interface HubConnection
    
    Parameters:
    
    subs - Subscriptions-like map
    
    Throws:
    
    SampException
  - getSubscriptions
```
public Subscriptions getSubscriptions(java.lang.String clientId)
                               throws SampException
```
    Description copied from interface: HubConnection
    
    Returns the subscriptions for another registered client.
    
    Specified by:
    
    getSubscriptions in interface HubConnection
    
    Parameters:
    
    clientId - public id for another registered client
    
    Returns:
    
    subscriptions map
    
    Throws:
    
    SampException
  - getRegisteredClients
```
public java.lang.String[] getRegisteredClients()
                                        throws SampException
```
    Description copied from interface: HubConnection
    
    Returns the list of client public IDs for those clients currently registered.
    
    Specified by:
    
    getRegisteredClients in interface HubConnection
    
    Returns:
    
    array of client ids, excluding the one for this client
    
    Throws:
    
    SampException
  - getSubscribedClients
```
public java.util.Map getSubscribedClients(java.lang.String mtype)
                                   throws SampException
```
    Description copied from interface: HubConnection
    
    Returns a map of subscriptions for a given MType.
    
    Specified by:
    
    getSubscribedClients in interface HubConnection
    
    Parameters:
    
    mtype - MType
    
    Returns:
    
    map in which the keys are the public IDs of clients subscribed to mtype
    
    Throws:
    
    SampException

Class UrlTrackerHubConnection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

base_

urlTracker_

Constructor Detail

UrlTrackerHubConnection

Method Detail

scanIncoming

scanOutgoing

scanForUrls

scanForUrls

isUrl

setCallable

notify

notifyAll

call

callAll

callAndWait

reply

getRegInfo

ping

unregister

declareMetadata

getMetadata

declareSubscriptions

getSubscriptions

getRegisteredClients

getSubscribedClients