Package net.sf.eBus.config

Class EConfigure.McastNotifyConfig

java.lang.Object

net.sf.eBus.config.EConfigure.McastNotifyConfig

All Implemented Interfaces:

Comparable<EConfigure.McastNotifyConfig>

Enclosing class:

EConfigure

public static final class EConfigure.McastNotifyConfig
extends Object
implements Comparable<EConfigure.McastNotifyConfig>

Contains the notification message class and subject(s) which defines the messages either published by a EConfigure.MulticastConnection or subscribed to. Subjects are defined either as a list containing one or more subjects or as a subject query pattern. A subject list is fixed and new subjects may not be added to subject list once the multicast connection is created. Subject query patterns may be either fixed or dynamic. If fixed, then the pattern is matched against existing subjects when the multicast connection is created and the matching subjects remain unchanged afterwards. If dynamic, then new subjects are compared with the subject query and, if the new subject matches the query, is added to the multicast feed.

JSON propertie used to configure a multicast notification are:

Multicast Feed JSON Properties

Property	Required?	Type	Default	Description
multifeedType	Yes	EConfigure.MultifeedType	NA	A multifeed notification feed type is either list or query.
messageClass	Yes	Class	NA	ENotificationMessage subclass name.
subjectList	Yes if multifeedType is EConfigure.MultifeedType.LIST	Array of String	NA	Non-empty list of notification subjects.
subjectQuery	Yes if multifeedType is EConfigure.MultifeedType.QUERY	String	NA	Regular expression query used to select notification subjects.
isDynamic	Yes if multifeedType is EConfigure.MultifeedType.QUERY	boolean	NA	true if query is applied to newly added subjects and false if query is used only once on multicast connection start.

Example multicast configuration configuration - query.

multifeedType : QUERY
messageClass : "net.sf.eBus.client.EquityTradeMessage"
subjectQuery : "[A-M].+"
isDynamic : true

Example multicast configuration configuration - list.

multifeedType : LIST
messageClass : "net.sf.eBus.client.TopOfBookMessage"
subjectList : [
  "ABC",
  "DEF",
  "GHI",
  "XYZ"
]

Method Summary

Modifier and Type	Method	Description
int	compareTo(EConfigure.McastNotifyConfig o)
boolean	equals(Object o)
EConfigure.MultifeedType	feedType()	Returns multi-feed type.
int	hashCode()
boolean	isDynamic()	Returns true if this is a dynamic query multi-feed.
String	messageClass()	Returns message class.
List<String>	subjectList()	Returns subject list.
Pattern	subjectQuery()	Returns notification subject query.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

compareTo

public int compareTo(EConfigure.McastNotifyConfig o)

Specified by:

compareTo in interface Comparable<EConfigure.McastNotifyConfig>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

feedType

public EConfigure.MultifeedType feedType()

Returns multi-feed type.

Returns:

multi-feed type.

messageClass

public String messageClass()

Returns message class.

Returns:

message class.

subjectList

public List<String> subjectList()

Returns subject list. Will return null if feedType() is QUERY.

Returns:

subject list.

subjectQuery

public Pattern subjectQuery()

Returns notification subject query. Will return null if feedType() is LIST.

Returns:

subject query.

isDynamic

public boolean isDynamic()

Returns true if this is a dynamic query multi-feed.

Returns:

dynamic query multi-feed flag.