com.apama.position.tracker
Event PSTrackerManagerInterface


This interface allows the Position Tracker to update/publish the position it is tracking, as well as querying information about this Position Tracker instance.

This interface should not be created directly by applications. Instead, this interface is created by the Position Tracker Factory object (com.apama.position.tracker.PSTrackerFactory) when a new Position Tracker has been registered with the Position Service.
See Also:
com.apama.position.tracker.PSTrackerFactory - The user-level interface that is used to create an instance of the Position Tracker Interface

Member Summary
 action<integer, com.apama.position.Position >updateAbsolutePosition

This action causes the cached position of the specified instance to be updated by an absolute position, and the update is then published to the set of publication contexts for that instance.
 action<integer, com.apama.position.Position >updateRelativePosition

This action causes the cached position of the specified instance to be updated by a relative position, and the update is then published to the set of publication contexts for that instance.
 action<integer, com.apama.position.Position >updateAbsolutePositionWithoutPublication

This action causes the cached position of the specified instance to be updated by an absolute position. This action is similar to the updateAbsolutePosition() action, but the position update is not published.
 action<integer, com.apama.position.Position >updateRelativePositionWithoutPublication

This action causes the cached position of the specified instance to be updated by a relative position. This action is similar to the updateRelativePosition() action, but the position update is not published.
 action<integer >publishPosition

This action publishes the specified instances current position to the set of publication contexts.
 action<integer, integer, com.apama.position.Position >publishSymbolSlicePosition

This action publishes the specified position update to a Symbol Slice to the set of publication contexts.
 action< > returns integergetTrackerId

This action returns the Position Tracker Interface Id of the current interface. This ID uniquely identifies an instance of the Position Tracker Interface.
 action<integer > returns sequence<context >getPublicationContexts

This action returns a sequence of contexts that the position will be published to for a specified Position Tracker instance.
 action<integer > returns com.apama.position.PositionConfigParamsgetConfigDetails

This action returns the configuration details of a specific subscription that was made to the Position Tracker instance.
 action< > returns dictionary<integer, com.apama.position.PositionConfigParams >getAllConfigDetails

This action returns the configuration details of all subscriptions that were made to the Position Tracker instance.
 action<integer > returns com.apama.position.PositiongetCurrentPosition

This action returns current position information for the specified Position Tracker instance.
 action< > returns dictionary<integer, com.apama.position.Position >getAllCurrentPositions

This action returns current position information for all Position Tracker instances.
 action<action<integer, boolean, string > >deregisterTracker

This action deletes the existing Position Tracker Interface, and cleans up any existing state information held by this interface.
 
Member Detail

deregisterTracker

action<action<integer, boolean, string > > deregisterTracker
This action deletes the existing Position Tracker Interface, and cleans up any existing state information held by this interface.

The user provides an action that will be called back on response to the delete request (IE whether it was successful or not).


param cbDeregistered This callback that will be called on response to this request

getAllConfigDetails

action< > returns dictionary<integer, com.apama.position.PositionConfigParams > getAllConfigDetails
This action returns the configuration details of all subscriptions that were made to the Position Tracker instance.


param The subscription ID to get the list of configuration details for
return The configuration details of all subscriptions that were made to the Position Tracker instance, keyed by the subscriptionId

getAllCurrentPositions

action< > returns dictionary<integer, com.apama.position.Position > getAllCurrentPositions
This action returns current position information for all Position Tracker instances.

return A dictionary containing the set of current positions for all Position Tracker instances, keyed by the subscriptionId

getConfigDetails

action<integer > returns com.apama.position.PositionConfigParams getConfigDetails
This action returns the configuration details of a specific subscription that was made to the Position Tracker instance.


param The subscription ID to get the configuration details for
return The configuration details of a specific subscription that was made to the Position Tracker instance

getCurrentPosition

action<integer > returns com.apama.position.Position getCurrentPosition
This action returns current position information for the specified Position Tracker instance.


param The subscription ID to get the current position for
return The current position for a specific Position Tracker instance

getPublicationContexts

action<integer > returns sequence<context > getPublicationContexts
This action returns a sequence of contexts that the position will be published to for a specified Position Tracker instance.

This can be used, for instance, by Position Tracker implementations that want to publish a custom Position event to their subscribers.


param The subscription ID to get the list of publication contexts for
return A sequence of contexts that the position will be published to for the given Position Tracker instance

getTrackerId

action< > returns integer getTrackerId
This action returns the Position Tracker Interface Id of the current interface. This ID uniquely identifies an instance of the Position Tracker Interface.


return trackerId The Position Tracker Interface Id of the current interface

publishPosition

action<integer > publishPosition
This action publishes the specified instances current position to the set of publication contexts.


param subscriptionId The ID of the Position Tracker instance whose current position should be published

publishSymbolSlicePosition

action<integer, integer, com.apama.position.Position > publishSymbolSlicePosition
This action publishes the specified position update to a Symbol Slice to the set of publication contexts.


param subscriptionId The ID of the Position Tracker instance whose Symbol Slice update this is for
param updateRefId The update reference id for this Symbol Slice position update
param position The Position update for this Symbol Slice

updateAbsolutePosition

action<integer, com.apama.position.Position > updateAbsolutePosition
This action causes the cached position of the specified instance to be updated by an absolute position, and the update is then published to the set of publication contexts for that instance.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated to

updateAbsolutePositionWithoutPublication

action<integer, com.apama.position.Position > updateAbsolutePositionWithoutPublication
This action causes the cached position of the specified instance to be updated by an absolute position. This action is similar to the updateAbsolutePosition() action, but the position update is not published.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated to

updateRelativePosition

action<integer, com.apama.position.Position > updateRelativePosition
This action causes the cached position of the specified instance to be updated by a relative position, and the update is then published to the set of publication contexts for that instance.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated relative to

updateRelativePositionWithoutPublication

action<integer, com.apama.position.Position > updateRelativePositionWithoutPublication
This action causes the cached position of the specified instance to be updated by a relative position. This action is similar to the updateRelativePosition() action, but the position update is not published.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated relative to