Caplin Systems - Index (DataSource for Java 7.1.4-1079-4821afa API Reference)

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

A

ACTION - com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES
ACTION_INFO - com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES
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.
ADD - com.caplin.datasource.messaging.container.ContainerOperationType: Represents an operation to add an element into a container.
ADD_OBJECT_AND_REQUEST_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSContainer: Field used to identify that the object (identified by the field value) should be added to this container and a request should be made by the receiving DataSource for the object.
ADD_OBJECT_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSContainer: Field used to identify that the object (identified by the field value) should be added to this container.
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.
addBinaryData(int, byte) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the byte value for the specified field number.
addBinaryData(int, byte[]) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the byte array value for the specified field number.
addBinaryData(int, double) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the double value for the specified field number.
addBinaryData(int, float) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the float value for the specified field number.
addBinaryData(int, int) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the integer value for the specified field number.
addBinaryData(int, long) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the long value for the specified field number.
addBinaryData(int, short) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the short value for the specified field number.
addBinaryData(int, String) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String value for the specified field number.
addBinaryRecordData(String, byte) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the byte value for the specified field name.
addBinaryRecordData(String, byte[]) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the byte array value for the specified field name.
addBinaryRecordData(String, double) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the double value for the specified field name.
addBinaryRecordData(String, float) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the float value for the specified field name.
addBinaryRecordData(String, int) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the integer value for the specified field name.
addBinaryRecordData(String, long) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the long value for the specified field name.
addBinaryRecordData(String, short) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the short value for the specified field name.
addBinaryRecordData(String, String) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String value for the specified field name.
addChannelListener(Namespace, ChannelListener) - Method in interface com.caplin.datasource.DataSource: Registers a ChannelListener for a specified namespace.
addCompanyCode(String) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds a company code.
addCompanyCodes(String[]) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds an array of company codes.
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.
addCustomCode(int, String) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds a custom user-define code.
addCustomCodes(int, String[]) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds an array of custom user-define codes.
addData(int, char) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String representation of the character value for the specified field number.
addData(int, char[]) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String representation of the character array for the specified field number.
addData(int, double) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String representation of the double value for the specified field number.
addData(int, float) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String representation of the float value for the specified field number.
addData(int, int) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String representation of the integer value for the specified field number.
addData(int, long) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String representation of the long value for the specified field number.
addData(int, String) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the String value for the specified field number.
addData(DSField) - Method in interface com.caplin.datasource.interfaces.DSData: Adds the DSField.
addDataSeparator() - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds a separator field, with field number DSRecord.DS_FIELDS_SEPARATOR, to the DSRecord, allowing multiple type 2 and type 3 record entries to be contributed in a single update.
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.
addKeyField(String) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String key as the Keyfield for this packet.
addLatencyChainPoint(String, Instant) - 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.
addObject(String) - Method in interface com.caplin.datasource.interfaces.DSContainer: Adds an instruction to append an object to this container.
addObject(String, boolean) - Method in interface com.caplin.datasource.interfaces.DSContainer: Deprecated.
Use DSContainer.addObject(String) instead.
addPageField(int, String) - Method in interface com.caplin.datasource.interfaces.DSPage: Adds field data to a page.
addPageRow(int, int, String) - Method in interface com.caplin.datasource.interfaces.DSPage: Adds text data to this DSPagebased on row and column.
addPermissionData(String, char) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String representation of the character value for the specified field name.
addPermissionData(String, char[]) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String representation of the character array for the specified field name.
addPermissionData(String, double) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String representation of the double value for the specified field name.
addPermissionData(String, float) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String representation of the float value for the specified field name.
addPermissionData(String, int) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String representation of the integer value for the specified field name.
addPermissionData(String, long) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String representation of the long value for the specified field name.
addPermissionData(String, String) - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds the String value for the specified field name.
addPermissionSeparator() - Method in interface com.caplin.datasource.interfaces.DSPermission: Adds a separator allowing the cojoining of multiple permission updates into a single packet.
addPermissionSeperator() - Method in interface com.caplin.datasource.interfaces.DSPermission: Deprecated.
addProductCode(String) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds a product code.
addProductCodes(String[]) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds an array of product code.
addRecordData(String, char) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String representation of the character value for the specified field name.
addRecordData(String, char[]) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String representation of the character array for the specified field name.
addRecordData(String, double) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String representation of the double value for the specified field name.
addRecordData(String, float) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String representation of the float value for the specified field name.
addRecordData(String, int) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String representation of the integer value for the specified field name.
addRecordData(String, long) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String representation of the long value for the specified field name.
addRecordData(String, String) - Method in interface com.caplin.datasource.interfaces.DSRecord: Adds the String value for the specified field name.
addRelationshipAttribute(Attribute, String) - Method in class com.caplin.management.jmx.JMXBeanWrapper: Add relationship attribute to this bean
addTopicCode(String) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds a topic code.
addTopicCodes(String[]) - Method in interface com.caplin.datasource.interfaces.DSNews: Adds an array of topic codes.
addUpdateListener(RelationSetUpdateListener) - Method in class com.caplin.management.jmx.relations.RelationSet: Adds the specified RelationSetUpdateListener to the RelationSet.
APPEND - Static variable in interface com.caplin.datasource.interfaces.DSStory: This story text should be appended to any other story of the same name.

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.
BIGPAGE_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSPage: The pagetype String used to identify a standard 80x25 page.
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.
className() - Method in annotation type com.caplin.management.jmx.JMXBean: The name of the class describing this bean, default is the full Java class name.
clear() - Method in class com.caplin.management.jmx.relations.RelationSet: Removes all of the elements from this set.
CLEAR - Static variable in interface com.caplin.datasource.interfaces.DSStory: This story text should clear and replace any other story of the same name, or create a new story if one doesn't already exist.
CLEARDOWN_WITH_PREFIX_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSContainer: Field used to identify that any objects that match the prefix provided as a field value should be removed from the container.
cleardownObjectsWithPrefix(String) - Method in interface com.caplin.datasource.interfaces.DSContainer: Adds an instruction to remove all objects from the container that have an object name that matches the provided prefix.
clearFields() - Method in interface com.caplin.datasource.interfaces.DSData: Removes all the fields.
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.interfaces - package com.caplin.datasource.interfaces
com.caplin.datasource.logging - package com.caplin.datasource.logging: This package defines the interfaces for logging and packet deserialisation.
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.json - package com.caplin.datasource.messaging.json: This package defines the interfaces for sending JSON 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.
CONTAINER - com.caplin.datasource.messaging.MessageType
CONTAINER_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A Container object type.
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
count() - Method in interface com.caplin.datasource.interfaces.DSData: Gets the number of fields that are present in this packet.
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.
createGenericMessage(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates an empty Generic message to which structured data can be added.
createJsonImageMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a JSON message for the given subject.
createJsonPatchMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a JSON diff for the given subject.
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() - Method in interface com.caplin.datasource.channel.Channel: Creates a Generic Message with the subject of this channel.
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() - Method in interface com.caplin.datasource.channel.Channel: Creates a type 1 record message with the subject of this channel.
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.
createStatusEvent(SubjectStatus, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a status event.
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.
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.
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
DefaultObjectNameEncoder() - Constructor for class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor.DefaultObjectNameEncoder
DeleteObject - com.caplin.datasource.SubjectError: The subject should be deleted.
description() - Method in annotation type com.caplin.management.jmx.JMXBean: The description for this bean, empty by default.
description() - Method in annotation type com.caplin.management.jmx.JMXBeanAttribute: The description of this attribute, empty by default.
description() - Method in annotation type com.caplin.management.jmx.JMXBeanOperation: The description of this operation, empty by default.
description() - Method in annotation type com.caplin.management.jmx.JMXBeanParameter: The description of this parameter, empty by default.
deserialiseDataUpdatePacket(byte[]) - Method in interface com.caplin.datasource.logging.PacketDeserialiser: Deserialise a Data Update packet.
DiscardEvent - Interface in com.caplin.datasource.publisher: Event that is raised when a peer discards a subject.
DOWN - com.caplin.datasource.PeerStatus: The DataSource peer is disconnected.
DS_FIELDS_NOT_DEFINED - Static variable in interface com.caplin.datasource.fields.FieldInfo
DS_FIELDS_SEPARATOR - Static variable in interface com.caplin.datasource.interfaces.DSPermission: Field number that is used by DataSource to separate multiple updates within the same packet.
DS_FIELDS_SEPARATOR - Static variable in interface com.caplin.datasource.interfaces.DSRecord: Field number that is used by DataSource to separate multiple updates within the same packet.
DSContainer - Interface in com.caplin.datasource.interfaces: Extends DSData to provide helper methods for sending Container objects.
DSData - Interface in com.caplin.datasource.interfaces: This interface should be implemented by a class that needs to send data to DataSource peers (for example, a Caplin Liberator, or another DataSource-enabled application).
DSField - Interface in com.caplin.datasource.interfaces: This interface should be implemented by a class that represents a field number/value pair.
DSNews - Interface in com.caplin.datasource.interfaces: Extends DSData to provide helper methods for sending News.
DSNoData - Interface in com.caplin.datasource.interfaces: This class can be used to send a 'NoData' message to a DataSource peer that signals that an object has not been found and the reason why.
DSPacket - Interface in com.caplin.datasource.interfaces: The base interface for any DataSource packet that can be sent to peers.
DSPage - Interface in com.caplin.datasource.interfaces: The interface that should be implemented by an instance of DSPage of the type page.
DSPermission - Interface in com.caplin.datasource.interfaces: Extends DSData to provide helper methods for sending Permissions.
DSRecord - Interface in com.caplin.datasource.interfaces: The interface that should be implemented by an instance of DSData of the type record.
DSSerializable - Interface in com.caplin.datasource.interfaces: A DSSerializable implementation represents a DataSource message.
DSStatus - Interface in com.caplin.datasource.interfaces: Sends a user-defined status message about a particular object.
DSStory - Interface in com.caplin.datasource.interfaces: Extends DSData to provide helper methods for sending News Stories.

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.
elements() - Method in interface com.caplin.datasource.interfaces.DSData: Returns an enumeration of the fields for this DSData.
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.datasource.fields.FieldInfoImpl
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

F_AUTH_UPDATE - Static variable in interface com.caplin.datasource.interfaces.DSData: Used to indicate to a Liberator that this update should be checked for client access using the auth module.
F_AUTHGLOBAL - Static variable in interface com.caplin.datasource.interfaces.DSData: Indicates that this object is a global permission object and that all updates for it should be passed through to the Auth module.
F_CHANGE_HEADLINE - Static variable in interface com.caplin.datasource.interfaces.DSNews: Change the headline identified with the story code in this update.
F_CHANGEDFIELDS - Static variable in interface com.caplin.datasource.interfaces.DSData: Indicates that this object should be delta compressed before sending on to the clients.
F_CLEAR_PERMISSIONS - Static variable in interface com.caplin.datasource.interfaces.DSData: Clear all permission entries for this object.
F_CLEAR_TYPE2 - Static variable in interface com.caplin.datasource.interfaces.DSData: Clear all type 2 entries for this object.
F_CLEAR_TYPE3 - Static variable in interface com.caplin.datasource.interfaces.DSData: Clear all type 3 entries for this object.
F_CONTAINER_INSERT_AT - Static variable in interface com.caplin.datasource.interfaces.DSField: Flag used internally to identify that the DSField represents an object to be inserted in a container (by DSContainer.insertObject(java.lang.String, int)).
F_CREATEOBJECT - Static variable in interface com.caplin.datasource.interfaces.DSData: Creates this object if it does not exist.
F_CREATEPARENT - Static variable in interface com.caplin.datasource.interfaces.DSData: Creates the parent directory if it does not exist.
F_DELETE_HEADLINE - Static variable in interface com.caplin.datasource.interfaces.DSNews: Delete the headline identified with the story code in this update.
F_DELETE_PERMISSION - Static variable in interface com.caplin.datasource.interfaces.DSData: Delete any permission entries for this object with the same value as the first field in the update.
F_DELETEOBJECT - Static variable in interface com.caplin.datasource.interfaces.DSNoData: Instruction to delete this object
F_FILTER_TYPE2 - Static variable in interface com.caplin.datasource.interfaces.DSData: Clear any type 2 entries for this object with the same value as the first field in the update.
F_FILTER_TYPE3 - Static variable in interface com.caplin.datasource.interfaces.DSData: Clear all type 3 entries for this object with the same value as the first field in the update.
F_IMAGE - Static variable in interface com.caplin.datasource.interfaces.DSData: Indicates this packet is an image and not an update.
F_NOCACHE - Static variable in interface com.caplin.datasource.interfaces.DSRecord: Do not cache this update - pass directly through to clients.
F_NONACTIVE - Static variable in interface com.caplin.datasource.interfaces.DSData: Indicates that this object should be treated in a non-active (ie broadcast) manner.
F_NOTFOUND - Static variable in interface com.caplin.datasource.interfaces.DSNoData: Indicates that the object is not found.
F_READDENY - Static variable in interface com.caplin.datasource.interfaces.DSNoData: Indicates that there is no permission to read this object.
F_UNAVAILABLE - Static variable in interface com.caplin.datasource.interfaces.DSNoData: Indicates that the object is unavailable at the current time
F_WRITEDENY - Static variable in interface com.caplin.datasource.interfaces.DSNoData: Indicates that there is no permission to write to this object
Field - Interface in com.caplin.datasource.messaging: Represents a name/value field pair.
FIELD_OFFSET - Static variable in interface com.caplin.datasource.interfaces.DSPage: The offset applied to page fields added using DSPage.addPageField(int, String).
FieldInfo - Interface in com.caplin.datasource.fields: This interface allows access to fields name and numbers configured in fields.conf files.
FieldInfoImpl - Class in com.caplin.datasource.fields
FieldInfoImpl(int, String) - Constructor for class com.caplin.datasource.fields.FieldInfoImpl
FieldInfoImpl(FieldInfo) - 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.conf files.
fromArgs(String[]) - Static method in interface com.caplin.datasource.DataSource: Creates an instance of DataSource using the supplied command options.
fromArgs(String[], Logger) - Static method in interface com.caplin.datasource.DataSource: Creates an instance of DataSource using the supplied command options and Logger.
fromArgs(String[], Logger, Function<String, String>) - Static method in interface com.caplin.datasource.DataSource: Creates an instance of DataSource using the supplied command options, Logger and preprocessor.
fromConfigFile(String) - Static method in interface com.caplin.datasource.DataSource: Creates an instance of DataSource using the supplied configuration file.
fromConfigFile(String, Logger) - Static method in interface com.caplin.datasource.DataSource: Creates an instance of DataSource using the supplied configuration file and Logger.
fromConfigString(String) - Static method in interface com.caplin.datasource.DataSource: Creates an instance of DataSource using the supplied configuration string.
fromConfigString(String, Logger) - Static method in interface com.caplin.datasource.DataSource: Creates an instance of DataSource using the supplied configuration string and Logger.

G

GENERIC - com.caplin.datasource.messaging.MessageType
GENERIC_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A Generic Type object type.
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.
getClearFlag() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message: Gets a value indicating whether all the Type2 data should be cleared.
getClearFlag() - Method in interface com.caplin.datasource.messaging.record.RecordType3Message: Gets a value indicating whether all the Type3 data should be cleared.
getClearFlag() - Method in interface com.caplin.datasource.messaging.record.WrapperMessage: Gets a value indicating whether all the Type2/type3 data should be cleared.
getCode() - Method in interface com.caplin.datasource.interfaces.DSStatus: Gets the code for this status message.
getCode() - Method in enum com.caplin.datasource.messaging.MessageType: Gets the code that represents the Message's type.
getCode() - Method in enum com.caplin.datasource.SubjectStatus: Gets the integer code for this status
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.
getFieldByFieldNumber(int) - Method in interface com.caplin.datasource.interfaces.DSData: Gets the first occurrence of the field with the specified field number.
getFieldByFieldNumber(int, int) - Method in interface com.caplin.datasource.interfaces.DSData: Gets the specified occurrence of the field with the specified field number.
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 interface com.caplin.datasource.interfaces.DSRecord: Gets the first occurrence of the field with the specified field name.
getFieldByName(String, int) - Method in interface com.caplin.datasource.interfaces.DSRecord: Gets the specified occurrence of the field with the specified field name.
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.
getFieldInfo() - Method in interface com.caplin.datasource.interfaces.DSField: Get the field information for this field, if available.
getFieldManager() - Method in interface com.caplin.datasource.DataSource: Gets the datasource field manager
getFields() - Method in interface com.caplin.datasource.fields.FieldManager: Returns a list of the available fields.
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, in the order of which the fields were sent.
getFlags() - Method in interface com.caplin.datasource.interfaces.DSData: Gets the flags that are going to be sent with this packet.
getFlags() - Method in interface com.caplin.datasource.interfaces.DSField: Get the flags set on this field.
getFlags() - Method in interface com.caplin.datasource.interfaces.DSStatus: Gets the flags for this status message.
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.
getJson() - Method in interface com.caplin.datasource.messaging.json.JsonMessage: Gets the JSON string of the message.
getKeys() - Method in interface com.caplin.datasource.interfaces.DSData: Deprecated.
use elements() or iterator().
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.interfaces.DSStatus: Gets the message for this status message.
getMessage() - Method in interface com.caplin.datasource.StatusEvent: 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.
getMessageType() - Method in interface com.caplin.datasource.messaging.Message: Gets the type for this message.
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.
getServiceStatusForCode(int) - Static method in enum com.caplin.datasource.SubjectStatus: Gets the ServiceStatus for the specified code.
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.StatusEvent: 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.interfaces.DSData: Gets this object's subject.
getSubject() - Method in interface com.caplin.datasource.interfaces.DSNoData: Gets this object's subject.
getSubject() - Method in interface com.caplin.datasource.interfaces.DSStatus: Gets this object's subject.
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.interfaces.DSData: Gets this object's type.
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.interfaces.DSField: Gets the value for the field.
getValue() - Method in interface com.caplin.datasource.messaging.Field: Gets the field value.
getValues() - Method in interface com.caplin.datasource.interfaces.DSData: Deprecated.
use elements() or iterator().
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.datasource.fields.FieldInfoImpl
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

impactType() - Method in annotation type com.caplin.management.jmx.JMXBeanOperation: JMX operation impact type, MBeanOperationInfo.UNKNOWN by default.
Info - com.caplin.datasource.SubjectStatus: Informational message.
INFO - com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES
INSERT - com.caplin.datasource.messaging.container.ContainerOperationType: Represents an operation to insert an element into a container at a specified position.
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.
insertObject(String, int) - Method in interface com.caplin.datasource.interfaces.DSContainer: Adds an instruction to insert an object into this container, pushing any object currently at that position, and all objects at successive positions, up one place (to the next higher index position).
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.
isPatch() - Method in interface com.caplin.datasource.messaging.json.JsonMessage: Is this JSON message a patch of existing data.
iterator() - Method in interface com.caplin.datasource.interfaces.DSData: Returns an iterator of the fields for this DSData.
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.
JSON - com.caplin.datasource.messaging.MessageType
JsonMessage - Interface in com.caplin.datasource.messaging.json: Interface for sending JSON messages.
jsonUpdated(Subscription, Peer, JsonMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
jsonUpdated(Subscription, Peer, JsonMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when an update to json message data is received.

L

LIBERATOR_INFO - com.caplin.datasource.messaging.MessageType
Limited - com.caplin.datasource.SubjectStatus: One or more of the non-required DataSources for this object are down or have sent an explicit state status message
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 interface com.caplin.datasource.DataSource: 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.
MAX_FLAG_VALUE - Static variable in interface com.caplin.datasource.interfaces.DSField: The maximum value permissible for the OR of all the flags on a DSField.
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.
MessageType - Enum in com.caplin.datasource.messaging: This class defines all the types of Message types that are supported by DataSource.

N

name() - Method in annotation type com.caplin.management.jmx.JMXBeanAttribute: Name of this attribute, by default the standard Java bean syntax will be used to create a name out of the getter/setter name.
name() - Method in annotation type com.caplin.management.jmx.JMXBeanOperation: Name of this operation, the method name by default.
name() - Method in annotation type com.caplin.management.jmx.JMXBeanParameter: Name of this parameter, param1, param2, param3 etc. by default.
Namespace - Interface in com.caplin.datasource.namespace: A Namespace is used to determine if a subject is of interest to an DataProvider.
newInstance() - Static method in interface com.caplin.datasource.logging.PacketDeserialiser: Create an instance of the Packet Deserialiser
newInstance(String) - Static method in interface com.caplin.datasource.logging.PacketDeserialiser: Create an instance of the Packet Deserialiser using the supplied fields file
newInstance(MBeanServer, String, Logger) - Static method in class com.caplin.management.jmx.MBeanServerManagerFactory: Creates a new MBeanServerManager with which to register JMXBean annotated objects.
NEWS - com.caplin.datasource.messaging.MessageType
NEWS_AUTHSTRING_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The field used to hold the news authentication string.
NEWS_COMPANY_CODE_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The field used to hold the list of company codes associated with this news story
NEWS_CUSTOM_CODE_BASE_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The base field used to hold any cust
NEWS_CUSTOM_CODE_MAX - Static variable in interface com.caplin.datasource.interfaces.DSNews: The maximum number of custom user-defined news code types allowed.
NEWS_DATETIME_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The field used to hold the news date/time string
NEWS_HEADLINE_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The field used to hold the news headline string
NEWS_PRODUCT_CODE_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The field used to hold the list of product codes associated with this news story
NEWS_REASON_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: Typically used to indicate a reason for a zero-headline response to a client-driven news search.
NEWS_REQ_DATE_FROM - Static variable in interface com.caplin.datasource.interfaces.DSNews: Field number used for client-driven news search requests - if present, will contain the oldest date bound for the search.
NEWS_REQ_DATE_TO - Static variable in interface com.caplin.datasource.interfaces.DSNews: Field number used for client-driven news search requests - if present, will contain the most recent date bound for the search.
NEWS_REQ_FLAGS - Static variable in interface com.caplin.datasource.interfaces.DSNews: Field number used for client-driven news search requests - if present, will contain any flags for the search, for example to represent full-story search / headline search etc.
NEWS_REQ_SEARCH - Static variable in interface com.caplin.datasource.interfaces.DSNews: Field number used for client-driven news search requests - will contain the search string.
NEWS_REQ_STORYCODE - Static variable in interface com.caplin.datasource.interfaces.DSNews: Field number used for client-driven news search requests - if present, will contain the last storycode received by the client - useful for more granular batching than simple date-bounded requests.
NEWS_SIZE_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: Use to indicate to the clients the size of the subsequent headline response.
NEWS_STORYCODE_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The field used to hold the news storycode identified
NEWS_TOPIC_CODE_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSNews: The field used to hold the list of topic codes associated with this news story
NEWS_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A News Headline object type.
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.
NodataIgnoreReqTimeout - com.caplin.datasource.SubjectError.Flags
NotFound - com.caplin.datasource.SubjectError: The requested subject could not be found.
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
NotMapped - com.caplin.datasource.SubjectStatus: The subject is no longer required for mapping.

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.
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.
Ok - com.caplin.datasource.SubjectStatus: The subject's data is valid.
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

PacketDeserialisationException - Exception in com.caplin.datasource.logging
PacketDeserialisationException(Exception) - Constructor for exception com.caplin.datasource.logging.PacketDeserialisationException
PacketDeserialiser - Interface in com.caplin.datasource.logging
PAGE - com.caplin.datasource.messaging.MessageType
PAGE_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A Page object type.
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.
PERMISSION - com.caplin.datasource.messaging.MessageType
PERMISSION_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A Permission object type.
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.
PRICE_MASTER_OUTPUT_STATUS - com.caplin.datasource.messaging.MessageType
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.
publishStatusEventToAllSubjects(StatusEvent) - Method in interface com.caplin.datasource.publisher.ActivePublisher: Publishes to all subscribed peers an event about the change in status of all subjects.
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

ReadDeny - com.caplin.datasource.SubjectError: The requested subject cannot be read from.
RECORD - com.caplin.datasource.messaging.MessageType
RECORD_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A Record object type.
RECORD_TYPE2 - com.caplin.datasource.messaging.MessageType
RECORD_TYPE3 - com.caplin.datasource.messaging.MessageType
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.
REMOVE - com.caplin.datasource.messaging.container.ContainerOperationType: Represents an operation to remove an element from a container.
REMOVE_OBJECT_FIELDNUM - Static variable in interface com.caplin.datasource.interfaces.DSContainer: Field used to identify that the object (identified by the field value) should be removed from this container.
REMOVE_WITH_PREFIX - com.caplin.datasource.messaging.container.ContainerOperationType: Represents an operation to remove all elements from a container that match a specified prefix.
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(DSField) - Method in interface com.caplin.datasource.interfaces.DSData: Removes the specified field from the DSData.
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 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
removeObject(String) - Method in interface com.caplin.datasource.interfaces.DSContainer: Adds an instruction to remove an object from this container.
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

S_INFO - Static variable in interface com.caplin.datasource.interfaces.DSStatus: This is an information only status message.
S_NOTMAPPED - Static variable in interface com.caplin.datasource.interfaces.DSStatus: This indicates that the subject should be discarded.
S_NOTSTALE - Static variable in interface com.caplin.datasource.interfaces.DSStatus: This indicates that an object is no longer stale and is receiving updates.
S_REMOVE - Static variable in interface com.caplin.datasource.interfaces.DSStatus: This indicates there is a serious problem with object and it should be removed from the client watchlists.
S_STALE - Static variable in interface com.caplin.datasource.interfaces.DSStatus: This indicates that the object may not be receiving updates any more.
S_UPDCLR - Static variable in interface com.caplin.datasource.interfaces.DSStatus: This indicates an update to this object should clear the previously sent S_STALE or S_NOTSTALE message.
send() - Method in interface com.caplin.datasource.interfaces.DSPacket: Send this DSPacket.
sendDirect() - Method in interface com.caplin.datasource.interfaces.DSPacket: Send this DSPacket directly - bypassing any configured sending mechanism that may be in place.
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.
sendToPeer(int) - Method in interface com.caplin.datasource.interfaces.DSPacket: Sends this DSPacket object to the specified peer.
setAttribute(Attribute) - Method in class com.caplin.management.jmx.JMXBeanWrapper
setAttributes(AttributeList) - Method in class com.caplin.management.jmx.JMXBeanWrapper
setAuthString(String) - Method in interface com.caplin.datasource.interfaces.DSNews: Sets an authorisation string for this headline.
setClearFlag(Boolean) - Method in interface com.caplin.datasource.messaging.record.RecordType2Message: Sets a value indicating whether all Type2 data should be cleared.
setClearFlag(Boolean) - Method in interface com.caplin.datasource.messaging.record.RecordType3Message: Sets a value indicating whether all Type3 data should be cleared.
setClearFlag(Boolean) - Method in interface com.caplin.datasource.messaging.record.WrapperMessage: Sets a value indicating whether all Type2/type3 data should be cleared.
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.
setDisplayTimeStamp(String) - Method in interface com.caplin.datasource.interfaces.DSNews: Sets the date/time of this news headline.
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.
setFieldInfo(FieldInfo) - Method in interface com.caplin.datasource.interfaces.DSField: Sets the field information for the field.
setFlags(int) - Method in interface com.caplin.datasource.interfaces.DSData: Sets the flags to be sent with this packet.
setGlobal(boolean) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Sets a value indicating whether this PermissionMessage is a global permission message.
setHeadline(String) - Method in interface com.caplin.datasource.interfaces.DSNews: Set the news headline text.
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(Instant) - 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.
setStoryCode(String) - Method in interface com.caplin.datasource.interfaces.DSNews: Set the headline's associated story code.
setStoryReference(String) - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Sets a reference that identifies the story associated with the headline.
setStoryText(String) - Method in interface com.caplin.datasource.interfaces.DSStory: Set the text for this story.
setSubject(String) - Method in interface com.caplin.datasource.interfaces.DSData: Sets this object's subject.
setType(int) - Method in interface com.caplin.datasource.interfaces.DSData: Sets the object type of this DSData to the specified value.
setValue(String) - Method in interface com.caplin.datasource.interfaces.DSField: Sets the value for the field.
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).
SMALLPAGE_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSPage: The pageType String used to identify a standard 64x16 page.
Stale - com.caplin.datasource.SubjectStatus: The subject's data may not be valid.
start() - Method in interface com.caplin.datasource.DataSource: Starts this DataSource.
StatusEvent - Interface in com.caplin.datasource: Represents an event that is raised when there is a change in the status of the backend.
stop() - Method in interface com.caplin.datasource.DataSource: Stops this DataSource.
STORY - com.caplin.datasource.messaging.MessageType
STORY_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A News Story object type.
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.
toBytes() - Method in interface com.caplin.datasource.interfaces.DSSerializable: Creates a serialized representation of this DataSource message that conforms to DataSource protocol.
toMessageType(int) - Static method in enum com.caplin.datasource.messaging.MessageType: Gets the MessageType that represents the specified code.
toPrettyString(StringBuilder, String) - Method in interface com.caplin.datasource.DataSourceConfiguration
toString() - Method in class com.caplin.datasource.fields.FieldInfoImpl
toString() - Method in enum com.caplin.datasource.messaging.MessageType
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().
TYPE2_RECORD_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A Type 2 Record object type.
TYPE3_RECORD_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: A Type 3 Record object type.

U

Unavailable - com.caplin.datasource.SubjectError: The subject is not available.
UNDEFINED - com.caplin.datasource.messaging.MessageType
Unknown - com.caplin.datasource.SubjectStatus: Indicates that an unknown status code has been supplied.
UNKNOWN - com.caplin.datasource.messaging.MessageType
UNKNOWN - com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES
UNKNOWN_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData: An uknown type.
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.
UP - com.caplin.datasource.PeerStatus: The DataSource peer is connected.
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.
updateData(int, String) - Method in interface com.caplin.datasource.interfaces.DSData: Sets the value of the first occurrence for the specified field number.
updateData(int, String, int) - Method in interface com.caplin.datasource.interfaces.DSData: Sets the value of the specified occurrence for a particular field number.
updateRecordData(String, String) - Method in interface com.caplin.datasource.interfaces.DSRecord: Sets the value of the first occurrence for the specified field name.
updateRecordData(String, String, int) - Method in interface com.caplin.datasource.interfaces.DSRecord: Sets the value of the specified occurrence for a particular field name.

V

validateFields() - Method in interface com.caplin.datasource.fields.FieldManager: Should fields be validated to ensure they're defined.
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.messaging.MessageType: 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.messaging.MessageType: 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.
WriteDeny - com.caplin.datasource.SubjectError: The requsested subject cannot be written to.

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