public interface TransformerAccessor
Allows a Transformer module access to the main interfaces it requires to interact with the Transformer core.
Modifier and Type | Field and Description |
---|---|
static int |
F_DEFAULT
Default Subscriber flag.
|
static int |
F_LISTENER_ACCESSORY
Setting this flag on subscribe will cause the subscriber to behave as an accessory listener.
|
Modifier and Type | Method and Description |
---|---|
TransformerPublisher |
createActivePublisher(Namespace namespace,
DataProvider dataProvider)
Creates an
TransformerPublisher for the specified
namespace. |
TransformerPublisher |
createActivePublisher(java.lang.String subject,
DataProvider dataProvider)
Creates an
TransformerPublisher for the specified
subject. |
TransformerActiveSub |
createActiveSubscription(java.lang.String subject,
SubscriptionListener subscriptionListener)
Creates an active subscription to an individual subject.
|
TransformerActiveSub |
createActiveSubscription(java.lang.String subject,
SubscriptionListener subscriptionListener,
int subscriptionFlags)
Creates an active subscription to an individual subject.
|
TransformerBroadcastSub |
createBroadcastSubscription(Namespace namespace,
SubscriptionListener subscriptionListener)
Creates a subscription to many subjects.
|
java.lang.String |
expandFilename(java.lang.String filename)
Returns a fully qualified filename based on % substitution
fields.
|
DataCache |
getDataCache()
Returns an object that allows the Transformer module to access
the data cached within the Transformer's core.
|
FieldManager |
getFieldManager()
Gets the datasource field manager
|
TransformerPublisher |
getGlobalPublisher()
Gets the global Publisher.
|
java.lang.String |
getLogDirectory()
Gets the logging directory configured for the Transformer
|
java.util.logging.Logger |
getLogger()
Returns the
Logger that should be used with this module |
Persistence |
getPersistence() |
PipelineRegistrar |
getPipelineRegistrar()
Returns an object that allows the Transformer module to register
methods for availability in pipelines
|
UDPAccessor |
getUDPAccessor()
Returns an object that allows the Transformer module to access
the Transformer core's UDP command interface.
|
static final int F_DEFAULT
static final int F_LISTENER_ACCESSORY
DataCache getDataCache()
Returns an object that allows the Transformer module to access the data cached within the Transformer's core.
DataCache
object.PipelineRegistrar getPipelineRegistrar()
Returns an object that allows the Transformer module to register methods for availability in pipelines
PipelineRegistrar
object.UDPAccessor getUDPAccessor()
Returns an object that allows the Transformer module to access the Transformer core's UDP command interface. The module will be able to register and deregister listeners for UDP commands, and send its own UDP commands.
UDPAccessor
object.java.lang.String getLogDirectory()
java.util.logging.Logger getLogger()
Returns the Logger
that should be used with this module
java.lang.String expandFilename(java.lang.String filename)
Returns a fully qualified filename based on % substitution fields.
The possible substitution fields are:
filename
- The filename, including % substitution fields, to
expand.java.lang.NullPointerException
- If the filename is null.Persistence getPersistence()
TransformerPublisher createActivePublisher(Namespace namespace, DataProvider dataProvider)
Creates an TransformerPublisher
for the specified
namespace.
A TransformerPublisher
publishes updates that are for
subjects within the specified Namespace
, to all peers that have subscribed to those
subjects.
namespace
- The Namespace
associated with this publisher.dataProvider
- The DataProvider
that can publish data via this publisher.TransformerPublisher
for the supplied
Namespace
.TransformerPublisher createActivePublisher(java.lang.String subject, DataProvider dataProvider)
Creates an TransformerPublisher
for the specified
subject.
A TransformerPublisher
publishes updates for
subjects matched by the input subject parameter.
subject
- The subject to register the provider on. Wildcards may be used if they have been enabled.dataProvider
- The DataProvider
that can publish data via this publisher.TransformerPublisher
for the supplied
subject.TransformerActiveSub createActiveSubscription(java.lang.String subject, SubscriptionListener subscriptionListener)
Creates an active subscription to an individual subject.
If a data service has been configured that matches the given subject and active peers within that data service are connected, a request will be made to those peers for the specified subject.
All events whose subjects match the method's subject parameter are passed to the given
SubscriptionListener
.
TransformerActiveSub.subscribe()
on the returned TransformerActiveSub
object.subject
- The subject to subscribe to.subscriptionListener
- A listener to receive events raised for the ActiveSubscription
.TransformerActiveSub
.TransformerActiveSub createActiveSubscription(java.lang.String subject, SubscriptionListener subscriptionListener, int subscriptionFlags)
Creates an active subscription to an individual subject.
If a data service has been configured that matches the given subject and active peers within that data service are connected, a request will be made to those peers for the specified subject.
All events whose subjects match the method's subject parameter are passed to the given
SubscriptionListener
.
TransformerActiveSub.subscribe()
on the returned TransformerActiveSub
object.subject
- The subject to subscribe to.subscriptionListener
- A listener to receive events raised for the ActiveSubscription
.subscriptionFlags
- Flags to set on the active subscription. Flags can be F_LISTENER_ACCESSORY
and F_DEFAULT
TransformerActiveSub
.TransformerBroadcastSub createBroadcastSubscription(Namespace namespace, SubscriptionListener subscriptionListener)
Creates a subscription to many subjects. The scope of the subscription is defined by a
Namespace
; all events whose subjects match the given
Namespace
are passed to the given
SubscriptionListener
.
TransformerBroadcastSub.subscribe()
on the returned TransformerBroadcastSub
object.namespace
- The Namespace
defining the subjects to subscribe to.subscriptionListener
- A listener to receive events raised for the TransformerBroadcastSub
.TransformerBroadcastSub
.FieldManager getFieldManager()
TransformerPublisher getGlobalPublisher()
Please send bug reports and comments to Caplin support