Modifier and Type | Class and Description |
---|---|
class |
AuthorisationException
This indicates that the server has not authorised a connection.
|
class |
PropertyException
Exception thrown by
PropertyHandler . |
class |
TimeoutException
This is thrown to indicate that a blocking operation has timed out.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ServerConnection.acknowledge(TopicMessage message)
Deprecated.
Acknowledges a message that is
'Pending Acknowledgement' . |
void |
ServerConnection.addTopicListener(TopicListener topicListener,
String... topics)
Deprecated.
Adds a
TopicListener . |
void |
ServerConnection.addTopicListener(TopicListener topicListener,
TopicSet topics)
Deprecated.
Adds a
TopicListener . |
static int |
Utils.byteNumberConverter(String number)
Converts a size into bytes.
|
String |
ServerConnection.connect()
Deprecated.
Connects to the server without subscribing to any topics.
|
String |
ServerConnection.connect(String... topics)
Deprecated.
Connects to the server.
|
String |
ServerConnection.connect(TopicSet topics)
Deprecated.
Connects to the server.
|
static String |
Utils.convertInputStreamToString(InputStream is)
Returns the input stream as a string, using the default defined charset
|
static String |
Utils.convertInputStreamToString(InputStream is,
String charSet)
Returns the input stream as a string, using the specified charset
|
static Document |
XMLUtils.createDocument()
Create an empty DOM Document.
|
static Document |
XMLUtils.createDocument(File file)
Create a DOM document from a file of XML.
|
static Document |
XMLUtils.createDocument(InputStream inputStream)
Create a DOM document from an input stream of XML.
|
static Document |
XMLUtils.createDocument(String xmlString)
Create a DOM document from a String of XML.
|
static Document |
XMLUtils.createDocumentFromResource(String resourceName)
Creates a DOM document from a a resource of the specified name loaded
from the classpath.
|
static LineNumberReader |
Utils.createFileReader(File file)
Creates a reader for a given file.
|
static LineNumberReader |
Utils.createFileReader(FileInputStream fileInputStream)
Creates a reader for a given file input stream.
|
static LineNumberReader |
Utils.createFileReader(FileInputStream fileInputStream,
String charset)
Creates a reader for a given file input stream.
|
static LineNumberReader |
Utils.createFileReader(File file,
String charset)
Creates a reader for a given file.
|
static BufferedWriter |
Utils.createFileWriter(File file)
Creates a buffered writer for a given file.
|
static BufferedWriter |
Utils.createFileWriter(FileOutputStream fileOutputStream)
Creates a writer for a given file output stream.
|
static BufferedWriter |
Utils.createFileWriter(FileOutputStream fileOutputStream,
String charset)
Creates a writer for a given file output stream.
|
static BufferedWriter |
Utils.createFileWriter(File file,
String charset)
Creates a writer for a given file.
|
static LogWriter |
Logs.createLog(LogDescription description)
Create a log from a log description.
|
static LogWriter |
Logs.createLog(String configName)
Create a log from a named log configuration.
|
PagedTopicHandler |
ServerConnection.createPagedTopicHandler(TopicMessage message,
PagedTopicListener listener)
Deprecated.
Creates a handler object for a 'paged' topic.
|
static LineNumberReader |
Utils.createResourceReader(String resourceName)
Creates a reader for a named resource.
|
static LineNumberReader |
Utils.createResourceReader(String resourceName,
String charset)
Creates a reader for a named resource.
|
ServiceTopicHandler |
ServerConnection.createServiceTopicHandler(TopicMessage message,
ServiceTopicListener listener)
Deprecated.
since 5.7 service topics have been deprecated.
|
TopicNotifyTopicHandler |
ServerConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicHandler.NotificationLevel notificationLevel,
TopicNotifyTopicListener listener)
|
TopicNotifyTopicHandler |
ServerConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicListener listener)
Deprecated.
Creates a handler object for a 'Topic Notify' topic.
|
void |
ServerConnection.fetch(String topic,
String... headers)
Deprecated.
Fetch the current state of a set of topics.
|
void |
ServerConnection.fetch(TopicSet topics,
String... headers)
Deprecated.
Fetch the current state of a set of topics.
|
static File |
Utils.getFile(String fileName)
Gets a File object corresponding to a file that is loadable from the
system classpath.
|
static InputStream |
Utils.getResourceAsStream(String resourceName)
Open for reading, a resource of the specified name from the search path
used to load classes.
|
static PropertyHandler |
Utils.loadProperties(String resourceName)
Load properties from a resource of the specified name from the search
path used to load classes.
|
static long |
Utils.millisNumberConverter(String time)
Append the letter h or H to indicate hours, or m or M to indicate minutes
or s or S to indicate seconds
|
void |
ServerConnection.ping()
Deprecated.
Sends a ping message to the server.
|
static String |
Utils.readFileAsString(File file)
Reads the entire contents of a file into a String.
|
static String |
Utils.readFileAsString(File file,
String charset)
Reads the entire contents of a file into a String.
|
boolean |
ServerConnection.send(TopicMessage message)
Deprecated.
Send a message to the server.
|
void |
ServerConnection.sendCredentials(Credentials credentials)
Deprecated.
Send credentials to the server.
|
static String |
XMLUtils.serialize(Document document,
boolean pretty)
Serializes a document to a String.
|
void |
ServerConnection.subscribe(String... topics)
Deprecated.
Subscribes to a set of topics.
|
void |
ServerConnection.subscribe(TopicSet topics)
Deprecated.
Subscribes to a set of topics.
|
void |
ServerConnection.unsubscribe(String... topics)
Deprecated.
Unsubscribes from a set of topics.
|
void |
ServerConnection.unsubscribe(TopicSet topics)
Deprecated.
Unsubscribes from a set of topics.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ExternalClientConnection.acknowledge(TopicMessage message)
Deprecated.
|
void |
ExternalClientConnection.addTopicListener(TopicListener topicListener,
String... topics)
Deprecated.
|
void |
ExternalClientConnection.addTopicListener(TopicListener topicListener,
TopicSet topics)
Deprecated.
|
String |
ExternalClientConnection.connect()
Deprecated.
|
String |
ExternalClientConnection.connect(String... topics)
Deprecated.
|
String |
ExternalClientConnection.connect(TopicSet topics)
Deprecated.
|
PagedTopicHandler |
ExternalClientConnection.createPagedTopicHandler(TopicMessage message,
PagedTopicListener listener)
Deprecated.
|
ServiceTopicHandler |
ExternalClientConnection.createServiceTopicHandler(TopicMessage message,
ServiceTopicListener listener)
Deprecated.
|
TopicNotifyTopicHandler |
ExternalClientConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicHandler.NotificationLevel level,
TopicNotifyTopicListener listener)
Deprecated.
|
TopicNotifyTopicHandler |
ExternalClientConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicListener listener)
Deprecated.
|
void |
ExternalClientConnection.fetch(String topic,
String... headers)
Deprecated.
|
void |
ExternalClientConnection.fetch(TopicSet topics,
String... headers)
Deprecated.
|
void |
ExternalClientConnection.ping()
Deprecated.
|
void |
ExternalClientConnection.reconnect()
Deprecated.
Re-establish the last connection.
|
boolean |
ExternalClientConnection.send(TopicMessage message)
Deprecated.
|
void |
ExternalClientConnection.sendCredentials(Credentials credentials)
Deprecated.
|
void |
ExternalClientConnection.subscribe(String... topics)
Deprecated.
|
void |
ExternalClientConnection.subscribe(TopicSet topics)
Deprecated.
|
void |
ExternalClientConnection.unsubscribe(String... topics)
Deprecated.
|
void |
ExternalClientConnection.unsubscribe(TopicSet topics)
Deprecated.
|
Constructor and Description |
---|
ExternalClientConnection(ServerConnectionListener listener,
String... urls)
Deprecated.
Convenience constructor which allows
ConnectionDetails to be
automatically created from one or more URLs. |
Modifier and Type | Method and Description |
---|---|
void |
TopicNotifyTopicHandler.select(TopicNotifyTopicHandler.SelectionMode mode,
TopicSet selections)
Deprecated.
Sends a request to the server to update the selection of topics that
topic add notifications will be received for.
|
void |
TopicNotifyTopicHandler.setNotificationDetails(TopicNotifyTopicHandler.NotificationLevel addLevel,
boolean notifyRemoval,
boolean notifyUpdate)
Deprecated.
This can be used to set the notification details required.
|
void |
TopicNotifyTopicHandler.setNotificationLevel(TopicNotifyTopicHandler.NotificationLevel level)
|
Modifier and Type | Method and Description |
---|---|
void |
PagedTopicHandler.close()
Deprecated.
Close the Topic.
|
void |
PagedTopicHandler.open(int linesPerPage,
int openPage)
Deprecated.
Open the Topic.
|
void |
PagedTopicHandler.page(int number)
Deprecated.
Requests a page by absolute page number.
|
void |
PagedTopicHandler.page(PageOption page)
Deprecated.
Requests a page, relative to the current page.
|
Modifier and Type | Method and Description |
---|---|
void |
ServiceTopicHandler.request(String requestType,
String requestId,
TopicMessage data)
Deprecated.
Sends a request to the service.
|
String |
ServiceTopicHandler.request(String requestType,
TopicMessage data)
Deprecated.
Sends a request to the Service.
|
Modifier and Type | Class and Description |
---|---|
class |
ConfigException
Exception in Config setting.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
MessageMerger.merge(TopicMessage currentMessage,
TopicMessage newMessage)
Merges the content of two messages to produce a new message.
|
Modifier and Type | Method and Description |
---|---|
static ConnectionDetails |
ConnectionFactory.createConnectionDetails(String... urls)
Deprecated.
Creates Connection Details for a list of URLs.
|
static ServerDetails |
ConnectionFactory.createServerDetails(String url)
Deprecated.
Creates a
ServerDetails object from a URL. |
SocketChannel |
HTTPProxyConnector.doHandshake(ServerDetails serverDetails) |
SocketChannel |
ProxyConnector.doHandshake(ServerDetails serverDetails)
Deprecated.
Implementations must provide this method to make a connection via a
Proxy server and return the SocketChannel.
|
void |
ServerDetails.setWriteTimeout(long timeout)
Deprecated.
Set the write timeout value for blocking writes on the connection.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
PublishingTopicData.generateAckDeltaMessage(String... headers)
As
PublishingTopicData.generateDeltaMessage(String...) but generating a message that
requires acknowledgement. |
TopicMessage |
PublishingTopicData.generateDeltaMessage(String... headers)
Generates a
delta message summarising
changes to the data since updating was started (PublishingTopicData.startUpdate()
was called). |
TopicMessage |
TopicData.getLoadMessage()
This returns the current data state as a Topic Load message.
|
TopicMessage |
PublishingTopicData.getLoadMessage()
This returns the current data state as a
load message. |
TopicMessage |
TopicData.getLoadMessage(TopicClient client)
This returns the current data state as a Topic Load message.
|
void |
TopicDataInitialiser.initialise(String topicName,
TopicTreeNode parent,
PublishingTopicData data)
This is called just before the data is attached to a topic in order to
perform initialisation of the data.
|
void |
PublishingTopicData.initialise(TopicMessage message)
Initialises the data from a supplied message.
|
void |
UniversalTopicData.initialise(V value)
Initialise the topic data.
|
static CustomTopicData |
TopicDataFactory.newCustomData(CustomTopicDataHandler handler)
Deprecated.
since 5.9
This topic type will be removed in a future release |
static PagedRecordTopicData |
TopicDataFactory.newPagedRecordData(MRecord metadata)
Deprecated.
since 5.9
This topic type will be removed in a future release |
static PagedRecordTopicData |
TopicDataFactory.newPagedRecordData(MRecord metadata,
Comparator<Record> comparator)
Deprecated.
since 5.9
This topic type will be removed in a future release |
static PagedStringTopicData |
TopicDataFactory.newPagedStringData()
Deprecated.
since 5.9
This topic type will be removed in a future release |
static PagedStringTopicData |
TopicDataFactory.newPagedStringData(Comparator<String> comparator)
Deprecated.
since 5.9
This topic type will be removed in a future release |
static PBTopicData |
TopicDataFactory.newPBData(String protoClassName,
String messageName)
Deprecated.
since 5.7.
Support for Google Protocol Buffers topics will be removed in
a future release as |
static RecordTopicData |
TopicDataFactory.newRecordData(MMessage metadata)
Create new
Record Topic Data . |
static RoutingTopicData |
TopicDataFactory.newRoutingData(RoutingTopicDataSubscriptionHandler handler)
Create new
Routing Topic Data . |
static ServiceTopicData |
TopicDataFactory.newServiceData(String serviceType,
ServiceHandler serviceHandler)
Deprecated.
since 5.7
Messaging is a better alternative to service topics for sending point-to-point requests. |
static SingleValueTopicData |
TopicDataFactory.newSingleValueCustomData(CustomFieldHandler handler)
Create new
Single Value Topic Data of type
MDataType.CUSTOM_STRING . |
static SingleValueTopicData |
TopicDataFactory.newSingleValueData(MDataType type)
Create new
Single Value Topic Data . |
static SingleValueTopicData |
TopicDataFactory.newSingleValueData(MField metadata)
Create new
Single Value Topic Data . |
static SingleValueTopicData |
TopicDataFactory.newSingleValueDecimalData(int scale)
Create new
Single Value Topic Data of type
MDataType.DECIMAL_STRING with a scale other than the default. |
static SlaveTopicData |
TopicDataFactory.newSlaveData(PublishingTopicData master)
Deprecated.
since 5.7.
This method does not cater for attaching
|
static SlaveTopicData |
TopicDataFactory.newSlaveData(String masterTopicName)
Create a new
SlaveTopicData . |
static TopicData |
TopicDataFactory.newTopicData(TopicDefinition definition)
Create new
TopicData from a TopicDefinition . |
static <V> UniversalTopicData<V> |
TopicDataFactory.newUniversalData(Class<V> valueType)
Create new
UniversalTopicData . |
static <V> UniversalTopicData<V> |
TopicDataFactory.newUniversalData(Class<V> valueType,
Map<String,String> properties)
Create new
UniversalTopicData . |
void |
PublishingTopicData.publishExclusiveMessage(TopicMessage message,
TopicClient client)
As
PublishingTopicData.publishMessage(TopicMessage) but excluding a specified
client. |
void |
PublishingTopicData.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority)
As
PublishingTopicData.publishExclusiveMessage(TopicMessage, TopicClient) but
allowing a message priority to be specified. |
void |
PublishingTopicData.publishMessage(TopicMessage message)
Publish a message (at
normal priority) to
all subscribed clients. |
void |
PublishingTopicData.publishMessage(TopicMessage message,
MessagePriority priority)
As
PublishingTopicData.publishMessage(TopicMessage) but allowing a message priority
to be specified. |
void |
PublishingTopicData.setDeltaAckRequired(boolean ackRequired)
This may be used to indicate that when a
delta message is generated it should have
ackRequired set. |
void |
PublishingTopicData.setLoadAckRequired(boolean ackRequired)
This may be used to indicate that when a
load message is generated it should
have ackRequired set (see
PublishingTopicData.getLoadMessage() ). |
void |
PublishingTopicData.setLoadHeaders(String... headers)
This may be used to set user headers to be applied to a
load message when it is generated (see
PublishingTopicData.getLoadMessage() ). |
void |
TopicDataWithMetadata.setMetadataNode(MNode metadata)
Sets Optional Metadata on the TopicData.
|
void |
PublishingTopicData.startUpdate()
Locks the parent topic in preparation for updates.
|
boolean |
PublishingTopicData.update(TopicMessage message)
Updates the data with the data from a supplied message.
|
void |
UniversalTopicData.update(V value)
Updates the topic to the specified value.
|
boolean |
PublishingTopicData.updateAndPublish(TopicMessage message)
Convenience method to perform an atomic update and publish a delta
message if any changes are detected.
|
boolean |
PublishingTopicData.updateAndPublish(TopicMessage message,
MessagePriority priority)
As
PublishingTopicData.updateAndPublish(TopicMessage) but allowing a message
priority to be specified. |
void |
PublishingTopicData.updateAndPublishFromDelta(TopicMessage message)
This method allows the topic data to be updated using input that
represents only deltas of change to the topic.
|
Modifier and Type | Method and Description |
---|---|
void |
SimpleCustomTopicDataHandler.abortUpdate()
Deprecated.
|
void |
CustomTopicDataHandler.abortUpdate()
Deprecated.
This is called when
PublishingTopicData.abortUpdate() is called. |
boolean |
SimpleCustomTopicDataHandler.endUpdate()
Deprecated.
|
boolean |
CustomTopicDataHandler.endUpdate()
Deprecated.
This is called when
PublishingTopicData.endUpdate() is called. |
void |
CustomTopicDataHandler.initialise(TopicMessage message)
Deprecated.
This is called if
PublishingTopicData.initialise(TopicMessage) is
used. |
void |
AbstractCustomTopicDataHandler.initialise(TopicMessage message)
Deprecated.
|
void |
CustomTopicDataHandler.populateDelta(TopicMessage delta)
Deprecated.
This is called when
PublishingTopicData.generateDeltaMessage(String...) is called to
populate a new delta message with updates done in the current block. |
void |
CustomTopicDataHandler.populateTopicLoad(TopicMessage topicLoad)
Deprecated.
This will be called to populate an empty Topic Load message with the
current state of the data.
|
void |
CustomTopicDataHandler.prepare()
Deprecated.
This is called when the topic data that specifies the handler is attached
to a topic.
|
void |
AbstractCustomTopicDataHandler.prepare()
Deprecated.
|
void |
SimpleCustomTopicDataHandler.startUpdate()
Deprecated.
|
void |
CustomTopicDataHandler.startUpdate()
Deprecated.
This is called when
PublishingTopicData.startUpdate() is called. |
boolean |
CustomTopicDataHandler.update(TopicMessage message)
Deprecated.
This will be called to update the state of the data from an incoming
delta Message.
|
boolean |
AbstractCustomTopicDataHandler.update(TopicMessage message)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
MField |
MRecord.addCustomField(String name,
Multiplicity multiplicity,
CustomFieldHandler handler)
Adds a new child field with custom data type.
|
MField |
MRecord.addCustomField(String name,
Multiplicity multiplicity,
String handler)
Adds a new child field with custom data type.
|
MField |
MRecord.addField(String name)
Adds a new child field with default multiplicity and data type.
|
MField |
MRecord.addField(String name,
MDataType dataType)
Adds a new child field with default multiplicity.
|
MField |
MRecord.addField(String name,
MDataType dataType,
Multiplicity multiplicity)
Adds a new child field.
|
MField |
MRecord.addField(String name,
Multiplicity multiplicity)
Adds a new child field with default data type.
|
MField |
MRecord.addField(String name,
Multiplicity multiplicity,
CustomFieldHandler handler)
Deprecated.
|
MRecord |
MRecord.addRecord(String name)
Adds a new child record with default multiplicity.
|
MRecord |
MRecord.addRecord(String name,
Multiplicity multiplicity)
Adds a new child record.
|
static MNode |
MetadataFactory.decodeFromXML(String xml)
Parse metadata from XML.
|
static String |
MetadataFactory.encodeAsXML(MNode metadata)
Encode metadata as XML.
|
static String |
MetadataFactory.encodeAsXML(MNode metadata,
boolean format)
Encode metadata as XML.
|
MNode |
MRecord.getChild(int index)
Gets the child at a given index.
|
static MField |
MetadataFactory.newCustomFieldMetadata(CustomFieldHandler handler)
Create a single custom metadata field with an automatically generated
unique name.
|
static MField |
MetadataFactory.newCustomFieldMetadata(String handler)
Create a single custom metadata field with an automatically generated
unique name.
|
static MField |
MetadataFactory.newCustomFieldMetadata(String name,
CustomFieldHandler handler)
Create a single custom metadata field.
|
static MField |
MetadataFactory.newCustomFieldMetadata(String name,
String handler)
Create a single custom metadata field.
|
static MField |
MetadataFactory.newFieldMetadata(MDataType dataType)
This is a convenience method for constructing a single metadata field
with an automatically generated unique name.
|
static MField |
MetadataFactory.newFieldMetadata(String name,
MDataType dataType)
This is a convenience method for constructing a single metadata field.
|
static MMessage |
MetadataFactory.newMessageMetadata(String name)
Create a new empty message metadata node of type
Record for metadata modeling. |
static MMessage |
MetadataFactory.newMetadata(String name,
TopicDataType topicDataType)
Deprecated.
|
static MRecord |
MetadataFactory.newRecordMetadata(String name)
This is a convenience method for creating Record metadata.
|
Object |
CustomFieldHandler.parse(Object object)
Parses any object that can be parsed into the internal representation of
this field's data type.
|
static Multiplicity |
Multiplicity.parse(String value)
Parse an object from a string using the
Multiplicity.toString() syntax, e.g. |
void |
MField.setDefaultValue(Object value)
Sets a default value that required occurrences of the field are to be
initialised to.
|
Constructor and Description |
---|
Multiplicity(int number)
Creates a fixed multiplicity (where there are a fixed number of
occurrences).
|
Multiplicity(int minimum,
int maximum)
Creates a range multiplicity.
|
Modifier and Type | Method and Description |
---|---|
void |
PagedRecordTopicData.add(int index,
List<Record> lines)
Deprecated.
Add (insert) one or more lines to the data at the specified index.
|
void |
PagedStringTopicData.add(int index,
List<String> lines)
Deprecated.
Add (insert) one or more lines to the data at the specified index.
|
void |
PagedRecordTopicData.add(int index,
Record line)
Deprecated.
Add (insert) a line to the data at the specified index.
|
void |
PagedStringTopicData.add(int index,
String line)
Deprecated.
Add (insert) a line to the data at the specified index.
|
void |
PagedRecordTopicData.add(List<Record> lines)
Deprecated.
Add one or more lines to the data.
|
void |
PagedStringTopicData.add(List<String> lines)
Deprecated.
Add one or more lines to the end of the data.
|
int |
PagedRecordTopicData.add(Record line)
Deprecated.
Add a line to the data.
|
int |
PagedStringTopicData.add(String line)
Deprecated.
Add a line to the data.
|
void |
PagedStringTopicData.add(TopicMessage message)
Deprecated.
Add data from a message.
|
void |
PagedRecordTopicData.add(TopicMessage message)
Deprecated.
Adds data from a message.
|
Record |
PagedRecordTopicData.get(Record line)
Deprecated.
Get the value of the line that matches the specified Record.
|
String |
PagedStringTopicData.get(String line)
Deprecated.
Get the value of the line that matches the specified string.
|
List<Record> |
PagedRecordTopicData.getLines(Record line)
Deprecated.
Returns the current values of all lines that match a specified line.
|
List<String> |
PagedStringTopicData.getLines(String line)
Deprecated.
Returns the current values of all lines that match a specified line.
|
Record |
PagedRecordTopicData.remove(Record record)
Deprecated.
Removed the line that matches the supplied record from the data.
|
String |
PagedStringTopicData.remove(String line)
Deprecated.
Removed the line that matches the supplied string from the data.
|
void |
PagedTopicData.setDuplicatesPolicy(PagedTopicData.Duplicates policy)
Deprecated.
Set the duplicates policy for
ordered data. |
boolean |
PagedRecordTopicData.update(int index,
Record line)
Deprecated.
Update the line at the specified index with a given value.
|
boolean |
PagedStringTopicData.update(int index,
String value)
Deprecated.
Update the line at the specified index with a given value.
|
boolean |
PagedRecordTopicData.update(Record line)
Deprecated.
Update the line that matches the specified Record with the specified
line.
|
boolean |
PagedStringTopicData.update(String line)
Deprecated.
Update the line that matches the specified String with the specified
line.
|
Modifier and Type | Method and Description |
---|---|
com.google.protobuf.DynamicMessage |
PBTopicData.getState()
Deprecated.
Gets the current state of the data as a DynamicMessage.
|
void |
PBTopicData.initialise(com.google.protobuf.AbstractMessage initialMessage)
Deprecated.
Initialises the data with values from an input Protocol Buffers Message.
|
void |
PBTopicData.setDeletionValue(String value)
Deprecated.
Allows a deletion value to be specified for use with 'string' type
optional fields.
|
void |
PBTopicData.setUpdateMode(PBTopicData.UpdateMode mode)
Deprecated.
Set the update mode.
|
boolean |
PBTopicData.update(com.google.protobuf.AbstractMessage message)
Deprecated.
Updates the data using a Protocol Buffers Message.
|
boolean |
PBTopicData.updateAndPublish(com.google.protobuf.AbstractMessage message)
Deprecated.
As
PublishingTopicData.updateAndPublish(com.pushtechnology.diffusion.api.message.TopicMessage)
but calling PBTopicData.update(AbstractMessage) to perform the updating. |
Modifier and Type | Method and Description |
---|---|
List<Record> |
RecordTopicData.getState()
Gets the current state of the data as a List of Records.
|
Record |
RecordTopicData.getStateRecord(String recordName,
int index)
Gets the current state of a particular Record occurrence within the data.
|
void |
RecordTopicData.initialise(Collection<Record> records)
Initialises one or more Record occurrences within the data.
|
void |
RecordTopicData.initialise(Record... records)
Initialises one or more Record occurrences within the data.
|
void |
RecordTopicData.initialise(Record record,
int index)
Initialises an occurrence of a Record within the data from a Record with
matching metadata.
|
void |
RecordTopicData.setEmptyFieldValue(String emptyValue)
Sets the value to be used to represent empty fields in messages generated
by the TopicData.
|
boolean |
RecordTopicData.update(Collection<Record> records)
Update data from records.
|
boolean |
RecordTopicData.update(Record... records)
Update data from records.
|
boolean |
RecordTopicData.update(Record record,
int index)
Updates data from a Record.
|
boolean |
RecordTopicData.update(String recordName,
int recordIndex,
String fieldName,
Object... values)
Updates a specific field within a specified record within the data.
|
Modifier and Type | Method and Description |
---|---|
List<TopicClient> |
RoutingTopicData.getClientsForTopic(Topic topic)
Get the list of Clients that are mapped to a particular Topic.
|
List<Topic> |
RoutingTopicData.getMappedTopics()
Get the list of Topics that this Routing data maps to.
|
void |
RoutingTopicData.subscribe(TopicClient client,
Topic topic)
This may be used to subscribe a client to a Topic other than the parent
Topic, bypassing any authorisation checks.
|
Modifier and Type | Class and Description |
---|---|
class |
ServiceException
Deprecated.
since 5.7
Messaging is a better alternative to service topics for sending point-to-point requests. |
Modifier and Type | Method and Description |
---|---|
TopicMessage |
ServiceTopicData.createDeltaMessage(String... headers)
Deprecated.
Convenience method to create a delta message for the parent topic which
has the
default capacity from the owning Topic and the
delta encoding pre-applied. |
TopicMessage |
ServiceRequest.createResponseMessage(String... headers)
Deprecated.
Convenience method to create a message that can be returned in a
ServiceResponse . |
boolean |
ServiceTopicData.serviceResponse(ServiceResponse response)
Deprecated.
This may be used to asynchronously return a response to a request issued
to a
ServiceHandler . |
void |
ServiceTopicData.setTargetTopicName(String topicName)
Deprecated.
Sets the target topic name.
|
Constructor and Description |
---|
ServiceResponse(ServiceRequest request,
String responseType,
TopicMessage responseMessage)
Deprecated.
Creates a response for specified request and for a specified response
type.
|
ServiceResponse(String clientId,
String requestId,
String responseType,
TopicMessage responseMessage)
Deprecated.
Creates a response for a request identified by client identifier and
request number and for a specified response type.
|
Modifier and Type | Method and Description |
---|---|
void |
SingleValueTopicData.initialise(Object value)
Initialises the data to a specified value.
|
boolean |
SingleValueTopicData.update(Object value)
Updates the data from a object.
|
boolean |
SingleValueTopicData.updateAndPublish(Object value)
As
PublishingTopicData.updateAndPublish(com.pushtechnology.diffusion.api.message.TopicMessage)
but calling SingleValueTopicData.update(Object) to perform the updating. |
Modifier and Type | Method and Description |
---|---|
static void |
Management.register(Manageable manageable)
Deprecated.
Register a
Manageable object in the JMX management service. |
static void |
Management.unregister(Manageable manageable)
Deprecated.
Unregister a
Manageable object. |
Modifier and Type | Class and Description |
---|---|
class |
MessageException
An exception returned by the Diffusion Message API.
|
Modifier and Type | Method and Description |
---|---|
static void |
Publishers.addEventListener(ServerEventListener listener)
Add a single threaded event listener to receive all event notifications.
|
static void |
Publishers.addEventListener(ServerEventListener listener,
int notificationMask)
Add a single threaded event listener to receive selected event
notifications.
|
static void |
Publishers.addEventListener(ServerEventListener listener,
ThreadPool threadPool,
int notificationMask)
Add an event listener.
|
PublisherServerConnection |
Publisher.addServerConnection(String name,
ServerDetails serverDetails)
Deprecated.
since 5.9 - See
PublisherServerConnection |
PublisherServerConnection |
Publisher.addServerConnection(String name,
String host,
int port)
Deprecated.
since 5.9 - See
PublisherServerConnection |
Topic |
Publisher.addTopic(String topicName,
TopicData data) |
Topic |
Publisher.addTopic(String topicName,
TopicDefinition definition) |
Topic |
Publisher.addTopic(String topicName,
TopicTreeNode parent,
TopicData data) |
Topic |
Publisher.addTopic(String topicName,
TopicTreeNode parent,
TopicDefinition definition) |
void |
Publisher.addTopicListener(TopicListener topicListener,
MessageSourceType sourceType,
String... topics)
Adds a
TopicListener . |
void |
Publisher.addTopicListener(TopicListener topicListener,
MessageSourceType sourceType,
TopicSet topics)
Adds a
TopicListener . |
ClientGroup |
Publisher.createClientGroup(String groupName) |
static Publisher |
Publishers.createPublisher(String name)
Convenience method to create a default Publisher and register it with
Diffusion
Equivalent of creating a PublisherConfig instance with
ServerConfig.addPublisher(String, String) and passing to
Publishers.loadPublisher(PublisherConfig) . |
static Publisher |
Publishers.createPublisher(String name,
Class<? extends Publisher> instanceClass)
Convenience method to create a Publisher from a given Class and register
it with Diffusion
Equivalent of creating a PublisherConfig instance with
ServerConfig.addPublisher(String, String) and passing to
Publishers.loadPublisher(PublisherConfig) . |
static Publisher |
Publishers.createPublisher(String name,
String classname)
Convenience method to create a Publisher from a given classname and
register it with Diffusion
Equivalent of creating a PublisherConfig instance with
ServerConfig.addPublisher(String, String) and passing to
Publishers.loadPublisher(PublisherConfig) . |
List<Topic> |
Client.fetch(TopicSet topicSet,
List<String> headers)
Causes a forced fetch of one or more Topics for the Client.
|
protected TopicMessage |
Publisher.fetchForClient(Client client,
Topic topic,
List<String> headers)
Deprecated.
since 5.6. Currently a classic client can issue a fetch
request to a stateless topic. This method enables a publisher
to return a reply. At future releases this capability will be
removed.
|
String |
XMLProperties.getSchema()
Deprecated.
Returns the properties schema.
|
protected void |
Publisher.initialLoad()
This is called when the publisher is started to perform initial publisher
load actions as required.
|
static Publisher |
Publishers.loadPublisher(PublisherConfig config)
Loads a Publisher from a given
PublisherConfig . |
protected void |
Publisher.publisherRemoved()
Called when the publisher is finally removed from the system.
|
protected void |
Publisher.publisherStarted()
This is called to notify that the Publisher has been started.
|
protected void |
Publisher.publisherStopped()
Called when when publisher is stopped.
|
protected void |
Publisher.publisherStopping()
Called when when publisher stop request has been received but its topics
have not yet been removed.
|
void |
Publisher.publishExclusiveMessage(TopicMessage message,
TopicClient client) |
void |
Publisher.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority) |
void |
Publisher.publishMessage(TopicMessage message) |
void |
Publisher.publishMessage(TopicMessage message,
MessagePriority priority) |
boolean |
Client.send(TopicMessage message,
MessagePriority priority)
Send a message to the client, specifying delivery priority.
|
boolean |
Client.sendFetchReply(TopicMessage message,
MessagePriority priority,
List<String> headers)
Deprecated.
since 5.6. Currently a classic client can issue a fetch request
to a stateless topic, or even a topic that does not exist.
This method enables a publisher to return a reply. At future
releases this capability will be removed.
|
void |
PublisherServerConnection.setOutboundMessageQueueDefinition(String definitionName)
Deprecated.
Sets the name of the outbound queue definition to use when creating an an
outbound message queue on connection.
|
void |
PublisherServerConnection.setRetryInterval(long interval)
Deprecated.
Sets the retry interval.
|
void |
Publisher.startPublisher()
Starts the publisher.
|
void |
Publisher.stopPublisher()
Stops the publisher.
|
protected void |
Publisher.subscription(Client client,
Topic topic,
boolean loaded)
This method is called when a client subscribes to a topic.
|
Modifier and Type | Method and Description |
---|---|
void |
DiffusionServer.start()
Starts the server.
|
void |
EmbeddedDiffusion.start()
Starts the server.
|
Modifier and Type | Method and Description |
---|---|
static ThreadPool |
ThreadService.createThreadPool(String name,
int coreSize,
int maxSize,
int queueSize,
int priority)
Creates a new thread pool.
|
void |
ThreadPool.execute(RunnableTask runnable)
Give a
RunnableTask to the pool to be executed. |
static ThreadPool |
ThreadService.getBackgroundThreadPool()
Returns the background thread pool.
|
static ThreadPool |
ThreadService.getInboundThreadPool()
Deprecated.
Since 5.8. The thread pool returned by this method is no
longer used by Diffusion. This method is retained for API
compatibility and will be removed in a future release.
|
void |
ThreadService.CallerRunsRejectionPolicy.rejectedExecution(RunnableTask runnable,
ThreadPool threadPool) |
void |
ThreadService.AbortRejectionPolicy.rejectedExecution(RunnableTask runnable,
ThreadPool threadPool) |
void |
ThreadPoolRejectionHandler.rejectedExecution(RunnableTask runnable,
ThreadPool threadPool)
Called when a task can not be executed by a
ThreadPool . |
static ScheduledFuture<?> |
ThreadService.schedule(RunnableTask runnable,
long initialDelay,
long period,
TimeUnit unit,
boolean isConstantRate)
Schedules a task for periodic execution.
|
static ScheduledFuture<?> |
ThreadService.schedule(RunnableTask runnable,
long delay,
TimeUnit unit)
Schedule a task for execution after a given period of time.
|
static Schedule |
ThreadService.schedule(ScheduledTask task)
Schedules a
ScheduledTask to run according to a frequency
schedule defined by the task itself. |
static Schedule |
ThreadService.schedule(String name,
String frequency,
RunnableTask task)
Schedules a task to be run according to a schedule specified by a 'cron'
like frequency pattern.
|
void |
ThreadPool.setNotificationHandler(ThreadPoolNotificationHandler handler,
int lowerThreshold,
int upperThreshold)
Sets a notification
handler for the
pool. |
Modifier and Type | Class and Description |
---|---|
class |
TopicInvalidException
Indicates an invalid topic name or
TopicSelector string. |
Modifier and Type | Method and Description |
---|---|
boolean |
TopicClient.acknowledge(TopicMessage message)
Acknowledges a Message that is
'Pending Acknowledgement' . |
Topic |
TopicProvider.addTopic(String topicName,
TopicData data)
Add a Topic to the root of the Topic tree.
|
Topic |
Topic.addTopic(String topicName,
TopicData data)
Add a Topic to this Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicDefinition definition)
Add a Topic to the root of the Topic tree.
|
Topic |
Topic.addTopic(String topicName,
TopicDefinition definition)
Add a Topic to this Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicTreeNode parent,
TopicData data)
Adds a Topic to a specified parent Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicTreeNode parent,
TopicDefinition definition)
Adds a Topic to a specified parent Topic.
|
ClientGroup |
TopicProvider.createClientGroup(String groupName)
Create a new client group.
|
Byte |
TopicDefinition.getByteProperty(TopicProperty property)
Returns the value of a Byte property
|
Integer |
TopicDefinition.getIntegerProperty(TopicProperty property)
Returns the value of an Integer property
|
Long |
TopicDefinition.getLongProperty(TopicProperty property)
Returns the value of a Long property
|
TopicMessage |
CachedTopicLoader.getTopicStateMessage(Topic topic)
Get the current state of the Topic
|
boolean |
TopicListener.handleTopicMessage(MessageSource source,
TopicMessage message)
Handles a Message received from a
MessageSource . |
boolean |
TopicLoader.load(TopicClient client,
Topic topic)
This is used to perform the Topic Load processing for a Client when
requested.
|
boolean |
SimpleTopicLoader.load(TopicClient client,
Topic topic)
Simple Implementation of
TopicLoader.load(TopicClient, Topic) |
boolean |
CachedTopicLoader.load(TopicClient client,
Topic topic)
Cached Topic load implementation.
|
protected abstract void |
SimpleTopicLoader.populateMessage(TopicMessage message)
This populates a new empty Topic Load message with the topic load data.
|
void |
Topic.publishDeltaMessage(Record... records)
This is a convenience method to create a delta message for the topic
populated with the specified records and then publish it.
|
void |
Topic.publishDeltaMessage(String... fields)
This is a convenience method to create a delta message for the topic
populated with the specified fields and then publish it.
|
void |
TopicProvider.publishExclusiveMessage(TopicMessage message,
TopicClient client)
Deprecated.
since 5.6. See
TopicProvider.publishMessage(TopicMessage) for
details. |
void |
Topic.publishExclusiveMessage(TopicMessage message,
TopicClient client)
A variant of
Topic.publishMessage(TopicMessage) that publishes a
message to all but one client. |
void |
TopicProvider.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority)
Deprecated.
since 5.6. See
TopicProvider.publishMessage(TopicMessage) for
details. |
void |
Topic.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority)
A variant of
Topic.publishMessage(TopicMessage) that publishes a
message to all but one client and allows the message priority to be
specified. |
void |
TopicProvider.publishMessage(TopicMessage message)
Deprecated.
since 5.6.
The methods that publish messages to topics have been deprecated and will be removed in a future release. Use one of the following options instead.
|
void |
Topic.publishMessage(TopicMessage message)
Publish a message to all clients that are subscribed to the topic of the
message.
|
void |
TopicProvider.publishMessage(TopicMessage message,
MessagePriority priority)
Deprecated.
since 5.6. See
TopicProvider.publishMessage(TopicMessage) for
details. |
void |
Topic.publishMessage(TopicMessage message,
MessagePriority priority)
A variant of
Topic.publishMessage(TopicMessage) that allows the
message priority to be specified. |
boolean |
TopicClient.send(TopicMessage message)
Send a message to the client.
|
void |
ClientGroup.send(TopicMessage message)
Send a message to all clients in the group.
|
void |
ClientGroup.send(TopicMessage message,
MessagePriority priority)
Send a message to all clients in the group, specifying a delivery
priority.
|
void |
ClientGroup.sendExclusive(TopicMessage message,
TopicClient excludeClient)
Send an exclusive message, i.e.
|
void |
ClientGroup.sendExclusive(TopicMessage message,
TopicClient excludeClient,
MessagePriority priority)
Send an exclusive message, i.e.
|
boolean |
TopicClient.sendFetchReply(TopicMessage message,
List<String> headers)
Deprecated.
since 5.6. Currently a classic client can issue a fetch
request to a stateless topic, or even a topic that does not
exist. This method enables a publisher to return a reply. At
future releases this capability will be removed.
|
void |
Topic.setDefaultDeltaMessageCapacity(int capacity)
Sets the default capacity for delta Messages in bytes created using the
Topic.createDeltaMessage() method. |
void |
Topic.setDefaultLoadMessageCapacity(int capacity)
Sets the default capacity for load Messages in bytes created using the
Topic.createLoadMessage() method. |
void |
Topic.setLockTimeout(long timeout)
Deprecated.
since 5.6. All API topic locking methods are deprecated and
will be removed in a future release, see
Topic.lock() for
details. |
void |
Topic.subscribe(TopicClient client)
Subscribe a client to this topic.
|
Modifier and Type | Method and Description |
---|---|
void |
HTTPRequest.writeResponse(ByteBuffer buffer)
Write a response.
|
Modifier and Type | Method and Description |
---|---|
void |
WhoIsProvider.whoIs(String address,
WhoIsDetails details)
Resolves a supplied IP address.
|
void |
WhoIsDefaultProvider.whoIs(String address,
WhoIsDetails details)
Performs a WhoIs lookup.
|
Copyright © 2016 Push Technology Ltd. All Rights Reserved.