Index (Caplin Integration Suite API Documentation for Java 6.2.8-309958)

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

A

ActionAlreadyExistsException - Exception in com.caplin.permissioning: Thrown at runtime if one attempts to create a Rule that specifies an action which has already been specified by another, earlier created Rule.
actionExists(String) - Method in class com.caplin.permissioning.PermissioningDataSource: A convenience method that will tell you if a rule for an action has been sent to Liberator.
activeAdd(Peer, User, PermissionStore) - Method in class com.caplin.permissioning.PermissionPublisher
activeDelete(SubjectErrorEvent, PermissionStore, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
activeDiscard(Peer, String, PermissionStore) - Method in class com.caplin.permissioning.PermissionPublisher
activeError(String) - Method in class com.caplin.permissioning.PermissionPublisher
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.
activeUpdate(ContainerMessage, User, PermissionStore, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
add(Object) - Method in class com.caplin.management.jmx.relations.RelationSet: Adds the specified element to this set if it is not already present.
addAll(Collection) - Method in class com.caplin.management.jmx.relations.RelationSet: Adds all of the elements in the specified collection to this set if they're not already present.
addBlotterTradeListener(BlotterChannel, BlotterTradeListener) - Method in class com.caplin.trading.TradingProvider: Registers the provided listener to receive auto-generated trade lifecycle blotter events for matching trades.
addChannelListener(Namespace, ChannelListener) - Method in interface com.caplin.datasource.DataSource: Registers a ChannelListener for a specified namespace.
addConnectionListener(ConnectionListener) - Method in interface com.caplin.datasource.DataSource: Adds a connection listener that receives status events about the state of the DataSource application's connection to other peers.
addElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Adds an element with the given subject to the container.
addElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerModel: Called to indicate that you should add (append) an element with the given subject to the container.
addExcludeRegex(String) - Method in class com.caplin.datasource.namespace.RegexNamespace: Adds an exclude regex pattern to the namespace.
addField(String, String) - Method in interface com.caplin.trading.BlotterMessage: Deprecated.

Adds a field to the blotter message.
addField(String, String) - Method in interface com.caplin.trading.LegAction: Adds a field that relates to this leg, for example the base currency of this transaction.
addField(String, int) - Method in interface com.caplin.trading.LegAction: Adds a field that relates to this leg, for example the bid price for this transaction.
addField(String, String) - Method in interface com.caplin.trading.TradeEvent: Adds a field to this TradeEvent.
addField(String, int) - Method in interface com.caplin.trading.TradeEvent: Adds a field to this TradeEvent.
addGenericChannelListener(Namespace, ChannelListener) - Method in interface com.caplin.datasource.DataSource: Registers a ChannelListener for a specified namespace.
addIncludeRegex(String) - Method in class com.caplin.datasource.namespace.RegexNamespace: Adds an include regex pattern to the namespace.
addLatencyChainPoint(String, long) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Adds a latency chain point
addLegAction(LegAction) - Method in interface com.caplin.trading.TradeEvent: Adds a leg action to the trade.
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
addMember(Permissionable) - Method in class com.caplin.permissioning.Group: Adds a member to the group.
addMessage(Message) - Method in interface com.caplin.datasource.messaging.record.WrapperMessage: Adds a message to the WrapperMessage, the first message defines the message type.
addRelationshipAttribute(Attribute, String) - Method in class com.caplin.management.jmx.JMXBeanWrapper: Add relationship attribute to this bean
addSubjectMapping(String, Map<String, String>) - Method in class com.caplin.permissioning.User: Adds subject mappping data for use by a User's SubjectMapper instance.
addUpdateListener(RelationSetUpdateListener) - Method in class com.caplin.management.jmx.relations.RelationSet: Adds the specified RelationSetUpdateListener to the RelationSet.
ALL_ACTIONS - Static variable in class com.caplin.permissioning.Constants: A wild card, for use when applying permissions.
ALL_PRODUCTS - Static variable in class com.caplin.permissioning.Constants: A wild card, used when creating rules.
applyPermission(Set<String>, String, String, Authorization) - Method in class com.caplin.permissioning.Permissionable: Adds a permission that either allows or denies a single action on a product set and namespace.
attributes - Variable in class com.caplin.permissioning.User
Authorization - Enum in com.caplin.permissioning: Defines the allowed types of authorization that can be applied to an action.

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.
BlotterApplicationListener - Interface in com.caplin.datasource.blotter: Passed into the constructor of BlotterProvider, callbacks are made when requests and discards for blotter channels are received: BlotterApplicationListener.blotterChannelOpened(com.caplin.datasource.blotter.BlotterChannel) and BlotterApplicationListener.blotterChannelClosed(com.caplin.datasource.blotter.BlotterChannel).
BlotterChannel - Interface in com.caplin.datasource.blotter: BlotterChannel is the entry point for sending out BlotterItems.
BlotterChannel - Interface in com.caplin.trading: Deprecated.
blotterChannelClosed(BlotterChannel) - Method in interface com.caplin.datasource.blotter.BlotterApplicationListener: Callback invoked when a discard for a blotter is received.
blotterChannelClosed(BlotterChannel) - Method in interface com.caplin.trading.TradingApplicationListener: Called when a BlotterChannel is closed as a result of a user no longer being interested in this particular blotter configuration or the connection being lost to the Liberator.
blotterChannelCreated(BlotterChannel) - Method in interface com.caplin.trading.TradingApplicationListener: Called when a BlotterChannel is created as a result of a user requesting a blotter subject.
BlotterChannelListener - Interface in com.caplin.datasource.blotter: Specifically for the case where there is more than one Integration Adapter providing for the same channel subject.
blotterChannelOpened(BlotterChannel) - Method in interface com.caplin.datasource.blotter.BlotterApplicationListener: Callback invoked when a request for a blotter is received.
BlotterClosedException - Exception in com.caplin.trading: Deprecated.
BlotterClosedException(String) - Constructor for exception com.caplin.trading.BlotterClosedException: Deprecated.
BlotterClosedException(String, Throwable) - Constructor for exception com.caplin.trading.BlotterClosedException: Deprecated.
BlotterConfiguration - Class in com.caplin.datasource.blotter: The type Blotter configuration, which can be used to create a BlotterProvider instance.
BlotterConfiguration(String, String, String, String) - Constructor for class com.caplin.datasource.blotter.BlotterConfiguration: Instantiates a new Blotter configuration.
BlotterConfiguration(String, String, String) - Constructor for class com.caplin.datasource.blotter.BlotterConfiguration
BlotterEvent - Interface in com.caplin.trading: Deprecated.
BlotterItem - Class in com.caplin.datasource.blotter: BlotterItem is the data type representing a single item on the blotter.
BlotterItem(String) - Constructor for class com.caplin.datasource.blotter.BlotterItem
BlotterMessage - Interface in com.caplin.trading: Deprecated.
BlotterProvider - Class in com.caplin.datasource.blotter: This is the entry point into the Blotter API.
BlotterProvider(DataSource, BlotterConfiguration, BlotterApplicationListener) - Constructor for class com.caplin.datasource.blotter.BlotterProvider: Create a BlotterProvider registering your application.
BlotterTradeListener - Interface in com.caplin.trading: Deprecated.
broadcast(Peer, Message, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
broadcast(Peer, List<? extends Message>, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
broadcast(Message, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
broadcast(List<? extends Message>, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
broadcastError(SubjectErrorEvent) - Method in class com.caplin.permissioning.PermissionPublisher
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.
broadcastToActivePeers(Message, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
broadcastToActivePeers(List<? extends Message>, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
broadcastUpdate(PermissionMessage, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher
broadcastUpdate(List<? extends Message>, TransactionWrapper) - Method in class com.caplin.permissioning.PermissionPublisher

C

Channel - Interface in com.caplin.datasource.channel: Channels provide a bi-directional communication mechanism between StreamLink clients and DataSource applications.
channelClosed(TradeChannel) - Method in interface com.caplin.trading.TradingApplicationListener: Called when a channel is closed as a result of the user finishing its trading session or the connection being lost to the Liberator.
channelCreated(TradeChannel) - Method in interface com.caplin.trading.TradingApplicationListener: Called when a client wants to open a trading channel that will subsequently be used to perform trades.
ChannelListener - Interface in com.caplin.datasource.channel: Interface that must be implemented in order to perform bi-directional communication with a StreamLink client.
ChartDataProvider - Interface in com.caplin.charting: The interface that must be implemented to retrieve the chart data.
ChartDataRequest - Interface in com.caplin.charting: A ChartDataRequest contains the parameters of a request (the request criteria) and methods to respond to the request with data or an error.
ChartingProvider - Class in com.caplin.charting: The ChartingProvider provides an integration point to allow you to plug in a provider of historic chart data.
ChartingProvider(DataSource, ChartDataProvider) - Constructor for class com.caplin.charting.ChartingProvider: Constructs a new ChartingProvider.
clear() - Method in class com.caplin.management.jmx.relations.RelationSet: Removes all of the elements from this set.
clearFields() - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Removes all the fields previously added to this RecordMessage
close() - Method in interface com.caplin.trading.BlotterChannel: Deprecated.

Closes this BlotterChannel.
closeChannel() - Method in interface com.caplin.datasource.blotter.BlotterChannel: Closes the channel.
closeChannel() - Method in interface com.caplin.datasource.notification.NotificationChannel: Closes the channel.
com.caplin.charting - package com.caplin.charting: Contains the ChartingProvider class which should be used when creating a data source to provide charting data.
com.caplin.datasource - package com.caplin.datasource: About DataSource for Java
com.caplin.datasource.blotter - package com.caplin.datasource.blotter: This package contains the public elements of the BlotterAPI.
com.caplin.datasource.channel - package com.caplin.datasource.channel: The Channel package consists of interfaces allowing creation and maintenance of Channels that provide a bi-directional communication mechanism between StreamLink clients and DataSource applications
com.caplin.datasource.fields - package com.caplin.datasource.fields
com.caplin.datasource.messaging - package com.caplin.datasource.messaging: Defines the message types that are used by DataSource for Java.
com.caplin.datasource.messaging.container - package com.caplin.datasource.messaging.container: This package defines the interfaces for sending Container messages.
com.caplin.datasource.messaging.mapping - package com.caplin.datasource.messaging.mapping: This package defines the interfaces for sending Mapping messages.
com.caplin.datasource.messaging.news - package com.caplin.datasource.messaging.news: This package defines the interfaces for sending News messages.
com.caplin.datasource.messaging.page - package com.caplin.datasource.messaging.page: This package defines the interfaces for sending Page messages.
com.caplin.datasource.messaging.permission - package com.caplin.datasource.messaging.permission: This package defines the interfaces for sending Permission messages.
com.caplin.datasource.messaging.record - package com.caplin.datasource.messaging.record: This package defines the interfaces for sending Record messages.
com.caplin.datasource.messaging.story - package com.caplin.datasource.messaging.story: This package defines the interfaces for sending Story messages.
com.caplin.datasource.namespace - package com.caplin.datasource.namespace: Namespaces are used to determine if a subject is of interest to an DataProvider.
com.caplin.datasource.notification - package com.caplin.datasource.notification: This package contains the public elements of the Notification API.
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.
com.caplin.permissioning - package com.caplin.permissioning: The Caplin Permissioning Integration API provides classes and interfaces that allow you to create Permissioning Adapters.
com.caplin.permissioning.logging - package com.caplin.permissioning.logging: The classes and interfaces that support the ability to apply a different logging strategy for permissioning objects.
com.caplin.trading - package com.caplin.trading: The Caplin Trading Integration API provides Java classes and interfaces that allow you to create Trading Adapters.
commitTransaction() - Method in class com.caplin.permissioning.PermissioningDataSource: Finishes a transaction and sends the data for that transaction to the remote Liberator.
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.
CONFIGURATION - Static variable in class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.

Used in calls to User.addSubjectMapping() as the key that identifies passed in mappings as configuration settings.
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.
Constants - Class in com.caplin.permissioning: Constants used when interacting with the the Permissioning API
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
copyPermissions() - Method in class com.caplin.permissioning.Permissionable
createActionRefRule(String, String, String, String) - Method in class com.caplin.permissioning.PermissioningDataSource: Creates a new Rule for an action on a product.
createActionRefRule(String, Map<String, String>, String, String, String) - Method in class com.caplin.permissioning.PermissioningDataSource: Creates a new Rule for an action on a product.
createActionRule(String, String, String, String) - Method in class com.caplin.permissioning.PermissioningDataSource: Creates a new Rule for an action on a product.
createActionRule(String, Map<String, String>, String, String, String) - Method in class com.caplin.permissioning.PermissioningDataSource: Creates a new Rule for an action on a product.
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.
createAddLegAction() - Method in interface com.caplin.trading.Leg: Creates an action that represents the addition of a leg to a trade.
createBlotterMessage() - Method in interface com.caplin.trading.BlotterChannel: Deprecated.

Creates a blotter message that will be sent to the user on this channel.
createBroadcastPublisher(Namespace) - Method in interface com.caplin.datasource.DataSource: Creates a BroadcastPublisher for the specified namespace.
createBroadcastSubscription(Namespace, SubscriptionListener) - Method in interface com.caplin.datasource.DataSource: Creates a subscription to many subjects.
createCompatibilityPublisher(Namespace, DataProvider) - Method in interface com.caplin.datasource.DataSource: Creates a CompatibilityPublisher for the specified namespace.
createContainerMessage(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a message that defines a container.
createDataSource(String, String, Logger) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration file, fields definition file, and Logger.
createDataSource(String, String) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration file and fields definition file.
createDataSource(String[]) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied command options.
createDataSource(String[], Logger) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied command options and Logger.
createDataSource(String) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration string.
createDataSource(String, Logger) - Static method in class com.caplin.datasource.DataSourceFactory: Creates an instance of DataSource using the supplied configuration string and Logger.
createErrorEvent(String, String) - Method in interface com.caplin.trading.Trade: Creates an error event for this Trade.
createEvent(String) - Method in interface com.caplin.trading.Trade: Creates an event for this Trade.
createGenericMessage(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates an empty Generic message to which structured data can be added.
createGroup(String) - Method in class com.caplin.permissioning.PermissioningDataSource: Creates a new Group in this PermissioningDataSource.
createLeg() - Method in interface com.caplin.trading.Trade: Creates a new trade leg on this trade.
createMappingMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a MappingMessage for mapping subjects
createMBeanManyRelation(String, String, Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Creates an empty one-to-many bean relation for a parentObject with an attribute name
createMBeanManyRelation(String, String, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
createMBeanManyRelation(String, String, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
createMBeanOneRelation(String, String, Object, Object) - Method in interface com.caplin.management.jmx.MBeanServerManager: Creates an one-to-one bean relation linking a parentObject to a childObject with an attribute name
createMBeanOneRelation(String, String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerImpl
createMBeanOneRelation(String, String, Object, Object) - Method in class com.caplin.management.jmx.MBeanServerManagerNullImpl
createMessage(String) - Method in interface com.caplin.datasource.channel.Channel: Creates a Generic Message.
createNewsMessage(String, String, String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a News message for the given subject.
createPageMessage(String, int, int) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Page message for the given subject.
createPermissionMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Permission message for the given subject.
createRecordMessage(String) - Method in interface com.caplin.datasource.channel.Channel: Creates a type 1 record message.
createRecordType1Message(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Record message to which Type 1 structured data can be added.
createRecordType2Message(String, String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Record message to which Type 2 structured data can be added.
createRecordType3Message(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Record message to which Type 3 structured data can be added.
createRemoveLegAction() - Method in interface com.caplin.trading.Leg: Creates an action that represents the removal of a leg from a trade.
createRestoreEvent(String) - Method in interface com.caplin.trading.Trade: Creates an event that will restore a trade into the specified state.
createStoryMessage(String, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Story message for the given subject.
createSubjectErrorEvent(String, SubjectError, SubjectError.Flags...) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a subject error event.
createSubjectErrorEvent(String, SubjectError) - Method in interface com.caplin.datasource.messaging.MessageFactory
createSubjectMapper() - Method in class com.caplin.permissioning.User
createSubjectStatusEvent(String, SubjectStatus, String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a subject status event.
createTrade(String) - Method in interface com.caplin.trading.TradeChannel
createTrade(TradeChannel, String) - Method in class com.caplin.trading.TradingProvider: Creates a new Trade and restores it to the specified channel, setting the requestId to a generated value.
createUpdateLegAction() - Method in interface com.caplin.trading.Leg: Creates an action that represents an update to an existing trade leg, for example a change in the value of one of the leg fields.
createUser(String) - Method in class com.caplin.permissioning.PermissioningDataSource: Creates a new, KeyMaster authenticated User that is known to this PermissioningDataSource.
createUser(String, String) - Method in class com.caplin.permissioning.PermissioningDataSource: Creates a new, text password authenticated User that is known to this PermissioningDataSource.
createWrapperMessage(String) - Method in interface com.caplin.datasource.messaging.MessageFactory: Creates a Wrapper message for the given subject.
CUSTOMER_ID - Static variable in class com.caplin.permissioning.Constants: This is provided by a keymaster servlet

D

data - Variable in class com.caplin.permissioning.DefaultGlobalContext: Stores the each Map passed in to the update() against the identifier it was passed in with.
DataProvider - Interface in com.caplin.datasource.publisher: Interface that must be implemented in order to provide data updates to DataSource peers.
DataSource - Interface in com.caplin.datasource: This is the main interface of DataSource for Java.
DataSourceConfiguration - Interface in com.caplin.datasource: This interface allows public access to values inside a DataSource configuration file.
DataSourceFactory - Class in com.caplin.datasource: A factory used to create DataSource instances.
decodeValue(String) - Method in interface com.caplin.management.jmx.encoder.ObjectNameEncoder: Decodes an ObjectName value that was encoded with the ObjectNameEncoder.encodeValue(String) method.
decodeValue(String) - Method in class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor.DefaultObjectNameEncoder
DEFAULT_MAPPINGS - Static variable in class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.

Used in calls to User.addSubjectMapping() to identify the configuration setting for the default key mapping.
DEFAULT_PERMISSION_NAMESPACE - Static variable in class com.caplin.permissioning.Constants: The default permission namespace
DefaultGlobalContext - Class in com.caplin.permissioning: This class implements the GlobalContext interface and is already deployed at the Permissioning Auth Module.
DefaultGlobalContext() - Constructor for class com.caplin.permissioning.DefaultGlobalContext: Creates a new empty DefaultGlobalContext.
deleteNotification(String, String) - Method in class com.caplin.datasource.notification.NotificationProvider
deny(Set<String>, String, String...) - Method in class com.caplin.permissioning.Permissionable: Adds a permission that denies one or more actions on a product set and namespace.
DiscardEvent - Interface in com.caplin.datasource.publisher: Event that is raised when a peer discards a subject.
DS_FIELDS_NOT_DEFINED - Static variable in interface com.caplin.datasource.fields.FieldInfo
dump() - Method in class com.caplin.permissioning.PermissioningDataSource: Prints structure of cached permission data, used for debugging
DuplicateNodeException - Exception in com.caplin.permissioning: Thrown when adding a Permissionable to a group, when that Permissionable already exists as a member.

E

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

F

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

G

GenericMessage - Interface in com.caplin.datasource.messaging.record: Interface for sending Generic messages, adding fields by name and value.
genericMessageUpdated(Subscription, Peer, GenericMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
genericMessageUpdated(Subscription, Peer, GenericMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when an update to generic message data is received.
get(String) - Method in class com.caplin.permissioning.DefaultGlobalContext: Returns the Map of key-value pairs that are saved for the passed in identifier.
get(String, String) - Method in class com.caplin.permissioning.DefaultGlobalContext: Returns the value that is saved for the passed in identifier and key.
get(String) - Method in interface com.caplin.permissioning.GlobalContext: Returns the Map of key-value pairs that are saved for the passed in identifier.
get(String, String) - Method in interface com.caplin.permissioning.GlobalContext: Returns the value that is saved for the passed in identifier and key.
getAllTrades() - Method in interface com.caplin.trading.TradeChannel: Gets all the trades that this channel is currently managing.
getAppName() - Method in interface com.caplin.datasource.DataSourceConfiguration
getAttribute(String) - Method in class com.caplin.management.jmx.JMXBeanWrapper
getAttribute(String) - Method in class com.caplin.permissioning.User: Get an attribute that has been set by an earlier call to User.setAttribute(String, String).
getAttributeName() - Method in class com.caplin.management.jmx.relations.RelationSetNotification: Gets the name of the attribute that this notification applies to.
getAttributeNames() - Method in class com.caplin.permissioning.User: Get the name of every attribute that has been set on this user
getAttributes(String[]) - Method in class com.caplin.management.jmx.JMXBeanWrapper
getBitFlag() - Method in enum com.caplin.datasource.SubjectError.Flags
getBlotterChannel() - Method in interface com.caplin.trading.BlotterEvent: Deprecated.

Gets the BlotterChannel on which the event occurred.
getBlotterIdentifier() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets the blotter identifier name.
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.
getChannel() - Method in interface com.caplin.trading.Trade: Gets the Trade Channel for this Trade.
getChannelNamespace() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets the channel namespace.
getChannelNamespace() - Method in class com.caplin.datasource.notification.NotificationConfiguration: Gets the channel namespace.
getClose() - Method in class com.caplin.charting.OhlcvData
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
getContainerThrottleMillis() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Get the current millisecond delay used for container throttling
getCopyright() - Method in class com.caplin.management.CommonJMXVersion
getDataSource() - Method in class com.caplin.trading.TradingProvider: The underlying DataSource object that is used for communication with the Liberator.
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.
getEnd() - Method in class com.caplin.charting.RequestCriteria
getError() - Method in interface com.caplin.datasource.SubjectErrorEvent: Gets the SubjectError relating to the SubjectErrorEvent.
getEventSource() - Method in interface com.caplin.trading.TradeEvent: Returns the source of this event: CLIENT, SERVER, or RESTORE
getField(String) - Method in class com.caplin.datasource.blotter.BlotterItem
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.
getField(String) - Method in class com.caplin.datasource.notification.Notification
getField(String) - Method in interface com.caplin.trading.BlotterMessage: Deprecated.

Gets a field from the blotter message.
getField(String) - Method in interface com.caplin.trading.LegAction: Gets the value of a field on this leg action.
getField(String) - Method in interface com.caplin.trading.Trade: Gets a stored field value from this Trade.
getField(String) - Method in interface com.caplin.trading.TradeEvent: Gets the value of a field in this TradeEvent.
getFieldByName(String) - Method in interface com.caplin.datasource.fields.FieldManager: Given the field's name, returns a structure containing both the field's name and number.
getFieldByName(String) - Method in class com.caplin.datasource.fields.FieldManagerImpl
getFieldByNumber(int) - Method in interface com.caplin.datasource.fields.FieldManager: Given the field's number, returns a structure containing both the field's name and number.
getFieldByNumber(int) - Method in class com.caplin.datasource.fields.FieldManagerImpl
getFieldManager() - Method in interface com.caplin.datasource.DataSource: Gets the datasource field manager
getFields() - Method in class com.caplin.datasource.blotter.BlotterItem
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.
getFields() - Method in class com.caplin.datasource.notification.Notification
getFields() - Method in interface com.caplin.trading.BlotterMessage: Deprecated.

Gets a map of all the fields.
getFields() - Method in interface com.caplin.trading.LegAction: Gets an unmodifiable copy of all the fields on this leg action.
getFields() - Method in interface com.caplin.trading.Trade: Gets the fields of this Trade as a Map.
getFields() - Method in interface com.caplin.trading.TradeEvent: Gets the fields of this TradeEvent as a Map
getGlobal() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Gets a value indicating whether this PermissionMessage is a global permission message.
getGroup(String) - Method in class com.caplin.permissioning.PermissioningDataSource: Retrieve an existing Group that is already known to this PermissioningDataSource.
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
getHexEncodedUniqueId() - Method in class com.caplin.datasource.blotter.BlotterItem
getHigh() - Method in class com.caplin.charting.OhlcvData
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
getInstrument() - Method in class com.caplin.charting.RequestCriteria
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.
getInterval() - Method in class com.caplin.charting.RequestCriteria
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.
getInvalidFields() - Method in interface com.caplin.trading.InvalidFieldsEvent: Gets the fields in the client event that were invalid.
getItemNamespace() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets the item namespace.
getItemNamespace() - Method in class com.caplin.datasource.notification.NotificationConfiguration: Gets the item namespace.
getKey() - Method in class com.caplin.permissioning.SubjectMapping: Gets the the key that was passed to the constructor.
getLeg() - Method in interface com.caplin.trading.LegAction: Gets the underlying Leg that this action relates to.
getLegActions() - Method in interface com.caplin.trading.TradeEvent: Gets the leg actions associated with this event.
getLegs() - Method in interface com.caplin.trading.Trade: Gets a copy of the list of legs that comprise this trade, in the correct order.
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.
getLow() - Method in class com.caplin.charting.OhlcvData
getMap() - Method in class com.caplin.permissioning.SubjectMapping: Gets the subject mappings that were passed to the constructor.
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.
getMembers() - Method in class com.caplin.permissioning.Group: Gets the members that have been added to the group.
getMessage() - Method in interface com.caplin.datasource.SubjectStatusEvent: Gets the subject status message.
getMessage() - Method in interface com.caplin.trading.InvalidFieldsEvent: Gets the error message relating to the invalid fields event.
getMessage() - Method in interface com.caplin.trading.InvalidTransitionEvent: Gets the error message relating to the invalid state transition attempt.
getMessageFactory() - Method in interface com.caplin.datasource.publisher.Publisher: Gets the MessageFactory used to create the messages that are published via this Publisher.
getMessageFactory() - Method in class com.caplin.permissioning.PermissionPublisher
getMessageQueueSize() - Method in interface com.caplin.datasource.Peer: Gets the current number of queued messages on the peer.
getMessages() - Method in interface com.caplin.datasource.messaging.record.WrapperMessage: Returns the list of messages in the order they were added.
getName() - Method in interface com.caplin.datasource.fields.FieldInfo
getName() - Method in class com.caplin.datasource.fields.FieldInfoImpl
getName() - Method in interface com.caplin.datasource.messaging.Field: Gets the field name.
getName() - Method in interface com.caplin.datasource.Peer: Gets the name of this peer.
getName() - Method in class com.caplin.management.CommonJMXVersion
getName() - Method in class com.caplin.permissioning.Permissionable: Gets the name of this Permissionable.
getName() - Method in class com.caplin.permissioning.PermissioningDataSource: Gets the name of the PermissioningDataSource.
getName() - Method in interface com.caplin.trading.TradeChannel: Gets the name of the channel
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.
getOpen() - Method in class com.caplin.charting.OhlcvData
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.
getParameters() - Method in interface com.caplin.datasource.blotter.BlotterChannel: Returns the parameters for the channel
getParameters() - Method in interface com.caplin.trading.BlotterChannel: Deprecated.

Gets the parameters of the channel.
getParent() - Method in class com.caplin.datasource.blotter.BlotterItem
getPassword() - Method in class com.caplin.permissioning.User: Get this User's password.
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.
getPeerIndex() - Method in interface com.caplin.trading.TradeChannel: Get the index of the peer connection that is managing this TradeChannel.
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.
getRequestCriteria() - Method in interface com.caplin.charting.ChartDataRequest: Call this method to retrieve the RequestCriteria for the current request.
getRequestId() - Method in interface com.caplin.trading.Trade: Gets the unique RequestId for this Trade.
getRow() - Method in interface com.caplin.datasource.messaging.page.PageElement: The row (vertical) cooordinate of the start of the updated region.
getSessionId() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the unique identifier for the session this subscription has been made from.
getSessionObjectName() - Method in class com.caplin.management.jmx.relations.links.SubscriptionLink: Gets the ObjectName of the user session MBean this object links to.
getSource() - Method in interface com.caplin.trading.TradeEvent: Gets the source of this TradeEvent.
getSourceName() - Method in class com.caplin.datasource.notification.NotificationConfiguration: Gets the notification source name.
getStart() - Method in class com.caplin.charting.RequestCriteria
getState() - Method in interface com.caplin.trading.Trade: Gets the current state of this Trade.
getStateName() - Method in interface com.caplin.trading.InvalidFieldsEvent: Gets the state that the Trade was in when the event with invalid fields was received.
getStateName() - Method in interface com.caplin.trading.InvalidTransitionEvent: Gets the state that the trade was in when the invalid event was received.
getStatus() - Method in interface com.caplin.datasource.SubjectStatusEvent: Gets the status of the subject.
getStoryReference() - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Gets a reference that identifies the story associated with the headline.
getStringArrayValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as an List of String.
getStringArrayValueExpanded(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as an List of String.
getStringValue(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the value of the requested field as a string.
getStringValue(String, String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the last value of the requested field as a string.
getStringValueExpanded(String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the last value of the requested field as a string.
getStringValueExpanded(String, String) - Method in interface com.caplin.datasource.DataSourceConfiguration: Accesses the configuration file and returns the last value of the requested field as a string.
getSubContainerMaxDepth() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets the max depth of the sub containers.
getSubContainerNamespace() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets the sub channel namespace.
getSubject() - Method in interface com.caplin.datasource.blotter.BlotterChannel: Returns the subject for the channel.
getSubject() - Method in interface com.caplin.datasource.channel.Channel: Gets the subject of this channel.
getSubject() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage
getSubject() - Method in interface com.caplin.datasource.messaging.Message: Gets the subject of this message.
getSubject() - Method in interface com.caplin.datasource.notification.NotificationChannel: Returns the subject for the channel.
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.
getSubjectMapper() - Method in class com.caplin.permissioning.User: Gets the class that implements the SubjectMapper interface for this User.
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.
getTime() - Method in class com.caplin.charting.OhlcvData
getTrade() - Method in interface com.caplin.trading.InvalidFieldsEvent: Gets the Trade object to which this InvalidFieldsEvent relates.
getTrade() - Method in interface com.caplin.trading.InvalidTransitionEvent: Gets the Trade object to which this InvalidTransitionEvent relates.
getTrade(String) - Method in interface com.caplin.trading.TradeChannel: Gets a Trade associated with this TradeChannel.
getTrade() - Method in interface com.caplin.trading.TradeEvent: Gets the Trade object that this TradeEvent belongs to.
getTradeChannelListener() - Method in interface com.caplin.trading.TradeChannel: Gets the ChannelListener that is set on this TradeChannel.
getTradeEvent() - Method in interface com.caplin.trading.BlotterEvent: Deprecated.

Gets the trade event that triggered the blotter event.
getTradeEvent() - Method in interface com.caplin.trading.InvalidFieldsEvent: Gets the TradeEvent that was invalid.
getTradeEvent() - Method in interface com.caplin.trading.InvalidTransitionEvent: Gets the TradeEvent that was invalid.
getTradeListener() - Method in interface com.caplin.trading.Trade: Gets the TradeListener that is set on this Trade.
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.
getType() - Method in interface com.caplin.trading.LegAction: Gets the type of action that this instance represents.
getType() - Method in interface com.caplin.trading.Trade: Gets the type of this Trade.
getType() - Method in interface com.caplin.trading.TradeEvent: Gets the type of the TradeEvent.
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.
getUniqueId() - Method in class com.caplin.datasource.blotter.BlotterItem
getUniqueId() - Method in class com.caplin.datasource.notification.Notification
getUpdatedElements() - Method in interface com.caplin.datasource.messaging.page.PageMessage: Gets a read-only list of the updated page elements.
getUser(String) - Method in class com.caplin.permissioning.PermissioningDataSource: Retrieve an existing User that is already known to this PermissioningDataSource.
getUser() - Method in interface com.caplin.trading.TradeChannel: Gets the username of the user represented by this channel
getUsername() - Method in interface com.caplin.datasource.blotter.BlotterChannel: Returns the username for the channel
getUsername() - Method in interface com.caplin.datasource.notification.NotificationChannel: Returns the username for the channel
getUserName() - Method in interface com.caplin.trading.BlotterChannel: Deprecated.

Gets the username of the user represented by this channel
getValue() - Method in interface com.caplin.datasource.messaging.Field: Gets the field value.
getVersion() - Method in class com.caplin.datasource.blotter.BlotterProvider: Get the Blotter API version.
getVersion() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage: Gets the version of the message.
getVersion() - Method in class com.caplin.datasource.notification.NotificationProvider: Get the Notification API version.
getVersion() - Method in class com.caplin.management.CommonJMXVersion
getVolume() - Method in class com.caplin.charting.OhlcvData
getWidth() - Method in interface com.caplin.datasource.messaging.page.PageMessage: Gets the width of the page, in text columns.
GlobalContext - Interface in com.caplin.permissioning: A custom SubjectMapper can call one of the get() methods of this interface to access data that is common all subject mappers.
Group - Class in com.caplin.permissioning: A grouping of users and/or other groups.

H

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

I

initialise() - Method in interface com.caplin.trading.BlotterChannel: Deprecated.
This is an internal method.
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.
internalConfiguration - Variable in class com.caplin.datasource.blotter.BlotterConfiguration
internalConfiguration - Variable in class com.caplin.datasource.notification.NotificationConfiguration
InvalidFieldsEvent - Interface in com.caplin.trading: An event raised when one or more of the fields sent in a client event are invalid.
InvalidFieldsException - Exception in com.caplin.trading
InvalidFieldsException(String) - Constructor for exception com.caplin.trading.InvalidFieldsException
InvalidHierarchyException - Exception in com.caplin.permissioning: Thrown if the hierarchy to be created is unacceptable.
InvalidTransitionEvent - Interface in com.caplin.trading: An event raised when a client event would trigger an invalid state transition on the trade model.
invoke(String, Object[], String[]) - Method in class com.caplin.management.jmx.JMXBeanWrapper
isAutoPermit() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets whether automatically permitted.
isAutoSendEmptyContainer() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets whether an empty container should be send automatically as a response to a request
isCached() - Method in class com.caplin.charting.RequestCriteria
isChannelUsingImageFlag() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Returns true if image flags are used in the channel for its initial message, or false otherwise.
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.
isItemUsingImageFlag() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Returns true if image flags are used on each channel item for their initial messages, or false otherwise.
isMaster() - Method in class com.caplin.permissioning.PermissioningDataSource: Indicates the role of the PermissioningDataSource.
isMoveItemToTopWhenModified() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets whether items should be moved to the top of the container upon modification
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.
isNotificationUsingImageFlag() - Method in class com.caplin.datasource.notification.NotificationConfiguration: Returns true if image flags are set to true on each Notification record for its initial message, otherwise false.
isPermitted(String, String, String) - Method in class com.caplin.permissioning.User: Check if the User is authorised to perform action in that permissionNameSpace on the specified product.
isPrefixIdWithIdentifier() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: When true then the ID will be prefixed with the blotterIdentifier followed by a dash.
isTransactionInProgress() - Method in class com.caplin.permissioning.PermissioningDataSource: Determine whether an underlying transaction is already in progress - use before invoking startTransaction to guard against a TransactionInProgressException
isType(String) - Method in interface com.caplin.trading.TradeEvent: Confirms that the TradeEvent is of a certain type
isUseGenericObjects() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Gets whether generic objects should be used instead of Type1 Records
iterator() - Method in class com.caplin.management.jmx.relations.RelationSet: Returns an iterator over the elements in this set.

J

JavaUtilLoggerProvider - Class in com.caplin.permissioning.logging: An adapter for PermissioningLogger, so that the Permissioning system can log to the java Logger.
JavaUtilLoggerProvider(Logger) - Constructor for class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Creates a Permissioning LoggerProvider that adapts Permissioning logging to the Logger provided.
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.

K

KEYMASTER - Static variable in class com.caplin.permissioning.Constants: The reserved value keymaster that signifies the user will log in with a Keymaster SSO Token

L

Leg - Interface in com.caplin.trading: Trades are comprised of one or more trade legs, each representing the exchange of a financial instrument and the resultant cashflow.
LegAction - Interface in com.caplin.trading: The LegAction interface represents a change to the legs that make up a trade.
LegAction.LegActionType - Enum in com.caplin.trading: An enumeration of possible actions that can be performed on a leg.
logDebug(String) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log a debug level message to the Logger that this class was created with.
logDebug(String, Object...) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log a debug level message to the Logger that this class was created with.
logDebug(String) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log a debug level message
logDebug(String, Object...) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log an info level message with items to be incorporated into the message string
logDebug(String) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log a debug level message
logDebug(String, Object...) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log an info level message with items to be incorporated into the message string
logError(String) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log an error level message to the Logger that this class was created with.
logError(String, Throwable) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log an error level message to the Logger that this class was created with.
logError(String) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log an error level message
logError(String, Throwable) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log an error level message with items to be incorporated into the message string
logError(String) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log an error level message
logError(String, Throwable) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log an error level message with items to be incorporated into the message string
logger - Variable in class com.caplin.datasource.subscription.BaseSubscriptionListener: Provides protected access to the logger that was passed to the constructor.
LoggerProvider - Interface in com.caplin.permissioning.logging: A logging interface that the LoggerProvider uses to log with.
logInfo(String) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log an info level message to the Logger that this class was created with.
logInfo(String, Object...) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log an info level message to the Logger that this class was created with.
logInfo(String) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log an info level message
logInfo(String, Object...) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log an info level message with items to be incorporated into the message string
logInfo(String) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log an info level message
logInfo(String, Object...) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log an info level message with items to be incorporated into the message string
logTradingSystemMessage(Level, String) - Method in class com.caplin.trading.TradingProvider: Log a message to the TradingProvider message logger.
logWarn(String) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log a warn level message to the Logger that this class was created with.
logWarn(String, Object...) - Method in class com.caplin.permissioning.logging.JavaUtilLoggerProvider: Log a warn level message to the Logger that this class was created with.
logWarn(String) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log a warn level message
logWarn(String, Object...) - Method in interface com.caplin.permissioning.logging.LoggerProvider: Log a warn level message with items to be incorporated into the message string
logWarn(String) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log an warn level message
logWarn(String, Object...) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Log a warn level message with items to be incorporated into the message string
LongAttributeListener - Interface in com.caplin.management.jmx: This interface is for registering with MBeanServerManagerImpl.registerLongAttributeChangedListener(String, LongAttributeListener) and will receive callbacks to LongAttributeListener.onChanged(Long) when MBeanServerManagerImpl.notifyLongAttributeChanged(String, Long) is invoked with a matching attributeName.

M

main(String[]) - Static method in class com.caplin.datasource.DataSourceFactory: Used to start the datasource and read the configuration file so the resultant configuration attribute values can be returned using the --get-config-value="attribute name" command line option.
MappingMessage - Interface in com.caplin.datasource.messaging.mapping: Interface for sending MappingMessages.
mapSubject(String) - Method in class com.caplin.permissioning.RegexSuffixSubjectMapper: You do not call this method directly; it is called in the Permissioning Auth Module to map objects each time a new RTTP object is requested or contributed to.
mapSubject(String) - Method in interface com.caplin.permissioning.SubjectMapper: This method is called by the Permissioning Auth Module when Liberator receives an RTTP message from the client application.
mapSubject(String) - Method in class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.

Called by the Permissioning Auth Module to map the passed in subject using the current set of subject mappings.
match(String) - Method in interface com.caplin.datasource.namespace.Namespace: Tests a String to see if it falls within this Namespace.
match(String) - Method in class com.caplin.datasource.namespace.PrefixNamespace: Tests a String to see if it falls within this Namespace.
match(String) - Method in class com.caplin.datasource.namespace.RegexNamespace: Tests a String to see if it falls within this Namespace.
MBeanServerManager - Interface in com.caplin.management.jmx: This is an interface for a wrapper class, MBeanServerManagerImpl that wraps an Java MBeanServer and provides several useful abstractions.
MBeanServerManagerFactory - Class in com.caplin.management.jmx
MBeanServerManagerFactory() - Constructor for class com.caplin.management.jmx.MBeanServerManagerFactory
MBeanServerManagerImpl - Class in com.caplin.management.jmx
MBeanServerManagerNullImpl - Class in com.caplin.management.jmx
Message - Interface in com.caplin.datasource.messaging: A Message represents a DataSource message containing an update to an existing subject or a complete image of it.
MessageFactory - Interface in com.caplin.datasource.messaging: A message factory is used to create DataSource messages that can be published to other DataSources.

N

name - Variable in class com.caplin.permissioning.Permissionable
Namespace - Interface in com.caplin.datasource.namespace: A Namespace is used to determine if a subject is of interest to an DataProvider.
newInstance(MBeanServer, String, Logger) - Static method in class com.caplin.management.jmx.MBeanServerManagerFactory: Creates a new MBeanServerManager with which to register JMXBean annotated objects.
NewsMessage - Interface in com.caplin.datasource.messaging.news: An instance of NewsMessage defines the headline text that provides a brief description of a news story (see StoryMessage).
newsUpdated(Subscription, Peer, NewsMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
newsUpdated(Subscription, Peer, NewsMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when a news headline update is received.
Notification - Class in com.caplin.datasource.notification: Notification represents a single notification to be sent to a client.
Notification(String) - Constructor for class com.caplin.datasource.notification.Notification
NotificationApplicationListener - Interface in com.caplin.datasource.notification: You must implement this interface.
NotificationChannel - Interface in com.caplin.datasource.notification: The NotificationChannel is a notification communication channel associated with a particular user.
notificationChannelClosed(NotificationChannel) - Method in interface com.caplin.datasource.notification.NotificationApplicationListener: Callback invoked when a discard for a notification channel is received.
NotificationChannelListener - Interface in com.caplin.datasource.notification: You should implement (and register) the NotificationChannelListener if you want to receive a callback when a user has dismissed a notification from their screen.
notificationChannelOpened(NotificationChannel) - Method in interface com.caplin.datasource.notification.NotificationApplicationListener: Callback invoked when a request for the notification channel is received.
NotificationConfiguration - Class in com.caplin.datasource.notification: The type NotificationConfiguration, which can be used to create a NotificationProvider instance.
NotificationConfiguration(String) - Constructor for class com.caplin.datasource.notification.NotificationConfiguration: Instantiates a new NotificationConfiguration.
NotificationProvider - Class in com.caplin.datasource.notification: If you want to manage notifications within your application you MUST create an instance of this class.
NotificationProvider(DataSource, NotificationConfiguration, NotificationApplicationListener) - Constructor for class com.caplin.datasource.notification.NotificationProvider: Create a NotificationProvider registering your application.
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
NoTransactionInProgressException - Exception in com.caplin.permissioning: Thrown when an attempted operation requires a transaction to be in progress; however one is not.

O

OBJECT_NAME_ENCODER_CLASS_PROPERTY_NAME - Static variable in class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor: The name of the system property that must be used to specify the fully qualified class name of the ObjectNameEncoder that should be used to encode ObjectName values.
ObjectNameEncoder - Interface in com.caplin.management.jmx.encoder: Defines methods that should be used to encode and decode values included within an ObjectName.
ObjectNameEncoderAccessor - Class in com.caplin.management.jmx.encoder: Accessor class that should be used to get the ObjectNameEncoder that will be used to encode and decode ObjectName values.
ObjectNameEncoderAccessor.DefaultObjectNameEncoder - Class in com.caplin.management.jmx.encoder: Standard ObjectNameEncoder that will be used if the ObjectNameEncoderAccessor.OBJECT_NAME_ENCODER_CLASS_PROPERTY_NAME system property is not set, or if there is a problem with the specified class.
ObjectNameEncoderAccessor.DefaultObjectNameEncoder() - Constructor for class com.caplin.management.jmx.encoder.ObjectNameEncoderAccessor.DefaultObjectNameEncoder
ObjectNameLink - Interface in com.caplin.management.jmx.relations.links: Represents a relationship between one MBean and another.
ObjectNameLinkImpl - Class in com.caplin.management.jmx.relations.links: Default implementation of the ObjectNameLink interface.
ObjectNameLinkImpl(ObjectName, String) - Constructor for class com.caplin.management.jmx.relations.links.ObjectNameLinkImpl: Constructs an ObjectNameLinkImpl with the specified ObjectName and human readable link name.
OhlcvData - Class in com.caplin.charting: OhlcvData represents a datapoint on a chart with Open, High, Low, Close and Volume.
OhlcvData(Date, double, double, double, double, double) - Constructor for class com.caplin.charting.OhlcvData
onBlotterItemRequest(BlotterChannel, String) - Method in interface com.caplin.datasource.blotter.BlotterChannelListener: Called when a previously unsubmitted item in a blotter channel is requested.
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.
onNotificationAction(NotificationChannel, String, String) - Method in interface com.caplin.datasource.notification.NotificationChannelListener: Called when a contrib comes in for a Notification serviced by this provider.
onNotificationRequest(NotificationChannel, String) - Method in interface com.caplin.datasource.notification.NotificationChannelListener: Called when a previously unsubmitted notification in a channel is requested.
onPeerStatus(PeerStatusEvent) - Method in interface com.caplin.datasource.ConnectionListener: Invoked when a DataSource peer changes state.
onPeerStatus(PeerStatusEvent) - Method in class com.caplin.trading.TradingProvider
onRequest(RequestEvent) - Method in interface com.caplin.datasource.publisher.DataProvider: Callback that informs the DataProvider that a new request has been received and it should start sending data.

P

PageElement - Interface in com.caplin.datasource.messaging.page: Interface that represents an update to a region of a Page.
PageMessage - Interface in com.caplin.datasource.messaging.page: An instance of PageMessage represents updates to a Page subject.
pageUpdated(Subscription, Peer, PageMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
pageUpdated(Subscription, Peer, PageMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when a page update is received.
parents - Variable in class com.caplin.permissioning.Permissionable
password - Variable in class com.caplin.permissioning.User
Peer - Interface in com.caplin.datasource: Represents a DataSource peer.
peerDown(int) - Method in interface com.caplin.trading.TradingApplicationListener: Called when a peer connection is lost.
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.
peerUp(int) - Method in interface com.caplin.trading.TradingApplicationListener: Called when a peer connection is established.
PERMISSION_NAMESPACE - Static variable in class com.caplin.permissioning.Constants
Permissionable - Class in com.caplin.permissioning: Classes that extend this class can be assigned permissions.
PermissionableNotFoundException - Exception in com.caplin.permissioning: Thrown when asking the PermissioningDataSource for a Permissionable that has not been added.
PermissioningDataSource - Class in com.caplin.permissioning: When a PermissioningDataSource is constructed it must be supplied with a DataSource object.
PermissioningDataSource(DataSource, Role) - Constructor for class com.caplin.permissioning.PermissioningDataSource: Creates a new PermissioningDataSource having a given role (master or slave) and an associated DataSource instance that allows the PermissioningDataSource to communicate with Liberator.
PermissioningLogger - Class in com.caplin.permissioning.logging: Provides way of injecting a different logging strategy for the Permissioning domain objects.
PermissionMessage - Interface in com.caplin.datasource.messaging.permission: Interface that represents a Permission message.
PermissionPublisher - Class in com.caplin.permissioning
PermissionPublisher(CompatibilityPublisher, BroadcastPublisher, SubscriptionManager, RoleInternal, Logger) - Constructor for class com.caplin.permissioning.PermissionPublisher
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.
permit(Set<String>, String, String...) - Method in class com.caplin.permissioning.Permissionable: Adds a permission that allows one or more actions on a product set and namespace.
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.
productPermissionSets - Variable in class com.caplin.permissioning.Permissionable
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.
publishNotification(String, Notification) - Method in class com.caplin.datasource.notification.NotificationProvider
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

receiveBlotterEvent(BlotterEvent) - Method in interface com.caplin.trading.BlotterTradeListener: Deprecated.

Called when a BlotterEvent is generated by the TradingDataSource.
receiveEvent(TradeEvent) - Method in interface com.caplin.trading.TradeListener: Called when an event is generated (usually as a result of a client action) that causes the Trade to transition from one state to another.
receiveInvalidFieldsEvent(InvalidFieldsEvent) - Method in interface com.caplin.trading.TradeListener: A state transition defined in the trade model configuration can specify message fields that are relevant to that transition (see the document Caplin Trading: Trade Model Configuration XML Reference).
receiveInvalidTransitionEvent(InvalidTransitionEvent) - Method in interface com.caplin.trading.TradeListener: Called when a client event would trigger an invalid state transition in the trade model (that is, the triggering event is not valid for the current state of the trade model, or the trade model state requires that the event originates from the server, not the client).
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.
RegexSuffixSubjectMapper - Class in com.caplin.permissioning: This implementation of the SubjectMapper interface maps subjects in the same manner as the default SubjectMapper (see the section on Mapping Logic, below), but unlike the default SubjectMapper it permits multiple mappings to be added to it.
RegexSuffixSubjectMapper() - Constructor for class com.caplin.permissioning.RegexSuffixSubjectMapper
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(String) - Method in class com.caplin.permissioning.DefaultGlobalContext: Removes from the GlobalContext, the passed in identifier and the Map of key-value pairs for that identifier.
remove(String) - Method in interface com.caplin.permissioning.GlobalContext: Removes from the GlobalContext, the passed in identifier and the Map of key-value pairs for that identifier.
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.
removeAllPermissions() - Method in class com.caplin.permissioning.Permissionable: Removes every permission for this Permissionable.
removeAllSubjectMappings() - Method in class com.caplin.permissioning.User: Removes all subject mappings for this User, regardless of the method was used to add them.
removeAttribute(String) - Method in class com.caplin.permissioning.User: Removes the named attribute from this user.
removeBlotterItem(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Removes the BlotterItem from the internal cache and sends a container remove so that this item is no longer requested when the channel is subscribed to.
removeBlotterItems(List<String>) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Removes BlotterItems from the internal cache and sends a container remove so that these items are no longer requested when the channel is subscribed to.
removeBlotterTradeListener(BlotterChannel, BlotterTradeListener) - Method in class com.caplin.trading.TradingProvider: De-registers the provided listener from receiving auto-generated trade lifecycle blotter events.
removeConnectionListener(ConnectionListener) - Method in interface com.caplin.datasource.DataSource: Removes a previously registered connection listener.
removeElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Removes an element with the given subject from the container.
removeElement(String) - Method in interface com.caplin.datasource.messaging.container.ContainerModel: Called to indicate that you should remove the element with the given subject from the container.
removeElementsWithPrefix(String) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Adds an operation to remove all elements from the container that have a subject that match the specified prefix.
removeElementsWithPrefix(String) - Method in interface com.caplin.datasource.messaging.container.ContainerModel: Called to indicate that you should remove all elements from the container that have a subject that matches the specified prefix.
removeField(String) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Removes all instances of the given field from this permission message.
removeField(String) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Removes all occurrences of the given field from this RecordMessage.
removeGlobalContextData(String) - Method in class com.caplin.permissioning.PermissioningDataSource: Removes from the GlobalContext, the data identified by identifier.
removeGroup(Group) - Method in class com.caplin.permissioning.PermissioningDataSource: Removes a given group and implicitly removes the group from all groups of which it is a member.
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
removeMember(Permissionable) - Method in class com.caplin.permissioning.Group: Removes a member from the group.
removeNotification(String) - Method in interface com.caplin.datasource.notification.NotificationChannel: Removes the Notification from the internal cache and sends a container remove so that this notification is no longer requested when the channel is subscribed to.
removeNotifications(List<String>) - Method in interface com.caplin.datasource.notification.NotificationChannel: Removes Notifications from the internal cache and sends a container remove so that these notifications are no longer requested when the channel is subscribed to.
removePermission(Set<String>, String, String...) - Method in class com.caplin.permissioning.Permissionable: Removes a permission for a single action on a product set and namespace.
removeSubjectMappingForKey(String) - Method in class com.caplin.permissioning.User: Removes the subject mappings identified by the passed in key.
removeUpdateListener(RelationSetUpdateListener) - Method in class com.caplin.management.jmx.relations.RelationSet: Removes the specified RelationSetUpdateListener from the RelationSet.
removeUser(User) - Method in class com.caplin.permissioning.PermissioningDataSource: Removes a given User and implicitly removes the User from any Groups of which it is a member.
requestChartData(ChartDataRequest) - Method in interface com.caplin.charting.ChartDataProvider: This call indicates that a request for chart data has been received.
RequestCriteria - Class in com.caplin.charting: A RequestCriteria holds all the parameters that are part of a request for historic chart data.
RequestCriteria(String, String, Date, Date, boolean) - Constructor for class com.caplin.charting.RequestCriteria
RequestEvent - Interface in com.caplin.datasource.publisher: Event that is raised when a peer requests a subject.
restoreTrade(String, String, String) - Method in interface com.caplin.trading.TradeChannel: Creates a trade object to faciliate restoration of a trade with a client.
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.
Role - Enum in com.caplin.permissioning: Defines the possible roles for a PermissioningDataSource
rollbackTransaction() - Method in class com.caplin.permissioning.PermissioningDataSource: Reverts the PermissioningDataSource data to its state before the current transaction was started.

S

sendBlotterItem(BlotterItem) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Adds the BlotterItem to the internal cache and sends a container add so that this item is requested when the channel is subscribed to.
sendBlotterItem(String) - Method in interface com.caplin.trading.BlotterChannel: Deprecated.

Sends a record update for the requested blotter item (container based blotters only).
sendBlotterItemNotFound(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Sends a not found for a BlotterItem.
sendBlotterItems(List<BlotterItem>) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Adds BlotterItems to the internal cache and sends a container add so that these items are requested when the channel is subscribed to.
sendBlotterItemStatusOk(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Send status ok for a BlotterItem.
sendBlotterItemStatusStale(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Send status stale for a BlotterItem.
sendBlotterMessage(BlotterMessage) - Method in interface com.caplin.trading.BlotterChannel: Deprecated.

Sends a blotter message across this channel.
sendBlotterStatusOk() - Method in interface com.caplin.datasource.blotter.BlotterChannel: Sends a status ok on the channel.
sendBlotterStatusStale() - Method in interface com.caplin.datasource.blotter.BlotterChannel: Sends a status stale on the channel.
sendClear(Peer) - Method in class com.caplin.permissioning.PermissionPublisher
sendDataResponse(String, List<OhlcvData>) - Method in interface com.caplin.charting.ChartDataRequest: When data has been retrieved by a ChartDataProvider for a request, it should call sendDataResponse with the retrieved data.
sendEmptyBlotter() - Method in interface com.caplin.datasource.blotter.BlotterChannel: Sends an empty container on the channel.
sendEmptyNotificationContainer() - Method in interface com.caplin.datasource.notification.NotificationChannel: Sends an empty container on the channel.
sendErrorEvent(TradeErrorEvent) - Method in interface com.caplin.trading.Trade: Sends a TradeErrorEvent created by this Trade.
sendErrorResponse() - Method in interface com.caplin.charting.ChartDataRequest: If a ChartDataProvider determines that this request is not valid then it should call sendErrorResponse.
sendEvent(TradeEvent) - Method in interface com.caplin.trading.Trade: Sends an TradeEvent created by this Trade.
sendGlobalDefaults(Peer, PermissionStore) - Method in class com.caplin.permissioning.PermissionPublisher
sendMessage(RecordMessage) - Method in interface com.caplin.datasource.channel.Channel: Sends a record message to the peer that opened the channel.
sendNotification(Notification) - Method in interface com.caplin.datasource.notification.NotificationChannel: Adds the Notification to the internal cache and sends a container add so that this notification is requested when the channel is subscribed to.
sendNotificationContainerStatusOk() - Method in interface com.caplin.datasource.notification.NotificationChannel: Sends a status ok on the channel.
sendNotificationContainerStatusStale() - Method in interface com.caplin.datasource.notification.NotificationChannel: Sends a status stale on the channel.
sendNotificationNotFound(String) - Method in interface com.caplin.datasource.notification.NotificationChannel: Sends a not found for a Notification.
sendNotifications(List<Notification>) - Method in interface com.caplin.datasource.notification.NotificationChannel: Adds Notifications to the internal cache and sends a container add so that these items are requested when the channel is subscribed to.
sendNotificationStatusOk(String) - Method in interface com.caplin.datasource.notification.NotificationChannel: Send status ok for a Notification.
sendNotificationStatusStale(String) - Method in interface com.caplin.datasource.notification.NotificationChannel: Send status stale for a Notification.
sendRecordMessage(RecordMessage) - Method in interface com.caplin.datasource.channel.Channel: Deprecated.
use sendMessage instead
sendRules(Peer, PermissionStore) - Method in class com.caplin.permissioning.PermissionPublisher
sendRulesAndGlobalDefaults(Peer, PermissionStore) - Method in class com.caplin.permissioning.PermissionPublisher
sendSubjectError(String, SubjectError) - Method in interface com.caplin.datasource.channel.Channel: Sends a subject error event to the peer that opened the channel.
setAttribute(Attribute) - Method in class com.caplin.management.jmx.JMXBeanWrapper
setAttribute(String, String) - Method in class com.caplin.permissioning.User: Sets an attribute on this user.
setAttributes(AttributeList) - Method in class com.caplin.management.jmx.JMXBeanWrapper
setAutoPermit(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Sets auto permit enabled/disabled.
setAutoSendEmptyContainer() - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Sets whether an empty container should automatically be sent or now when the channel opens
setBlotterChannelListener(BlotterChannelListener) - Method in interface com.caplin.datasource.blotter.BlotterChannel: Sets a BlotterChannelListener on the channel.
setChannelUsingImageFlag(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Set to true and the channel container will use an image flag when sending the initial message
setContainerThrottleMillis(int) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Specify the millisecond delay used to throttle subsequent operations to a single container.
setContent(int, int, String) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Updates the contents of the page at the specified location.
setDeleteEntryFlag(Boolean) - Method in interface com.caplin.datasource.messaging.record.RecordType2Message: Sets a value indicating whether this Type2 index should be deleted.
setDeletePermissionKey(boolean) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Sets a value in this permission message indicating whether the permission key must be deleted from Liberator's cache.
setDoNotAuthenticate(boolean) - Method in interface com.caplin.datasource.messaging.container.ContainerMessage: Sets a boolean value indicating whether this ContainerMessage's constituents should be authenticated by an authentication module when the container is subscribed to.
setField(String, String) - Method in class com.caplin.datasource.blotter.BlotterItem
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.
setField(String, String) - Method in class com.caplin.datasource.notification.Notification
setFields(Map<String, String>) - Method in class com.caplin.datasource.blotter.BlotterItem
setFields(Map<String, String>) - Method in class com.caplin.datasource.notification.Notification
setGlobal(boolean) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage: Sets a value indicating whether this PermissionMessage is a global permission message.
setGlobalContext(GlobalContext) - Method in class com.caplin.permissioning.RegexSuffixSubjectMapper: This method is a no-op as RegexSuffixSubjectMapper's do not utilise data from the GlobalContext.
setGlobalContext(GlobalContext) - Method in interface com.caplin.permissioning.SubjectMapper: This method is called by the Permissioning Auth Module when the GlobalContext is updated at the PermissioningDataSource as part of a transaction.
setGlobalContext(GlobalContext) - Method in class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.

This method is a no-op as SwitchByKeySubjectPatternMapper's do not utilise data from the GlobalContext.
setHeight(int) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Sets the height of the page, in text rows.
setImage(boolean) - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage
setImage(boolean) - Method in interface com.caplin.datasource.messaging.Message: Sets a boolean value indicating whether this Message represents an image of the data or an update to it.
setInitialLatencyChainTime(long) - Method in interface com.caplin.datasource.messaging.record.RecordMessage: Starts a latency chain if enabled using the latencyChainManager configuration option.
setInitialTimestamp(Date) - Method in interface com.caplin.trading.TradeEvent: Sets LTY_INIT_TS field to this TradeEvent.
setItemUsingImageFlag(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Set to true and the channel items will use image flags when sending their initial messages
setLogger(LoggerProvider) - Static method in class com.caplin.permissioning.logging.PermissioningLogger: Set the LoggerProvider that the LoggerProvider will use.
setMoveItemToTopWhenModified(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Sets whether to move an existing item to the top of the container when sendBlotterItem with an Item with the same ID gets called again
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).
setNotificationChannelListener(NotificationChannelListener) - Method in interface com.caplin.datasource.notification.NotificationChannel: Your application SHOULD set a NotificationChannelListener on the channel.
setNotificationUsingImageFlag(boolean) - Method in class com.caplin.datasource.notification.NotificationConfiguration: Set the Notification records' image flags to be set to true on publishing initial message.
setPageType(String) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Sets the type of the page.
setParent(BlotterItem) - Method in class com.caplin.datasource.blotter.BlotterItem
setParentItem(BlotterItem) - Method in class com.caplin.datasource.blotter.BlotterItem
setPassword(String) - Method in class com.caplin.permissioning.User: Set this User's password.
setPasswordKeymaster() - Method in class com.caplin.permissioning.User: Sets this User's password field to indicate that a KeyMaster token (as opposed to a text password) should be used to authenticate this user.
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.
setPrefixIdWithIdentifier(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Set to false to turn off prefixing of ID's with the blotterIdentifier followed by a -.
setRestorationId(String) - Method in interface com.caplin.trading.TradeEvent: Sets an id that will identify a trade restoration message.
setSerializer(Serialiser) - Method in class com.caplin.permissioning.PermissionPublisher
setStatusDown() - Method in interface com.caplin.datasource.DataSource: Causes the DataSource to disconnect and stop listening for connections.
setStatusDown() - Method in interface com.caplin.datasource.Peer: Stops this peer from making connections to its remote peer.
setStatusUp() - Method in interface com.caplin.datasource.DataSource: Causes the DataSource to reconnect and listen for connections.
setStatusUp() - Method in interface com.caplin.datasource.Peer: Allows this peer to make connections to its remote peer.
setStoryReference(String) - Method in interface com.caplin.datasource.messaging.news.NewsMessage: Sets a reference that identifies the story associated with the headline.
setSubcontainerMaxDepth(int) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Sets the subcontainer maximum depth.
setSubjectMapper(String) - Method in class com.caplin.permissioning.User: Sets the class that implements the SubjectMapper interface for this User.
setTradeChannelListener(TradeChannelListener) - Method in interface com.caplin.trading.TradeChannel: Sets the ChannelListener for this TradeChannel.
setTradeListener(TradeListener) - Method in interface com.caplin.trading.Trade: Sets the TradeListener for this trade.
setUseGenericObjects(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration: Set whether the API should use generic objects instead of Type1 records.
setValue(String) - Method in interface com.caplin.datasource.messaging.Field: Sets the field value.
setWidth(int) - Method in interface com.caplin.datasource.messaging.page.PageMessage: Sets the width of the page, in text columns.
size() - Method in class com.caplin.management.jmx.relations.RelationSet: Returns the number of elements in this set (its cardinality).
start() - Method in interface com.caplin.datasource.DataSource: Starts this DataSource.
startImageTransaction() - Method in class com.caplin.permissioning.PermissioningDataSource: Starts an image transaction, which should be used to set the permissioning data.
startImageTransaction(boolean) - Method in class com.caplin.permissioning.PermissioningDataSource: Starts an image transaction, which should be used to set the permissioning data.
startUpdateTransaction() - Method in class com.caplin.permissioning.PermissioningDataSource: Starts an update transaction, which should be used to make changes to the existing permissioning data.
startUpdateTransaction(boolean) - Method in class com.caplin.permissioning.PermissioningDataSource: Starts an update transaction, which should be used to make changes to the existing permissioning data.
stop() - Method in interface com.caplin.datasource.DataSource: Stops this DataSource.
StoryMessage - Interface in com.caplin.datasource.messaging.story: An instance of StoryMessage represents a news story.
storyUpdated(Subscription, Peer, StoryMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
storyUpdated(Subscription, Peer, StoryMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when a story update is received.
SubjectError - Enum in com.caplin.datasource: Enumeration that defines the possible types of subject error.
SubjectError.Flags - Enum in com.caplin.datasource
SubjectErrorEvent - Interface in com.caplin.datasource: Represents an event raised when there is an error in a subscription to a subject.
subjectErrorReceived(Subscription, Peer, SubjectErrorEvent) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
subjectErrorReceived(Subscription, Peer, SubjectErrorEvent) - Method in interface com.caplin.datasource.subscription.SubscriptionListener: Called when there is an error in a subscription.
SubjectMapper - Interface in com.caplin.permissioning: The SubjectMapper interface must be implemented by any custom SubjectMapper class that you write.
subjectMapper - Variable in class com.caplin.permissioning.User
SubjectMapping - Class in com.caplin.permissioning: A convenience class that can be used by implementations of SubjectMapper to store the keys and subject mappings passed to its updateMappings method.
SubjectMapping(String, Map<String, String>) - Constructor for class com.caplin.permissioning.SubjectMapping: Creates a new SubjectMapping using the passed in key and map.
subjectMappingInfo - Variable in class com.caplin.permissioning.User
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.
SwitchableSubjectMapper - Interface in com.caplin.permissioning: Deprecated.
This interface exists purely to support a mode of TOBO that is inferior in many ways to the other supported TOBO modes. It is unnecessarily expensive in memory usage, creates potential for data inconsistencies if used incorrectly by an API client and is undocumented to strongly discourage its use. You should use one of the TOBO modes documented in the Permissioning Guides.
SwitchByKeySubjectPatternMapper - Class in com.caplin.permissioning: Deprecated.
See the deprecation warning in SwitchableSubjectMapper.
SwitchByKeySubjectPatternMapper() - Constructor for class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.
switchMappings(String, Map<String, String>) - Method in interface com.caplin.permissioning.SwitchableSubjectMapper: Deprecated.

This method is called by the Permissioning Auth Module when it receives an RTTP request from the client application to switch to a named set of subject mappings.
switchMappings(String, Map<String, String>) - Method in class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.

Called by the Permissioning Auth Module to switch the current set of subject mappings to the set requested by the client application.
switchToDefaultMappings() - Method in interface com.caplin.permissioning.SwitchableSubjectMapper: Deprecated.

This method is called by the Permissioning Auth Module when a user logs in, or if the set of subject mappings currently being applied are removed while the user is logged in.
switchToDefaultMappings() - Method in class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.

Called by the Permissioning Auth Module to switch the current set of subject mappings to the default set.

T

terminate() - Method in class com.caplin.trading.TradingProvider: Closes all channels and cleans up all trades.
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.
toKey() - Method in enum com.caplin.trading.EventSource
toPrettyString(StringBuilder, String) - Method in interface com.caplin.datasource.DataSourceConfiguration
toRecordItem(BlotterConfiguration, String, String) - Method in class com.caplin.datasource.blotter.BlotterItem
toRecordItem(String, String) - Method in class com.caplin.datasource.notification.Notification
toString() - Method in class com.caplin.charting.OhlcvData
toString() - Method in class com.caplin.charting.RequestCriteria
toString() - Method in class com.caplin.datasource.blotter.BlotterConfiguration
toString() - Method in class com.caplin.datasource.blotter.BlotterItem
toString() - Method in class com.caplin.datasource.namespace.PrefixNamespace
toString() - Method in class com.caplin.datasource.namespace.RegexNamespace
toString() - Method in class com.caplin.datasource.notification.Notification
toString() - Method in class com.caplin.datasource.notification.NotificationConfiguration
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().
toString() - Method in class com.caplin.permissioning.Group: Returns a string representation of Group.
toString() - Method in class com.caplin.permissioning.PermissioningDataSource: Returns a string that describes this PermissioningDataSource , including its master/slave role and the message protocol that it uses.
toString() - Method in class com.caplin.permissioning.RegexSuffixSubjectMapper
toString() - Method in class com.caplin.permissioning.SubjectMapping: Returns a string representation of this SubjectMapping.
toString() - Method in class com.caplin.permissioning.User: Returns a string representation of User.
toString() - Method in enum com.caplin.trading.EventSource
Trade - Interface in com.caplin.trading: A single Trade active in the system.
TradeChannel - Interface in com.caplin.trading: An open trade messaging communications channel with an end user.
TradeChannelListener - Interface in com.caplin.trading: Provides notifications relating to the Trade lifecycle.
tradeClosed(Trade) - Method in interface com.caplin.trading.TradeChannelListener: Called when a trade has closed due to it reaching a terminal state, or the channel is being closed while the trade is in progress.
tradeCreated(Trade) - Method in interface com.caplin.trading.TradeChannelListener: Called when a new trade is initiated by a client.
TradeErrorEvent - Interface in com.caplin.trading
TradeEvent - Interface in com.caplin.trading: A single event acting on a Trade.
TradeException - Exception in com.caplin.trading: Used for all errors raised by the Trading DataSource, or raised by user code that needs to notify the Trading DataSource of an exception during a callback.
TradeException(String) - Constructor for exception com.caplin.trading.TradeException
TradeException(String, Throwable) - Constructor for exception com.caplin.trading.TradeException
TradeListener - Interface in com.caplin.trading: Used to receive TradeEvents from the system.
TradingApplicationListener - Interface in com.caplin.trading: Use the TradingApplicationListener interface to be notified of TradeChannel and BlotterChannel lifecycle events.
TradingProvider - Class in com.caplin.trading: All Trading DataSource applications must create an instance of this class.
TradingProvider(TradingApplicationListener, DataSource) - Constructor for class com.caplin.trading.TradingProvider: Creates a TradingProvider that uses, for Liberator communication, a preconfigured DataSource passed to the constructor.
TradingProvider(TradingApplicationListener, DataSource, Properties) - Constructor for class com.caplin.trading.TradingProvider: Creates a TradingProvider that uses, for Liberator communication, a preconfigured DataSource passed to the constructor.
TransactionInProgressException - Exception in com.caplin.permissioning: Thrown when an attempt is made to start a new transaction if another transaction is still in progress.

U

uniqueId - Variable in class com.caplin.datasource.notification.Notification
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.
update(String, Map<String, String>) - Method in class com.caplin.permissioning.DefaultGlobalContext: Saves the passed in identifier and data, and makes the data available to the get() methods of this interface.
update(String, Map<String, String>) - Method in interface com.caplin.permissioning.GlobalContext: Saves the passed in identifier and data, and makes the data available to the get() methods of this interface.
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.
updateGlobalContext(String, Map<String, String>) - Method in class com.caplin.permissioning.PermissioningDataSource: Adds data to the GlobalContext.
updateMappings(String, Map<String, String>) - Method in class com.caplin.permissioning.RegexSuffixSubjectMapper: You do not call this method directly; it is called when you invoke User.addSubjectMapping(String, Map) on a User that is using this type of SubjectMapper class.
updateMappings(String, Map<String, String>) - Method in interface com.caplin.permissioning.SubjectMapper: This method is called by the Permissioning Auth Module when subject mappings are received from the PermissioningDataSource.
updateMappings(String, Map<String, String>) - Method in class com.caplin.permissioning.SwitchByKeySubjectPatternMapper: Deprecated.

Called by the Permissioning Auth Module to add the passed in set of subject mappings to any existing sets of subject mappings.
User - Class in com.caplin.permissioning: Represents a permissioned user that is able to log on to Caplin Trader.

V

VALUE - Static variable in class com.caplin.permissioning.Constants: The value field
valueOf(String) - Static method in enum com.caplin.datasource.messaging.container.ContainerOperationType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.PeerStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.SubjectError.Flags: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.SubjectError: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.datasource.SubjectStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.permissioning.Authorization: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.permissioning.Role: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.trading.EventSource: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.trading.LegAction.LegActionType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.caplin.datasource.messaging.container.ContainerOperationType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.PeerStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.SubjectError.Flags: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.SubjectError: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.datasource.SubjectStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.management.jmx.JMXBeanOperation.IMPACT_TYPES: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.permissioning.Authorization: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.permissioning.Role: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.trading.EventSource: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.trading.LegAction.LegActionType: 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.
wrapPermissionMessages(String, List<PermissionMessage>) - Method in class com.caplin.permissioning.PermissionPublisher

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