Caplin Systems - Index (DataSource for Java 6.2.9-657-b01314d API Reference)

A B C D E F G H I J L M N O P R S T U V W

A

ActivePublisher - Interface in com.caplin.datasource.publisher: This implementation of Publisher publishes updates that are for subjects within its associated Namespace, to all peers that have subscribed to those subjects.
ActiveSubscription - Interface in com.caplin.datasource.subscription: A ActiveSubscriptions represents a subscription to a single subjects.
add(Object) - Method in class com.caplin.management.jmx.relations.RelationSet: Adds the specified element to this set if it is not already present.
addAll(Collection) - Method in class com.caplin.management.jmx.relations.RelationSet: Adds all of the elements in the specified collection to this set if they're not already present.
addChannelListener(Namespace, ChannelListener) - Method in interface com.caplin.datasource.DataSource: Registers a ChannelListener for a specified namespace.
addConnectionListener(ConnectionListener) - Method in interface com.caplin.datasource.DataSource: Adds a connection listener that receives status events about the state of the DataSource application's connection to other peers.
addElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Adds an element with the given subject to the container.
addElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerModel: Called to indicate that you should add (append) an element with the given subject to the container.
addExcludeRegex(String) - Method in class com.caplin.datasource.namespace.RegexNamespace: Adds an exclude regex pattern to the namespace.
addGenericChannelListener(Namespace, ChannelListener) - Method in interface com.caplin.datasource.DataSource: Registers a ChannelListener for a specified namespace.
addIncludeRegex(String) - Method in class com.caplin.datasource.namespace.RegexNamespace: Adds an include regex pattern to the namespace.
addLatencyChainPoint(String, long) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Adds a latency chain point
addMBeanManyRelation(String, Object, Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Adds a bean relationship which links a parentObject to a childObject, this has to be added to an existing one-to-many relationship
addMBeanManyRelation(String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
addMBeanManyRelation(String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
addMessage(Message) - Method in interface com.caplin.datasource.messaging.record.WrapperMessage: Adds a message to the WrapperMessage, the first message defines the message type.
addRelationshipAttribute(Attribute, String) - Method in class com.caplin.management.jmx.JMXBeanWrapper: Add relationship attribute to this bean
addUpdateListener(RelationSetUpdateListener) - Method in class com.caplin.management.jmx.relations.RelationSet: Adds the specified RelationSetUpdateListener to the RelationSet.

B

BaseSubscriptionListener - Class in com.caplin.datasource.subscription: A base implementation of SubscriptionListener that can be used to easily provide SubscriptionListener implementations without the need to override every method.
BaseSubscriptionListener(Logger) - Constructor for class com.caplin.datasource.subscription.BaseSubscriptionListener: Creates a BaseSubscriptionListener that uses the provided Logger to log warnings about callbacks made on methods that have not been overridden.
BroadcastPublisher - Interface in com.caplin.datasource.publisher: This implementation of Publisher sends (broadcasts) updates to all connected peers regardless of whether they have requested (subscribed to) the subject.
BroadcastSubscription - Interface in com.caplin.datasource.subscription: A BroadcastSubscription represents a subscription to many subjects.

C

Channel - Interface in com.caplin.datasource.channel: Channels provide a bi-directional communication mechanism between StreamLink clients and DataSource applications.
ChannelListener - Interface in com.caplin.datasource.channel: Interface that must be implemented in order to perform bi-directional communication with a StreamLink client.
clear() - Method in class com.caplin.management.jmx.relations.RelationSet: Removes all of the elements from this set.
clearFields() - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Removes all the fields previously added to this RecordMessage
com.caplin.datasource - package com.caplin.datasource
com.caplin.datasource.channel - package com.caplin.datasource.channel: The Channel package consists of interfaces allowing creation and maintenance of Channels that provide a bi-directional communication mechanism between StreamLink clients and DataSource applications
com.caplin.datasource.fields - package com.caplin.datasource.fields
com.caplin.datasource.messaging - package com.caplin.datasource.messaging: Defines the message types that are used by DataSource for Java.
com.caplin.datasource.messaging.container - package com.caplin.datasource.messaging.container: This package defines the interfaces for sending Container messages.
com.caplin.datasource.messaging.mapping - package com.caplin.datasource.messaging.mapping: This package defines the interfaces for sending Mapping messages.
com.caplin.datasource.messaging.news - package com.caplin.datasource.messaging.news: This package defines the interfaces for sending News messages.
com.caplin.datasource.messaging.page - package com.caplin.datasource.messaging.page: This package defines the interfaces for sending Page messages.
com.caplin.datasource.messaging.permission - package com.caplin.datasource.messaging.permission: This package defines the interfaces for sending Permission messages.
com.caplin.datasource.messaging.record - package com.caplin.datasource.messaging.record: This package defines the interfaces for sending Record messages.
com.caplin.datasource.messaging.story - package com.caplin.datasource.messaging.story: This package defines the interfaces for sending Story messages.
com.caplin.datasource.namespace - package com.caplin.datasource.namespace: Namespaces are used to determine if a subject is of interest to an DataProvider.
com.caplin.datasource.publisher - package com.caplin.datasource.publisher: Defines the methods of providing and publishing data that are used by DataSource for Java.
com.caplin.datasource.subscription - package com.caplin.datasource.subscription: Defines the interfaces and classes that are used by a Java DataSource application when it needs to subscribe to data provided by another DataSource application.
com.caplin.management - package com.caplin.management
com.caplin.management.jmx - package com.caplin.management.jmx: Provides classes that help manage the Caplin JMX implementation of adding MBeans, MBean relationships and MBeanServer.
com.caplin.management.jmx.encoder - package com.caplin.management.jmx.encoder: Provides classes that should be used to encode and decode that values contained within ObjectNames.
com.caplin.management.jmx.relations - package com.caplin.management.jmx.relations: Defines the classes used to represent "to many" relationships within the Caplin JMX implementation.
com.caplin.management.jmx.relations.links - package com.caplin.management.jmx.relations.links: Provides classes that represent a relationship to a specific MBean.
CommonJMXVersion - Class in com.caplin.management
CompatibilityPublisher - Interface in com.caplin.datasource.publisher: This implementation of Publisher is similar to ActivePublisher, but because it does not maintain a cache, it passes all requests and discards for subjects on to the DataProvider.
ComplexObjectNameLink - Interface in com.caplin.management.jmx.relations.links: Represents a more complex relationship between two MBeans than can be represented by an ObjectNameLink.
ConnectionListener - Interface in com.caplin.datasource: This interface allows applications to receive events about the state of DataSource for Java's connection to other DataSource peers.
ContainerMessage - Interface in com.caplin.datasource.messaging.container: An instance of ContainerMessage represents an update to a container.
ContainerModel - Interface in com.caplin.datasource.messaging.container: This interface defines a model that represents a container.
ContainerOperation - Interface in com.caplin.datasource.messaging.container: Interface that represents a container operation.
ContainerOperationType - Enum in com.caplin.datasource.messaging.container
containerUpdated(Subscription, Peer, ContainerMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
containerUpdated(Subscription, Peer, ContainerMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when a container update is received.
contains(Object) - Method in class com.caplin.management.jmx.relations.RelationSet: Returns true if this set contains the specified element.
containsAll(Collection) - Method in class com.caplin.management.jmx.relations.RelationSet: Returns true if this set contains all of the elements of the specified collection.
containsField(String) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Determines whether the permission message contains the specified field.
containsField(String) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Determines whether the message contains the specified field
createActivePublisher(Namespace, DataProvider) - Method in interface com.caplin.datasource.DataSource: Creates an ActivePublisher for the specified namespace.
createActiveSubscription(String, SubscriptionListener) - Method in interface com.caplin.datasource.DataSource: Creates an active subscription to an individual subject.
createBroadcastPublisher(Namespace) - Method in interface com.caplin.datasource.DataSource: Creates a BroadcastPublisher for the specified namespace.
createBroadcastSubscription(Namespace, SubscriptionListener) - Method in interface com.caplin.datasource.DataSource: Creates a subscription to many subjects.
createCompatibilityPublisher(Namespace, DataProvider) - Method in interface com.caplin.datasource.DataSource: Creates a CompatibilityPublisher for the specified namespace.
createContainerMessage(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a message that defines a container.
createDataSource(String, String, Logger) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration file, fields definition file, and Logger.
createDataSource(String, String) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration file and fields definition file.
createDataSource(String[]) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied command options.
createDataSource(String[], Logger) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied command options and Logger.
createDataSource(String) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration string.
createDataSource(String, Logger) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration string and Logger.
createGenericMessage(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates an empty Generic message to which structured data can be added.
createMappingMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a MappingMessage for mapping subjects
createMBeanManyRelation(String, String, Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Creates an empty one-to-many bean relation for a parentObject with an attribute name
createMBeanManyRelation(String, String, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
createMBeanManyRelation(String, String, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
createMBeanOneRelation(String, String, Object, Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Creates an one-to-one bean relation linking a parentObject to a childObject with an attribute name
createMBeanOneRelation(String, String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
createMBeanOneRelation(String, String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
createMessage(String) - Method in interface com.caplin.datasource.channel.Channel: Creates a Generic Message.
createNewsMessage(String, String, String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a News message for the given subject.
createPageMessage(String, int, int) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Page message for the given subject.
createPermissionMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Permission message for the given subject.
createRecordMessage(String) - Method in interface com.caplin.datasource.channel.Channel: Creates a type 1 record message.
createRecordType1Message(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Record message to which Type 1 structured data can be added.
createRecordType2Message(String, String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Record message to which Type 2 structured data can be added.
createRecordType3Message(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Record message to which Type 3 structured data can be added.
createStoryMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Story message for the given subject.
createSubjectErrorEvent(String, SubjectError, SubjectError.Flags...) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a subject error event.
createSubjectErrorEvent(String, SubjectError) - Method in interface com.caplin.datasource.messaging.MessageFactory
createSubjectStatusEvent(String, SubjectStatus, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a subject status event.
createWrapperMessage(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Wrapper message for the given subject.

D

DataProvider - Interface in com.caplin.datasource.publisher: Interface that must be implemented in order to provide data updates to DataSource peers.
DataSource - Interface in com.caplin.datasource: This is the main interface of DataSource for Java.
DataSourceConfiguration - Interface in com.caplin.datasource: This interface allows public access to values inside a DataSource configuration file.
DataSourceFactory - Class in com.caplin.datasource: A factory used to create DataSource instances.
decodeValue(String) - Method in interface com.caplin.management.jmx.encoder.ObjectNameEncoder: Decodes an ObjectName value that was encoded with the ObjectNameEncoder.encodeValue(String) method.
decodeValue(String) - Method in class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor.DefaultObjectNameEncoder
DiscardEvent - Interface in com.caplin.datasource.publisher: Event that is raised when a peer discards a subject.
DS_FIELDS_NOT_DEFINED - Static variable in interface com.caplin.datasource.fields.FieldInfo

E

ELEMENT_ADDED - Static variable in class com.caplin.management.jmx.relations.RelationSetNotification: Notification type which indicates that an element has been added to the observed RelationSet attribute.
ELEMENT_ADDED_TYPE - Static variable in class com.caplin.management.jmx.relations.RelationSetNotification.NotificationType: Represents an element added notification (see RelationSetNotification.ELEMENT_ADDED).
ELEMENT_REMOVED - Static variable in class com.caplin.management.jmx.relations.RelationSetNotification: Notification type which indicates that an element has been removed from the observed RelationSet attribute.
ELEMENT_REMOVED_TYPE - Static variable in class com.caplin.management.jmx.relations.RelationSetNotification.NotificationType: Represents an element removed notification (see RelationSetNotification.ELEMENT_REMOVED).
elementAdded(Object, String) - Method in interface com.caplin.management.jmx.relations.RelationSetUpdateListener: Invoked when an element is added to the RelationSet this listener has been registered with.
elementRemoved(Object, String) - Method in interface com.caplin.management.jmx.relations.RelationSetUpdateListener: Invoked when an element is removed from the RelationSet this listener has been registered with.
encodeValue(String) - Method in interface com.caplin.management.jmx.encoder.ObjectNameEncoder: Encodes the specified value so that it can be included within an ObjectName.
encodeValue(String) - Method in class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor.DefaultObjectNameEncoder
equals(Object) - Method in class com.caplin.management.jmx.relations.links.ObjectNameLinkImpl: Compares this ObjectNameLinkImpl to another one.
equals(Object) - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Compares this SubscriptionLink to another one.
equals(Object) - Method in class com.caplin.management.jmx.relations.RelationSetNotificationFilter: Compares this RelationSetNotificationFilter to another one.

F

Field - Interface in com.caplin.datasource.messaging: Represents a name/value field pair.
FieldInfo - Interface in com.caplin.datasource.fields: This interface allows access to fields name and numbers configured in Fields.xml or fields.conf files.
FieldInfoImpl - Class in com.caplin.datasource.fields
FieldInfoImpl(int, String) - Constructor for class com.caplin.datasource.fields.FieldInfoImpl
FieldManager - Interface in com.caplin.datasource.fields: This interface allows access to fields name and numbers configured in Fields.xml or fields.conf files.
FieldManagerImpl - Class in com.caplin.datasource.fields
FieldManagerImpl(DataSourceState) - Constructor for class com.caplin.datasource.fields.FieldManagerImpl

G

GenericMessage - Interface in com.caplin.datasource.messaging.record: Interface for sending Generic messages, adding fields by name and value.
genericMessageUpdated(Subscription, Peer, GenericMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
genericMessageUpdated(Subscription, Peer, GenericMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when an update to generic message data is received.
getAppName() - Method in interface com.caplin.datasource.DataSourceConfiguration
getAttribute(String) - Method in class com.caplin.management.jmx.JMXBeanWrapper
getAttributeName() - Method in class com.caplin.management.jmx.relations.RelationSetNotification: Gets the name of the attribute that this notification applies to.
getAttributes(String[]) - Method in class com.caplin.management.jmx.JMXBeanWrapper
getBitFlag() - Method in enum com.caplin.datasource.SubjectError.Flags
getBooleanArrayValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as an List of Boolean.
getBooleanValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a boolean.
getBooleanValue(String, boolean) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a boolean.
getBuildDate() - Method in class com.caplin.management.CommonJMXVersion
getBuildNumber() - Method in class com.caplin.management.CommonJMXVersion
getBuildTime() - Method in class com.caplin.management.CommonJMXVersion
getCachedObject() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the name of the cached object this subscription is for.
getCachedObjectObjectName() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the ObjectName of the cached object MBean this object links to.
getColumn() - Method in interface com.caplin.datasource.messaging.page.PageElement: The column (horizontal) coordinate of the start of the updated region.
getCommandOption(String, String...) - Method in interface com.caplin.datasource.DataSource: Retrieves the value of a DataSource command option.
getConfiguration() - Method in interface com.caplin.datasource.DataSource: Retrieves configuration on datasource.conf file
getCopyright() - Method in class com.caplin.management.CommonJMXVersion
getDeleteEntryFlag() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message: Gets a value indicating whether this Type2 index should be deleted.
getDeletePermissionKey() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Gets a value indicating whether this permission message specifies that the permission key should be deleted from the Liberator's cache.
getDoubleArrayValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a List of Double.
getDoubleValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a double.
getDoubleValue(String, double) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a double.
getElementPosition() - Method in interface com.caplin.datasource.messaging.container.ContainerOperation: If this is an insert operation, this method returns the position in the container where the element is to be inserted (the first position is position 0).
getElementSubject() - Method in interface com.caplin.datasource.messaging.container.ContainerOperation: Gets the subject of the element that this operation relates to.
getElementType() - Method in class com.caplin.management.jmx.relations.RelationSetNotification: Gets the fully qualified class name of the object returned by RelationSetNotification.getElementValue().
getElementValue() - Method in class com.caplin.management.jmx.relations.RelationSetNotification: Gets the object that represents the element that was added to or removed from the RelationSet.
getError() - Method in interface com.caplin.datasource.SubjectErrorEvent: Gets the SubjectError relating to the SubjectErrorEvent.
getField(String) - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Gets a custom field from a news message
getField(String) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Gets a specified field within this permission message.
getField(String) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Gets the value of the specified field.
getFieldByName(String) - Method in interface com.caplin.datasource.fields.FieldManager: Given the field's name, returns a structure containing both the field's name and number.
getFieldByName(String) - Method in class com.caplin.datasource.fields.FieldManagerImpl
getFieldByNumber(int) - Method in interface com.caplin.datasource.fields.FieldManager: Given the field's number, returns a structure containing both the field's name and number.
getFieldByNumber(int) - Method in class com.caplin.datasource.fields.FieldManagerImpl
getFieldManager() - Method in interface com.caplin.datasource.DataSource: Gets the datasource field manager
getFields() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Gets the fields within this permission message.
getFields() - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Gets the fields within this RecordMessage.
getGlobal() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Gets a value indicating whether this PermissionMessage is a global permission message.
getHeadline() - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Gets the headline of the news message.
getHeight() - Method in interface com.caplin.datasource.messaging.page.PageMessage: Gets the height of the page, in text rows.
getHelperObjectName() - Method in interface com.caplin.management.jmx.relations.links.ComplexObjectNameLink: Gets the ObjectName of the MBean that can be used to get additonal information about the relationship represented by this object.
getHelperObjectName() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink
getIndex() - Method in interface com.caplin.datasource.Peer: Gets the index of this peer.
getInnerObject() - Method in class com.caplin.management.jmx.JMXBeanWrapper: Access to the wrapped bean
getInstance() - Static method in class com.caplin.management.CommonJMXVersion
getIntegerArrayValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as an List of Integer.
getIntValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as an int.
getIntValue(String, int) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a int.
getLinkName() - Method in interface com.caplin.management.jmx.relations.links.ObjectNameLink: Gets a human readable name for the MBean that this instance of ObjectNameLink represents a link to.
getLinkName() - Method in class com.caplin.management.jmx.relations.links.ObjectNameLinkImpl
getLinkName() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink
getLogger() - Method in interface com.caplin.datasource.DataSource: Gets the logger used by DataSource for Java.
getMapping() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage: Gets the mapped-to subject for the message.
getMBeanInfo() - Method in class com.caplin.management.jmx.JMXBeanWrapper
getMBeanServer() - Method in interface com.caplin.datasource.DataSource: Retrieves the MBeanServer used for JMX monitoring by the DataSource.
getMessage() - Method in interface com.caplin.datasource.SubjectStatusEvent: Gets the subject status message.
getMessageFactory() - Method in interface com.caplin.datasource.publisher.Publisher: Gets the MessageFactory used to create the messages that are published via this Publisher.
getMessageQueueSize() - Method in interface com.caplin.datasource.Peer: Gets the current number of queued messages on the peer.
getMessages() - Method in interface com.caplin.datasource.messaging.record.WrapperMessage: Returns the list of messages in the order they were added.
getName() - Method in interface com.caplin.datasource.fields.FieldInfo
getName() - Method in class com.caplin.datasource.fields.FieldInfoImpl
getName() - Method in interface com.caplin.datasource.messaging.Field: Gets the field name.
getName() - Method in interface com.caplin.datasource.Peer: Gets the name of this peer.
getName() - Method in class com.caplin.management.CommonJMXVersion
getNamespace() - Method in interface com.caplin.datasource.subscription.BroadcastSubscription: Gets the namespace for this subscription.
getNewsDateTime() - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Gets the date and time that the headline was created.
getNotificationFilter() - Method in class com.caplin.management.jmx.relations.RelationSet: Gets a notification filter that will only enable notifications that apply to this RelationSet.
getNotificationListener() - Method in class com.caplin.management.jmx.relations.RelationSet: Gets a notification listener that will automatically process any Notifications it receives to update this RelationSet's internal state.
getNumber() - Method in interface com.caplin.datasource.fields.FieldInfo
getNumber() - Method in class com.caplin.datasource.fields.FieldInfoImpl
getNumber() - Method in interface com.caplin.datasource.messaging.Field: Gets the field number.
getObjectName() - Method in interface com.caplin.management.jmx.relations.links.ObjectNameLink: Gets the ObjectName of the MBean that this instance of ObjectNameLink represents a link to.
getObjectName() - Method in class com.caplin.management.jmx.relations.links.ObjectNameLinkImpl
getObjectName() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink
getObjectNameEncoder() - Static method in class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor: Gets the ObjectNameEncoder the should be used to encode and decode ObjectName values.
getOperations() - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Gets a list of container operations.
getPageType() - Method in interface com.caplin.datasource.messaging.page.PageMessage: Gets the type of the page.
getPeer() - Method in interface com.caplin.datasource.channel.Channel: Gets the peer that opened the channel.
getPeer() - Method in interface com.caplin.datasource.PeerStatusEvent: Gets the Peer that has changed state.
getPeer() - Method in interface com.caplin.datasource.publisher.DiscardEvent: Gets the Peer that is discarding the subject.
getPeer() - Method in interface com.caplin.datasource.publisher.RequestEvent: Gets the Peer that is requesting the subject.
getPeers() - Method in interface com.caplin.datasource.DataSource: Retrieves a set of all peers configured to connect to this DataSource.
getPeersInOrder() - Method in interface com.caplin.datasource.DataSource: Retrieves a list of all peers configured to connect to this DataSource.
getPeerStatus() - Method in interface com.caplin.datasource.Peer: Gets the status that the peer has changed state to.
getPeerStatus() - Method in interface com.caplin.datasource.PeerStatusEvent: Gets the status that the peer has changed state to.
getPermission() - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Gets a permission string relating to this news message.
getPermissionKey() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Gets the permission key.
getRow() - Method in interface com.caplin.datasource.messaging.page.PageElement: The row (vertical) cooordinate of the start of the updated region.
getSessionId() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the unique identifier for the session this subscription has been made from.
getSessionObjectName() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the ObjectName of the user session MBean this object links to.
getStatus() - Method in interface com.caplin.datasource.SubjectStatusEvent: Gets the status of the subject.
getStoryReference() - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Gets a reference that identifies the story associated with the headline.
getStringArrayValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as an List of String.
getStringArrayValueExpanded(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as an List of String.
getStringValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a string.
getStringValue(String, String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the last value of the requested field as a string.
getStringValueExpanded(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the last value of the requested field as a string.
getStringValueExpanded(String, String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the last value of the requested field as a string.
getSubject() - Method in interface com.caplin.datasource.channel.Channel: Gets the subject of this channel.
getSubject() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage
getSubject() - Method in interface com.caplin.datasource.messaging.Message: Gets the subject of this message.
getSubject() - Method in interface com.caplin.datasource.publisher.DiscardEvent: Gets the subject that is being discarded.
getSubject() - Method in interface com.caplin.datasource.publisher.RequestEvent: Gets the subject that is being requested.
getSubject() - Method in interface com.caplin.datasource.SubjectErrorEvent: Gets the subject of the subscription relating to the SubjectErrorEvent.
getSubject() - Method in interface com.caplin.datasource.SubjectStatusEvent: Gets the subject that this SubjectStatusEvent relates to.
getSubject() - Method in interface com.caplin.datasource.subscription.ActiveSubscription: Gets the subject for this subscription.
getSubscriptionId() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the unique identifier for the session this subscription has been made from.
getSubscriptionListener() - Method in interface com.caplin.datasource.subscription.Subscription: Gets the subscription listener for this subscription.
getSubscriptionName() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the name of the object subscribed to by the client.
getTags() - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Gets a reference to the set of keywords or terms that describe the news item.
getText() - Method in interface com.caplin.datasource.messaging.page.PageElement: Gets the updated text for the region of the Page.
getText() - Method in interface com.caplin.datasource.messaging.story.StoryMessage: Gets the text of the news story.
getType() - Method in interface com.caplin.datasource.messaging.container.ContainerOperation: Gets the type of the container operation, which can be an add, remove, insert or remove with prefix.
getType() - Method in class com.caplin.management.jmx.relations.RelationSetNotification.NotificationType: Gets the string representation of the notification type.
getType2Index() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message: Retrieves the Type2 index value.
getType2IndexField() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message: Retrieves the fieldname that is used for the Type2 index.
getUpdatedElements() - Method in interface com.caplin.datasource.messaging.page.PageMessage: Gets a read-only list of the updated page elements.
getValue() - Method in interface com.caplin.datasource.messaging.Field: Gets the field value.
getVersion() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage: Gets the version of the message.
getVersion() - Method in class com.caplin.management.CommonJMXVersion
getWidth() - Method in interface com.caplin.datasource.messaging.page.PageMessage: Gets the width of the page, in text columns.

H

hashCode() - Method in class com.caplin.management.jmx.relations.links.ObjectNameLinkImpl: Returns a hash code value for the object.
hashCode() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Returns a hash code value for the object.
hashCode() - Method in class com.caplin.management.jmx.relations.RelationSetNotificationFilter: Returns a hash code value for the object.

I

insertElement(String, int) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Inserts an element with the given subject at the given position within the container.
insertElement(String, int) - Method in interface com.caplin.datasource.messaging.container.ContainerModel: Called to indicate that you should insert an element with the given subject at the given position within the container.
invoke(String, Object[], String[]) - Method in class com.caplin.management.jmx.JMXBeanWrapper
isDoNotAuthenticate() - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Gets a boolean value indicating whether subscriptions to this ContainerMessage's constituents should be authenticated by an authentication module when the container is subscribed to.
isEmpty() - Method in class com.caplin.management.jmx.relations.RelationSet: Returns true if this set contains no elements.
isImage() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage
isImage() - Method in interface com.caplin.datasource.messaging.Message: Gets a boolean value indicating whether this Message represents an image or an update.
isNoCache() - Method in interface com.caplin.datasource.messaging.record.GenericMessage: Gets whether this Generic message should be cached in the DataSource (both remote and local ).
isNoCache() - Method in interface com.caplin.datasource.messaging.record.RecordType1Message: Gets whether this type1 record message should be cached in the DataSource (both remote and local ).
isNotificationEnabled(Notification) - Method in class com.caplin.management.jmx.relations.RelationSetNotificationFilter: Determines whether the specified notification is enabled by this filter or not.
iterator() - Method in class com.caplin.management.jmx.relations.RelationSet: Returns an iterator over the elements in this set.

J

JMXBean - Annotation Type in com.caplin.management.jmx: Annotation type used to mark and describe a class as a JMX bean.
JMXBeanAttribute - Annotation Type in com.caplin.management.jmx: Annotation used to mark and describe JMX bean attributes, by marking methods in a class.
JMXBeanKey - Annotation Type in com.caplin.management.jmx: Annotation applied to a getter method inside an annotated JMXBean class.
JMXBeanOperation - Annotation Type in com.caplin.management.jmx: Annotation used to mark and describe a JMX bean operation.
JMXBeanOperation.IMPACT_TYPES - Enum in com.caplin.management.jmx: An enumeration of possible JMX impact types, used in JMXBeanOperation.impactType().
JMXBeanParameter - Annotation Type in com.caplin.management.jmx: Annotation used to describe a JMX bean operation parameter.
JMXBeanWrapper - Class in com.caplin.management.jmx: This is a wrapper class that wraps a normal Java object into a JMX dynamic bean by using Java annotations.
JMXBeanWrapper(Object) - Constructor for class com.caplin.management.jmx.JMXBeanWrapper: Creates a new dynamic JMX bean on the basis of an annotated class.

L

logger - Variable in class com.caplin.datasource.subscription.BaseSubscriptionListener: Provides protected access to the logger that was passed to the constructor.
LongAttributeListener - Interface in com.caplin.management.jmx: This interface is for registering with MBeanServerManagerImpl.registerLongAttributeChangedListener(String, LongAttributeListener) and will receive callbacks to LongAttributeListener.onChanged(Long) when MBeanServerManagerImpl.notifyLongAttributeChanged(String, Long) is invoked with a matching attributeName.

M

main(String[]) - Static method in class com.caplin.datasource.DataSourceFactory: Used to start the datasource and read the configuration file so the resultant configuration attribute values can be returned using the --get-config-value="attribute name" command line option.
MappingMessage - Interface in com.caplin.datasource.messaging.mapping: Interface for sending MappingMessages.
match(String) - Method in interface com.caplin.datasource.namespace.Namespace: Tests a String to see if it falls within this Namespace.
match(String) - Method in class com.caplin.datasource.namespace.PrefixNamespace: Tests a String to see if it falls within this Namespace.
match(String) - Method in class com.caplin.datasource.namespace.RegexNamespace: Tests a String to see if it falls within this Namespace.
MBeanServerManager - Interface in com.caplin.management.jmx: This is an interface for a wrapper class, MBeanServerManagerImpl that wraps an Java MBeanServer and provides several useful abstractions.
MBeanServerManagerFactory - Class in com.caplin.management.jmx
MBeanServerManagerFactory() - Constructor for class com.caplin.management.jmx.MBeanServerManagerFactory
MBeanServerManagerImpl - Class in com.caplin.management.jmx
MBeanServerManagerNullImpl - Class in com.caplin.management.jmx
Message - Interface in com.caplin.datasource.messaging: A Message represents a DataSource message containing an update to an existing subject or a complete image of it.
MessageFactory - Interface in com.caplin.datasource.messaging: A message factory is used to create DataSource messages that can be published to other DataSources.

N

Namespace - Interface in com.caplin.datasource.namespace: A Namespace is used to determine if a subject is of interest to an DataProvider.
newInstance(MBeanServer, String, Logger) - Static method in class com.caplin.management.jmx.MBeanServerManagerFactory: Creates a new MBeanServerManager with which to register JMXBean annotated objects.
NewsMessage - Interface in com.caplin.datasource.messaging.news: An instance of NewsMessage defines the headline text that provides a brief description of a news story (see StoryMessage).
newsUpdated(Subscription, Peer, NewsMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
newsUpdated(Subscription, Peer, NewsMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when a news headline update is received.
notifyLongAttributeChanged(String, Long) - Method in interface com.caplin.management.jmx.MBeanServerManager: Notifies registered listeners of long attribute changes
notifyLongAttributeChanged(String, Long) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
notifyLongAttributeChanged(String, Long) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
notifyMBeanAttributeChanged(String, Object, Object, Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Notifies JMX Clients of a change to a specified attribute
notifyMBeanAttributeChanged(String, Object, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
notifyMBeanAttributeChanged(String, Object, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl

O

OBJECT_NAME_ENCODER_CLASS_PROPERTY_NAME - Static variable in class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor: The name of the system property that must be used to specify the fully qualified class name of the ObjectNameEncoder that should be used to encode ObjectName values.
ObjectNameEncoder - Interface in com.caplin.management.jmx.encoder: Defines methods that should be used to encode and decode values included within an ObjectName.
ObjectNameEncoderAccessor - Class in com.caplin.management.jmx.encoder: Accessor class that should be used to get the ObjectNameEncoder that will be used to encode and decode ObjectName values.
ObjectNameEncoderAccessor.DefaultObjectNameEncoder - Class in com.caplin.management.jmx.encoder: Standard ObjectNameEncoder that will be used if the ObjectNameEncoderAccessor.OBJECT_NAME_ENCODER_CLASS_PROPERTY_NAME system property is not set, or if there is a problem with the specified class.
ObjectNameEncoderAccessor.DefaultObjectNameEncoder() - Constructor for class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor.DefaultObjectNameEncoder
ObjectNameLink - Interface in com.caplin.management.jmx.relations.links: Represents a relationship between one MBean and another.
ObjectNameLinkImpl - Class in com.caplin.management.jmx.relations.links: Default implementation of the ObjectNameLink interface.
ObjectNameLinkImpl(ObjectName, String) - Constructor for class com.caplin.management.jmx.relations.links.ObjectNameLinkImpl: Constructs an ObjectNameLinkImpl with the specified ObjectName and human readable link name.
onChanged(Long) - Method in interface com.caplin.management.jmx.LongAttributeListener
onChannelClose(Channel) - Method in interface com.caplin.datasource.channel.ChannelListener: Callback that informs the ChannelListener that a StreamLink client wishes to close a channel.
onChannelOpen(Channel) - Method in interface com.caplin.datasource.channel.ChannelListener: Callback that informs the ChannelListener that a StreamLink client wishes to open a channel.
onDiscard(DiscardEvent) - Method in interface com.caplin.datasource.publisher.DataProvider: Callback that informs the DataProvider that an earlier requested subject has now been discarded.
onMessageReceived(Channel, RecordMessage) - Method in interface com.caplin.datasource.channel.ChannelListener: Callback that informs the ChannelListener that a StreamLink client has sent a message to the DataSource via a specified channel.
onPeerStatus(PeerStatusEvent) - Method in interface com.caplin.datasource.ConnectionListener: Invoked when a DataSource peer changes state.
onRequest(RequestEvent) - Method in interface com.caplin.datasource.publisher.DataProvider: Callback that informs the DataProvider that a new request has been received and it should start sending data.

P

PageElement - Interface in com.caplin.datasource.messaging.page: Interface that represents an update to a region of a Page.
PageMessage - Interface in com.caplin.datasource.messaging.page: An instance of PageMessage represents updates to a Page subject.
pageUpdated(Subscription, Peer, PageMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
pageUpdated(Subscription, Peer, PageMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when a page update is received.
Peer - Interface in com.caplin.datasource: Represents a DataSource peer.
PeerStatus - Enum in com.caplin.datasource: Enumeration that defines the states of a DataSource Peer.
PeerStatusEvent - Interface in com.caplin.datasource: Event raised when a peer changes status.
PermissionMessage - Interface in com.caplin.datasource.messaging.permission: Interface that represents a Permission message.
permissionUpdated(Subscription, Peer, PermissionMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
permissionUpdated(Subscription, Peer, PermissionMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when when a permission update is received.
PrefixNamespace - Class in com.caplin.datasource.namespace: The prefix namespace matches the initial part of a subject name.
PrefixNamespace(String) - Constructor for class com.caplin.datasource.namespace.PrefixNamespace: Initializes a new instance of the PrefixNamespace class.
Publisher - Interface in com.caplin.datasource.publisher: An instance of Publisher publishes messages to remote DataSource peers on behalf of a DataProvider.
publishInitialMessage(Message) - Method in interface com.caplin.datasource.publisher.Publisher: Publishes the initial image of the data for a subject to peers that have just requested (subscribed to) that subject.
publishMappingMessage(MappingMessage) - Method in interface com.caplin.datasource.publisher.Publisher: Publishes a message that instructs the peer that it should request a different subject and map the updates across.
publishSubjectErrorEvent(Peer, SubjectErrorEvent) - Method in interface com.caplin.datasource.publisher.BroadcastPublisher: Publishes to the specified peer subscribed to a subject an event detailing an error in the subscription for that subject.
publishSubjectErrorEvent(SubjectErrorEvent) - Method in interface com.caplin.datasource.publisher.Publisher: Publishes to all peers subscribed to a subject an event detailing an error in the subscription for that subject.
publishSubjectStatusEvent(Peer, SubjectStatusEvent) - Method in interface com.caplin.datasource.publisher.BroadcastPublisher: Publishes to the specified peer an event about the change in status of a subject.
publishSubjectStatusEvent(SubjectStatusEvent) - Method in interface com.caplin.datasource.publisher.Publisher: Publishes to all subscribed peers an event about the change in status of a subject.
publishToPeer(Peer, Message) - Method in interface com.caplin.datasource.publisher.BroadcastPublisher
publishToSubscribedPeers(Message) - Method in interface com.caplin.datasource.publisher.Publisher: Publishes a message to subscribed peers (that is, the peers that have already received an initial image).

R

RecordMessage - Interface in com.caplin.datasource.messaging.record: Base interface for all Record messages.
RecordType1Message - Interface in com.caplin.datasource.messaging.record: Interface for sending Type 1 Record messages, adding fields by field name.
RecordType2Message - Interface in com.caplin.datasource.messaging.record: Interface for populating Type 2 Record messages, adding fields by field name.
recordType2Updated(Subscription, Peer, RecordType2Message) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
recordType2Updated(Subscription, Peer, RecordType2Message) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when an update to type 2 data in a record is received.
RecordType3Message - Interface in com.caplin.datasource.messaging.record: Interface for populating Type 3 Record messages, adding fields by field name.
recordType3Updated(Subscription, Peer, RecordType3Message) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
recordType3Updated(Subscription, Peer, RecordType3Message) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when an update to type 3 data in a record is received.
recordUpdated(Subscription, Peer, RecordMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
recordUpdated(Subscription, Peer, RecordMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when an update to type 1 data in a record is received.
RegexNamespace - Class in com.caplin.datasource.namespace: The RegexNamespace matches a subject based on one or more regex patterns.
RegexNamespace() - Constructor for class com.caplin.datasource.namespace.RegexNamespace: Initializes an empty new instance of the RegexNamespace class.
RegexNamespace(String) - Constructor for class com.caplin.datasource.namespace.RegexNamespace: Initializes a new instance of the RegexNamespace class with an include regex pattern.
registerLongAttributeChangedListener(String, LongAttributeListener) - Method in interface com.caplin.management.jmx.MBeanServerManager: Registers listeners for long attribute changes
registerLongAttributeChangedListener(String, LongAttributeListener) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
registerLongAttributeChangedListener(String, LongAttributeListener) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
registerMBean(Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Registers a JMXBean annotated object as a JMXBeanWrapper to the MBeanServer
registerMBean(Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
registerMBean(Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
RelationSet - Class in com.caplin.management.jmx.relations: Represents a "to many" relationship, where a particular MBean attribute defines a link between that MBean and many other MBeans.
RelationSet(ObjectName, String) - Constructor for class com.caplin.management.jmx.relations.RelationSet: Constructs a RelationSet with the specified source ObjectName and attribte name.
RelationSetNotification - Class in com.caplin.management.jmx.relations: Represents a change to the state of a RelationSet.
RelationSetNotification(RelationSetNotification.NotificationType, Object, long, String, String, Object, String) - Constructor for class com.caplin.management.jmx.relations.RelationSetNotification: Constructs the notification with the required arguments.
RelationSetNotification.NotificationType - Class in com.caplin.management.jmx.relations: A type safe enumeration representation of the different possible types of RelationSet notifications.
RelationSetNotificationFilter - Class in com.caplin.management.jmx.relations: Implementation of the NotificationFilter interface that filters out all Notifications that do not apply to a specific RelationSet.
RelationSetNotificationFilter(ObjectName, String, boolean, boolean) - Constructor for class com.caplin.management.jmx.relations.RelationSetNotificationFilter: Constructs the NotificationFitler with the specified source ObjectName, attribute name and notify of added and/or removed element booleans.
RelationSetUpdateListener - Interface in com.caplin.management.jmx.relations: The listener interface that must be implemented by any class that needs to be informed when an element is added to, or removed from, a RelationSet.
remove(Object) - Method in class com.caplin.management.jmx.relations.RelationSet: Removes the specified element from this set if it is present.
removeAll(Collection) - Method in class com.caplin.management.jmx.relations.RelationSet: Removes from this set all of its elements that are contained in the specified collection.
removeConnectionListener(ConnectionListener) - Method in interface com.caplin.datasource.DataSource: Removes a previously registered connection listener.
removeElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Removes an element with the given subject from the container.
removeElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerModel: Called to indicate that you should remove the element with the given subject from the container.
removeElementsWithPrefix(String) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Adds an operation to remove all elements from the container that have a subject that match the specified prefix.
removeElementsWithPrefix(String) - Method in interface com.caplin.datasource.messaging.container.ContainerModel: Called to indicate that you should remove all elements from the container that have a subject that matches the specified prefix.
removeField(String) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Removes all instances of the given field from this permission message.
removeField(String) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Removes all occurrences of the given field from this RecordMessage.
removeMBeanManyRelation(String, Object, Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Removes bean one-to-many relation for attribute between a parentObject and childObject
removeMBeanManyRelation(String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
removeMBeanManyRelation(String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
removeUpdateListener(RelationSetUpdateListener) - Method in class com.caplin.management.jmx.relations.RelationSet: Removes the specified RelationSetUpdateListener from the RelationSet.
RequestEvent - Interface in com.caplin.datasource.publisher: Event that is raised when a peer requests a subject.
retainAll(Collection) - Method in class com.caplin.management.jmx.relations.RelationSet: Retains only the elements in this set that are contained in the specified collection.

S

sendMessage(RecordMessage) - Method in interface com.caplin.datasource.channel.Channel: Sends a record message to the peer that opened the channel.
sendRecordMessage(RecordMessage) - Method in interface com.caplin.datasource.channel.Channel: Deprecated.
use sendMessage instead
sendSubjectError(String, SubjectError) - Method in interface com.caplin.datasource.channel.Channel: Sends a subject error event to the peer that opened the channel.
setAttribute(Attribute) - Method in class com.caplin.management.jmx.JMXBeanWrapper
setAttributes(AttributeList) - Method in class com.caplin.management.jmx.JMXBeanWrapper
setContent(int, int, String) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Updates the contents of the page at the specified location.
setDeleteEntryFlag(Boolean) - Method in interface com.caplin.datasource.messaging.record.RecordType2Message: Sets a value indicating whether this Type2 index should be deleted.
setDeletePermissionKey(boolean) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Sets a value in this permission message indicating whether the permission key must be deleted from Liberator's cache.
setDoNotAuthenticate(boolean) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Sets a boolean value indicating whether this ContainerMessage's constituents should be authenticated by an authentication module when the container is subscribed to.
setField(String, String) - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Sets a custom field on this news message
setField(String, String) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Sets a specified field within this permission message.
setField(String, String) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Sets a field value.
setGlobal(boolean) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Sets a value indicating whether this PermissionMessage is a global permission message.
setHeight(int) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Sets the height of the page, in text rows.
setImage(boolean) - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage
setImage(boolean) - Method in interface com.caplin.datasource.messaging.Message: Sets a boolean value indicating whether this Message represents an image of the data or an update to it.
setInitialLatencyChainTime(long) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Starts a latency chain if enabled using the latencyChainManager configuration option.
setNoCache(boolean) - Method in interface com.caplin.datasource.messaging.record.GenericMessage: Sets whether this Generic message should be cached in the DataSource (both remote and local).
setNoCache(boolean) - Method in interface com.caplin.datasource.messaging.record.RecordType1Message: Sets whether this Type 1 record message should be cached in the DataSource (both remote and local).
setPageType(String) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Sets the type of the page.
setPermission(String) - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Sets a permission string relating to this news message.
setPermissionKey(String) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Sets the permission key.
setStatusDown() - Method in interface com.caplin.datasource.DataSource: Causes the DataSource to disconnect and stop listening for connections.
setStatusDown() - Method in interface com.caplin.datasource.Peer: Stops this peer from making connections to its remote peer.
setStatusUp() - Method in interface com.caplin.datasource.DataSource: Causes the DataSource to reconnect and listen for connections.
setStatusUp() - Method in interface com.caplin.datasource.Peer: Allows this peer to make connections to its remote peer.
setStoryReference(String) - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Sets a reference that identifies the story associated with the headline.
setValue(String) - Method in interface com.caplin.datasource.messaging.Field: Sets the field value.
setWidth(int) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Sets the width of the page, in text columns.
size() - Method in class com.caplin.management.jmx.relations.RelationSet: Returns the number of elements in this set (its cardinality).
start() - Method in interface com.caplin.datasource.DataSource: Starts this DataSource.
stop() - Method in interface com.caplin.datasource.DataSource: Stops this DataSource.
StoryMessage - Interface in com.caplin.datasource.messaging.story: An instance of StoryMessage represents a news story.
storyUpdated(Subscription, Peer, StoryMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
storyUpdated(Subscription, Peer, StoryMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when a story update is received.
SubjectError - Enum in com.caplin.datasource: Enumeration that defines the possible types of subject error.
SubjectError.Flags - Enum in com.caplin.datasource
SubjectErrorEvent - Interface in com.caplin.datasource: Represents an event raised when there is an error in a subscription to a subject.
subjectErrorReceived(Subscription, Peer, SubjectErrorEvent) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
subjectErrorReceived(Subscription, Peer, SubjectErrorEvent) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when there is an error in a subscription.
SubjectStatus - Enum in com.caplin.datasource: Enumeration that defines the status values that a subject can have.
SubjectStatusEvent - Interface in com.caplin.datasource: Represents an event that is raised when there is a change in the status of a subject.
subjectStatusReceived(Subscription, Peer, SubjectStatusEvent) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
subjectStatusReceived(Subscription, Peer, SubjectStatusEvent) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when there is a change in the status of a subscription.
Subscription - Interface in com.caplin.datasource.subscription: Represents a subscription to a namespace of DataSource subjects (see BroadcastSubscription).
SubscriptionLink - Class in com.caplin.management.jmx.relations.links: Represents a user subscription within the Liberator.
SubscriptionLink(boolean, ObjectName, ObjectName, ObjectName, String, String, String, String) - Constructor for class com.caplin.management.jmx.relations.links.SubscriptionLink: Constructs the SubscriptionLink with the specified arguments.
SubscriptionListener - Interface in com.caplin.datasource.subscription: The SubscriptionListener interface allows applications to receive events raised for a Subscription.

T

toArray() - Method in class com.caplin.management.jmx.relations.RelationSet: Returns an array containing all of the elements in this set.
toArray(Object[]) - Method in class com.caplin.management.jmx.relations.RelationSet: Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
toPrettyString(StringBuilder, String) - Method in interface com.caplin.datasource.DataSourceConfiguration
toString() - Method in class com.caplin.datasource.namespace.PrefixNamespace
toString() - Method in class com.caplin.datasource.namespace.RegexNamespace
toString() - Method in class com.caplin.management.CommonJMXVersion
toString() - Method in class com.caplin.management.jmx.JMXBeanWrapper: Joins the toString() method on the inner object and appends the toString() method of MBeanInfo
toString() - Method in class com.caplin.management.jmx.relations.links.ObjectNameLinkImpl: Returns the human readable name of the linked MBean, as returned by ObjectNameLinkImpl.getLinkName().
toString() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Returns the human readable name of the linked MBean, as returned by SubscriptionLink.getLinkName().

U

unregisterMBean(Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Unregisters a JMXBean annotated object as a JMXBeanWrapper from the MBeanServer
unregisterMBean(Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
unregisterMBean(Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
unsubscribe() - Method in interface com.caplin.datasource.subscription.Subscription: Unsubscribes this instance of Subscription from the namespace of DataSource subjects.
updateContainer(ContainerModel) - Method in interface com.caplin.datasource.messaging.container.ContainerOperation: If you have defined a model of the container by implementing ContainerModel, call this method from within your implementation to update the model according to the operation.

V

valueOf(String) - Static method in enum com.caplin.datasource.messaging.container.ContainerOperationType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.PeerStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.SubjectError.Flags: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.SubjectError: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.SubjectStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.caplin.datasource.messaging.container.ContainerOperationType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.PeerStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.SubjectError.Flags: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.SubjectError: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.SubjectStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES: Returns an array containing the constants of this enum type, in the order they are declared.

W

WrapperMessage - Interface in com.caplin.datasource.messaging.record: Interface for wrapping multiple messages of the same type together into one message.

A B C D E F G H I J L M N O P R S T U V W