org.jlab.coda.cMsg.common

Class cMsgSubscription

java.lang.Object

org.jlab.coda.cMsg.common.cMsgGetHelper

org.jlab.coda.cMsg.common.cMsgSubscription

public class cMsgSubscription
extends cMsgGetHelper

This class stores a client's subscription to a particular message subject and type. Used by both the cMsg domain API and cMsg subdomain handler objects. Once the domain server object is created, the only set method called is setNamespace. Thus, this object is for all intents and purposes immutable during its lifetime.

Version:

1.0

Author:

Carl Timmer

Field Summary

Fields inherited from class org.jlab.coda.cMsg.common.cMsgGetHelper

errorCode, intVal, message, timedOut

Constructor Summary

Constructors

Constructor and Description
cMsgSubscription(java.lang.String subject, java.lang.String type) Constructor used for cMsg and rcServer domain subscribeAndGets.
cMsgSubscription(java.lang.String subject, java.lang.String type, int id, cMsgCallbackThread cbThread) Constructor used by cMsg domain API.
cMsgSubscription(java.lang.String subject, java.lang.String type, java.lang.String namespace) Constructor used by cMsg subdomain handler.

Method Summary

Modifier and Type	Method and Description
void	addCallback(cMsgCallbackThread cbThread) Method to add a callback thread.
boolean	addClientSubscriber(cMsgClientInfo client) Adds a client to the set containing only regular clients subscribed to this subject, type, and namespace.
void	addNotifier(cMsgNotifier notifier) Add a notifier object to the set of objects used to notify servers that their subscribeAndGet is complete.
void	addSubAndGetter(cMsgClientInfo client) Adds a client to the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int).
boolean	addSubscriber(cMsgClientInfo client) Adds a client to the set containing all clients (regular and bridge) subscribed to this subject, type, and namespace.
boolean	areWildCardsInSub() Returns true if there are * or ? characters in subject.
boolean	areWildCardsInType() Returns true if there are * or ? characters in type.
void	clearNotifiers() Clear all notifier objects from the set of objects used to notify servers that their subscribeAndGet is complete.
void	clearSubAndGetters() Clears the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int).
boolean	containsSubscriber(cMsgClientInfo client) Is this a subscription of the given client (regular or bridge)? Used only on the server side.
static java.lang.String	escape(java.lang.String s) This method takes a string and escapes regular expression characters with the exception of * and ? which are untouched.
static java.lang.String	escapeBar(java.lang.String s) This method takes a string and escapes | (bar (OR)).
static java.lang.String	escapeNoBar(java.lang.String s) This method takes a string and escapes regular expression characters with the exception of *, ?, and | which are untouched.
java.util.HashSet<cMsgClientInfo>	getAllSubscribers() Gets the set containing all clients (regular and bridge) subscribed to this subject, type, and namespace.
java.util.Set<cMsgCallbackThread>	getCallbacks() Gets the set storing callback threads.
java.util.HashSet<cMsgClientInfo>	getClientSubscribers() Gets the set containing only regular clients subscribed to this subject, type, and namespace.
int	getIntVal() Gets the intVal which client generates (receiverSubscribeId).
java.lang.String	getNamespace() Gets the namespace in the cMsg subdomain in which this subscription resides.
java.util.Set<cMsgNotifier>	getNotifiers() Gets the set of objects used to notify servers that their subscribeAndGet is complete.
java.util.HashMap<cMsgClientInfo,java.lang.Integer>	getSubAndGetters() Gets the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int) with this subject, type, and namespace.
java.lang.String	getSubject() Gets subject subscribed to.
java.util.regex.Pattern	getSubjectPattern() Gets subject turned into compiled regular expression pattern.
java.lang.String	getSubjectRegexp() Gets subject turned into regular expression that understands * and ?.
java.lang.String	getType() Gets type subscribed to.
java.util.regex.Pattern	getTypePattern() Gets type turned into compiled regular expression pattern.
java.lang.String	getTypeRegexp() Gets type turned into regular expression that understands * and ?.
boolean	matches(java.lang.String msgSubject, java.lang.String msgType) This method checks to see if there is a match between a given (message's) subject and type pair and this subscription's subject and type.
static boolean	matches(java.lang.String regexp, java.lang.String s, boolean escapeRegexp) This method implements a simple wildcard matching scheme where "*" means any or no characters, "?" means exactly 1 character, and "#" means 1 or no positive integer.
boolean	matchesOrig(java.lang.String msgSubject, java.lang.String msgType) This method checks to see if there is a match between a given msgSubject and msgType pair and this subscription's msgSubject and msgType.
int	numberOfCallbacks() Method to return the number of callback threads registered.
int	numberOfSubscribers() Returns the total number of subscribers and subscribeAndGet callers subscribed to this subject, type, and namespace.
void	printSizes() This method prints the sizes of all sets and maps.
void	removeCallback(cMsgCallbackThread cbThread) Method to remove a callback thread.
boolean	removeClientSubscriber(cMsgClientInfo client) Removes a client from the set containing only regular clients subscribed to this subject, type, and namespace.
void	removeNotifier(cMsgNotifier notifier) Remove a notifier object from the set of objects used to notify servers that their subscribeAndGet is complete.
void	removeSubAndGetter(cMsgClientInfo client) Removes a client from the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int).
boolean	removeSubscriber(cMsgClientInfo client) Removes a client from the set containing all clients (regular and bridge) subscribed to this subject, type, and namespace.
void	setIntVal(int id) Sets the intVal which client generates (receiverSubscribeId).
void	setNamespace(java.lang.String namespace) Sets the namespace in the cMsg subdomain in which this subscription resides.

Methods inherited from class org.jlab.coda.cMsg.common.cMsgGetHelper

getErrorCode, getMessage, isTimedOut, needToWait, setErrorCode, setMessage, setTimedOut

Methods inherited from class java.lang.Object

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

Constructor Detail

cMsgSubscription

public cMsgSubscription(java.lang.String subject,
                        java.lang.String type)

Constructor used for cMsg and rcServer domain subscribeAndGets.

Parameters:

subject - subscription subject

type - subscription type

cMsgSubscription

public cMsgSubscription(java.lang.String subject,
                        java.lang.String type,
                        java.lang.String namespace)

Constructor used by cMsg subdomain handler.

Parameters:

subject - subscription subject

type - subscription type

namespace - namespace subscription exists in

cMsgSubscription

public cMsgSubscription(java.lang.String subject,
                        java.lang.String type,
                        int id,
                        cMsgCallbackThread cbThread)

Constructor used by cMsg domain API.

Parameters:

subject - subscription subject

type - subscription type

id - unique intVal referring to subject and type combination

cbThread - object containing callback, its argument, and the thread to run it

Method Detail

escape

public static java.lang.String escape(java.lang.String s)

This method takes a string and escapes regular expression characters with the exception of * and ? which are untouched.

Parameters:

s - string to be escaped

Returns:

escaped string

escapeNoBar

public static java.lang.String escapeNoBar(java.lang.String s)

This method takes a string and escapes regular expression characters with the exception of *, ?, and | which are untouched.

Parameters:

s - string to be escaped

Returns:

escaped string

escapeBar

public static java.lang.String escapeBar(java.lang.String s)

This method takes a string and escapes | (bar (OR)).

Parameters:

s - string to be escaped

Returns:

escaped string

matches

public boolean matches(java.lang.String msgSubject,
                       java.lang.String msgType)

This method checks to see if there is a match between a given (message's) subject and type pair and this subscription's subject and type. If this subscription's subject and type has no wildcards characters, then a straight string compare is done. This subscription's subject and type may include wildcards where "*" means any or no characters, "?" means exactly 1 character, "#" means 1 or no positive integer, and a defined range (eg. {i>5 & i<10 | i=66}) matches 1 integer and applies the given logic to see if there is a match with that integer. If such wildcards exist, a match using regular expressions is done.

Parameters:

msgSubject - subject

msgType - type

Returns:

true if there is a match of both subject and type, false if there is not

matches

public static boolean matches(java.lang.String regexp,
                              java.lang.String s,
                              boolean escapeRegexp)

This method implements a simple wildcard matching scheme where "*" means any or no characters, "?" means exactly 1 character, and "#" means 1 or no positive integer.

Parameters:

regexp - subscription string that can contain wildcards (*, ?, #), null matches everything

s - message string to be matched (blank only matches *, null matches nothing)

escapeRegexp - if true, the regexp argument has regular expression chars escaped, and *, ?, # chars translated to real java regular expression syntax, else not

Returns:

true if there is a match, false if there is not

matchesOrig

public boolean matchesOrig(java.lang.String msgSubject,
                           java.lang.String msgType)

This method checks to see if there is a match between a given msgSubject and msgType pair and this subscription's msgSubject and msgType. The subscription's msgSubject and msgType may include wildcards where "*" means any or no characters and "?" means exactly 1 character. There is a match only if both msgSubject and msgType strings match their conterparts in this subscription.

Parameters:

msgSubject - msgSubject

msgType - msgType

Returns:

true if there is a match of both msgSubject and msgType, false if there is not

printSizes

public void printSizes()

This method prints the sizes of all sets and maps.

areWildCardsInSub

public boolean areWildCardsInSub()

Returns true if there are * or ? characters in subject.

Returns:

true if there are * or ? characters in subject.

areWildCardsInType

public boolean areWildCardsInType()

Returns true if there are * or ? characters in type.

Returns:

true if there are * or ? characters in type.

getSubject

public java.lang.String getSubject()

Gets subject subscribed to.

Returns:

subject subscribed to

getSubjectRegexp

public java.lang.String getSubjectRegexp()

Gets subject turned into regular expression that understands * and ?.

Returns:

subject subscribed to in regexp form

getSubjectPattern

public java.util.regex.Pattern getSubjectPattern()

Gets subject turned into compiled regular expression pattern.

Returns:

subject subscribed to in compiled regexp form

getType

public java.lang.String getType()

Gets type subscribed to.

Returns:

type subscribed to

getTypeRegexp

public java.lang.String getTypeRegexp()

Gets type turned into regular expression that understands * and ?.

Returns:

type subscribed to in regexp form

getTypePattern

public java.util.regex.Pattern getTypePattern()

Gets type turned into compiled regular expression pattern.

Returns:

type subscribed to in compiled regexp form

getIntVal

public int getIntVal()

Gets the intVal which client generates (receiverSubscribeId).

Overrides:

getIntVal in class cMsgGetHelper

Returns:

receiverSubscribeId

setIntVal

public void setIntVal(int id)

Sets the intVal which client generates (receiverSubscribeId).

Overrides:

setIntVal in class cMsgGetHelper

Parameters:

id - intVal which client generates (receiverSubscribeId)

getNamespace

public java.lang.String getNamespace()

Gets the namespace in the cMsg subdomain in which this subscription resides.

Returns:

namespace subscription resides in

setNamespace

public void setNamespace(java.lang.String namespace)

Sets the namespace in the cMsg subdomain in which this subscription resides.

Parameters:

namespace - namespace subscription resides in

getCallbacks

public java.util.Set<cMsgCallbackThread> getCallbacks()

Gets the set storing callback threads.

Returns:

set storing callback threads

addCallback

public void addCallback(cMsgCallbackThread cbThread)

Method to add a callback thread.

Parameters:

cbThread - object containing callback thread, its argument, and the thread to run it

removeCallback

public void removeCallback(cMsgCallbackThread cbThread)

Method to remove a callback thread.

Parameters:

cbThread - object containing callback thread to be removed

numberOfCallbacks

public int numberOfCallbacks()

Method to return the number of callback threads registered.

Returns:

number of callback registered

getClientSubscribers

public java.util.HashSet<cMsgClientInfo> getClientSubscribers()

Gets the set containing only regular clients subscribed to this subject, type, and namespace. Used only on the server side.

Returns:

set containing only regular clients subscribed to this subject, type, and namespace

addClientSubscriber

public boolean addClientSubscriber(cMsgClientInfo client)

Adds a client to the set containing only regular clients subscribed to this subject, type, and namespace. Used only on the server side.

Parameters:

client - regular client to be added to subscription

Returns:

true if set did not already contain client, else false

removeClientSubscriber

public boolean removeClientSubscriber(cMsgClientInfo client)

Removes a client from the set containing only regular clients subscribed to this subject, type, and namespace. Used only on the server side.

Parameters:

client - regular client to be removed from subscription

Returns:

true if set contained client, else false

getAllSubscribers

public java.util.HashSet<cMsgClientInfo> getAllSubscribers()

Gets the set containing all clients (regular and bridge) subscribed to this subject, type, and namespace. Used only on the server side.

Returns:

set containing all clients (regular and bridge) subscribed to this subject, type, and namespace

containsSubscriber

public boolean containsSubscriber(cMsgClientInfo client)

Is this a subscription of the given client (regular or bridge)? Used only on the server side.

Parameters:

client - client

Returns:

true if this is a subscription of the given client, else false

addSubscriber

public boolean addSubscriber(cMsgClientInfo client)

Adds a client to the set containing all clients (regular and bridge) subscribed to this subject, type, and namespace. Used only on the server side.

Parameters:

client - client to be added to subscription

Returns:

true if set did not already contain client, else false

removeSubscriber

public boolean removeSubscriber(cMsgClientInfo client)

Removes a client from the set containing all clients (regular and bridge) subscribed to this subject, type, and namespace. Used only on the server side.

Parameters:

client - client to be removed from subscription

Returns:

true if set contained client, else false

getSubAndGetters

public java.util.HashMap<cMsgClientInfo,java.lang.Integer> getSubAndGetters()

Gets the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int) with this subject, type, and namespace. A count is keep of how many times subscribeAndGet for a particular client has been called. The client info object is the key and count is the value. This is used on the server side.

Returns:

hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int)

addSubAndGetter

public void addSubAndGetter(cMsgClientInfo client)

Adds a client to the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int). This is used on the server side.

Parameters:

client - client who called subscribeAndGet

clearSubAndGetters

public void clearSubAndGetters()

Clears the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int). This is used on the server side.

removeSubAndGetter

public void removeSubAndGetter(cMsgClientInfo client)

Removes a client from the hashmap containing all regular clients who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int). If the client has called subscribeAndGet more than once, it's entry in the table stays but it's count of active subscribeAndGet calls is decremented. This is used on the server side.

Parameters:

client - client who called subscribeAndGet

numberOfSubscribers

public int numberOfSubscribers()

Returns the total number of subscribers and subscribeAndGet callers subscribed to this subject, type, and namespace.

Returns:

the total number of subscribers and subscribeAndGet callers subscribed to this subject, type, and namespace

getNotifiers

public java.util.Set<cMsgNotifier> getNotifiers()

Gets the set of objects used to notify servers that their subscribeAndGet is complete.

Returns:

set of objects used to notify servers that their subscribeAndGet is complete

addNotifier

public void addNotifier(cMsgNotifier notifier)

Add a notifier object to the set of objects used to notify servers that their subscribeAndGet is complete.

Parameters:

notifier - notifier object

removeNotifier

public void removeNotifier(cMsgNotifier notifier)

Remove a notifier object from the set of objects used to notify servers that their subscribeAndGet is complete.

Parameters:

notifier - notifier object

clearNotifiers

public void clearNotifiers()

Clear all notifier objects from the set of objects used to notify servers that their subscribeAndGet is complete.