Uses of Interface
com.attivio.sdk.esb.PlatformMessage

Packages that use PlatformMessage

Package	Description
com.attivio.client	Contains the Client Attivio API for adding content, submitting queries, and sending general purpose messages to an Attivio server.
com.attivio.client.streaming	Contains client code for streaming search results.
com.attivio.platform.service
com.attivio.sdk.admin	Contains classes that represent administrative messages that flow between components and Attivio Servers.
com.attivio.sdk.connector
com.attivio.sdk.esb
com.attivio.sdk.ingest
com.attivio.sdk.scanner
com.attivio.sdk.search
com.attivio.sdk.security
com.attivio.sdk.server.component	Interfaces necessary to write components for the AIE system.
com.attivio.sdk.server.component.ingest	Interfaces for all ingest related transformers and associated dependencies of those transformers.
com.attivio.sdk.service
com.attivio.sdk.test
com.attivio.sdk.transport
com.attivio.service
com.attivio.sysstate
com.attivio.transport
com.attivio.util	Contains utility classes and methods used across the Attivio code base.
com.attivio.util.ft
com.attivio.util.serialization	Contains classes related to serialization/desearialization of objects to/from XML.

Uses of PlatformMessage in com.attivio.client

Methods in com.attivio.client that return PlatformMessage

Modifier and Type	Method	Description
protected PlatformMessage	AbstractReceiverClient.handleServerReset(PlatformMessage msg, AttivioException ae)	Called when the client has detected a server reset.
PlatformMessage	AbstractReceiverClient.ClientMessageSender.send(PlatformMessage msg, java.lang.String uri, boolean allowNullResponse)
protected PlatformMessage	AbstractReceiverClient.sendMessage(PlatformMessage msg)	Sends a synchronous message to Attivio via the configured node AbstractReceiverClient.getReceiverUri().
protected PlatformMessage	AbstractReceiverClient.sendMessage(PlatformMessage msg, boolean allowNullResponse)	Sends a synchronous message to Attivio via the configured node AbstractReceiverClient.getReceiverUri().
PlatformMessage	MessageForwardingClient.sendMessage(java.lang.String componentName, PlatformMessage msg)	Sends a message to a component name synchronously.

Methods in com.attivio.client with parameters of type PlatformMessage

Modifier and Type	Method	Description
int	ContentFeeder.determineMessageSize(PlatformMessage msg)
void	AbstractReceiverClient.ClientMessageSender.dispatch(PlatformMessage msg, java.lang.String uri)
abstract java.lang.String	AbstractSearchClient.endpoint(PlatformMessage pm)	Determine the destination endpoint (local or remote) based on the message
void	IngestMessageListener.handleSend(PlatformMessage message)
void	IngestMessageListener.handleSendFailure(PlatformMessage message, AttivioException ae)
protected PlatformMessage	AbstractReceiverClient.handleServerReset(PlatformMessage msg, AttivioException ae)	Called when the client has detected a server reset.
MessageList	MessageForwardingClient.prepareMessageForTransmission(java.lang.String componentName, PlatformMessage msg, boolean synchronous)	Prepares the message to be sent to the MessageService.
void	AbstractReceiverClient.ClientMessageSender.prepareMessageWorkflows(WorkflowQueue clientWorkflow, PlatformMessage msg)
PlatformMessage	AbstractReceiverClient.ClientMessageSender.send(PlatformMessage msg, java.lang.String uri, boolean allowNullResponse)
protected void	AbstractReceiverClient.sendAsyncMessage(PlatformMessage msg)	Sends an asynchronous message to Attivio via the configured node AbstractReceiverClient.getReceiverUri().
void	MessageForwardingClient.sendAsyncMessage(java.lang.String componentName, PlatformMessage msg)	Sends a message to a component name asynchronously.
protected PlatformMessage	AbstractReceiverClient.sendMessage(PlatformMessage msg)	Sends a synchronous message to Attivio via the configured node AbstractReceiverClient.getReceiverUri().
protected PlatformMessage	AbstractReceiverClient.sendMessage(PlatformMessage msg, boolean allowNullResponse)	Sends a synchronous message to Attivio via the configured node AbstractReceiverClient.getReceiverUri().
PlatformMessage	MessageForwardingClient.sendMessage(java.lang.String componentName, PlatformMessage msg)	Sends a message to a component name synchronously.
protected void	ContentFeeder.sendMessageInternal(PlatformMessage message)	Internal method to send a message to the IngestApi.

Uses of PlatformMessage in com.attivio.client.streaming

Classes in com.attivio.client.streaming that implement PlatformMessage

Modifier and Type	Class	Description
class	StreamResponse

Methods in com.attivio.client.streaming with parameters of type PlatformMessage

Modifier and Type	Method	Description
static boolean	StreamRequestInfo.messageContainsStreamRequest(PlatformMessage msg)
void	StreamRequestInfo.serializeIntoMessage(PlatformMessage msg)

Constructors in com.attivio.client.streaming with parameters of type PlatformMessage

Constructor	Description
StreamRequestInfo(PlatformMessage msg)

Uses of PlatformMessage in com.attivio.platform.service

Methods in com.attivio.platform.service with parameters of type PlatformMessage

Modifier and Type	Method	Description
java.lang.String	LocalSearchClientImpl.endpoint(PlatformMessage pm)	Determine the destination endpoint (local or remote) based on the message
java.lang.String	RemoteSearchClient.endpoint(PlatformMessage pm)	Determine the destination endpoint (local or remote) based on the message

Uses of PlatformMessage in com.attivio.sdk.admin

Classes in com.attivio.sdk.admin that implement PlatformMessage

Modifier and Type	Class	Description
class	AdminMessage	Base class for all messages intended for the admin service
class	Ping	A message sent to an AdminService to see if it is listening for messages.
class	PingResponse	A message sent in response to a Ping message.
class	Shutdown	Sent to tell the AdminService to shutdown this instance of Attivio.
class	ShutdownImmediately	Sent to tell the AdminService to shutdown this instance of Attivio quickly without waiting for in-flight documents to pass through the system.

Uses of PlatformMessage in com.attivio.sdk.connector

Methods in com.attivio.sdk.connector that return types with arguments of type PlatformMessage

Modifier and Type	Method	Description
java.util.List<PlatformMessage>	MockPublisher.getSentMessages()

Uses of PlatformMessage in com.attivio.sdk.esb

Subinterfaces of PlatformMessage in com.attivio.sdk.esb

Modifier and Type	Interface	Description
interface	GroupedMessage	Grouped messages are processed in order relative to each other and are guaranteed to all fall on the same side of a commit/optimize/backup boundary.
interface	PersistsThroughCycles	Interface used for tagging that a particular message will persist through a cycle.

Classes in com.attivio.sdk.esb that implement PlatformMessage

Modifier and Type	Class	Description
class	AbstractListMessage<T>	Abstract container for list based messages.
class	AbstractPlatformMessage	Base class that handles many of the implementation-level details of an PlatformMessage.
class	CgiRequest	Message that represents a request via CGI on a HTTP receiver.
class	ExceptionResponse	Response containing an Exception.
class	MessageList	Represents a list of other PlatformMessages.
class	ProcessingResultMessage	Class used for transmitting ProcessingResults across JVM boundaries.
class	PropertiesMessage	Properties messages contain a set of properties to be delivered to a component.
class	StringMessage	A simple PlatformMessage that holds a string.

Fields in com.attivio.sdk.esb declared as PlatformMessage

Modifier and Type	Field	Description
PlatformMessage	ProcessingResult.MsgData.createdPm

Methods in com.attivio.sdk.esb with type parameters of type PlatformMessage

Modifier and Type	Method	Description
<T extends PlatformMessage> T	MessageList.getMessage(java.lang.Class<T> clazz)	Gets the first instance of a message of the specified type, walking into inner MessageLists if present
<T extends PlatformMessage> java.util.Iterator<T>	MessageList.iterator(java.lang.Class<T> messageClass)	Return an iterator that will recursively iterate over all sub messages of this MessageList.

Methods in com.attivio.sdk.esb that return PlatformMessage

Modifier and Type	Method	Description
protected PlatformMessage	MessageList.clone(PlatformMessage tmp)
PlatformMessage	PlatformMessage.clone()	Clones a message.

Methods in com.attivio.sdk.esb with parameters of type PlatformMessage

Modifier and Type	Method	Description
boolean	MessageList.add(PlatformMessage message)
protected PlatformMessage	MessageList.clone(PlatformMessage tmp)
void	ProcessingResult.completed(PlatformMessage pm)
void	ProcessingResult.created(PlatformMessage pm)	Deprecated.
void	ProcessingResult.drop(PlatformMessage pm)
void	ProcessingResult.drop(PlatformMessage pm, ErrorCode errorCode, java.lang.String msg)
void	ProcessingResult.drop(PlatformMessage pm, ErrorCode errorCode, java.lang.Throwable t)
void	ProcessingResult.drop(PlatformMessage pm, ErrorCode errorCode, java.lang.Throwable t, java.lang.String msg)
void	ProcessingResult.fail(PlatformMessage pm, AttivioException ex)
void	ProcessingResult.fail(PlatformMessage pm, ErrorCode errorCode, java.lang.String msg)
void	ProcessingResult.fail(PlatformMessage pm, ErrorCode errorCode, java.lang.Throwable t, java.lang.String msg)
void	ProcessingResult.fail(PlatformMessage pm, java.lang.Throwable t)
java.lang.String	MessageDomainManager.getMessageDomain(PlatformMessage msg)	Domains are always non-blank
void	ProcessingResult.notHandled(PlatformMessage pm)
void	ProcessingResult.notHandled(PlatformMessage pm, ErrorCode errorCode, java.lang.Throwable t)
void	MessageDomainManager.setMessageDomain(PlatformMessage msg, java.lang.String domain)	Sets the domain for the message.
java.lang.String	MessageDomainManager.transformForDomain(PlatformMessage msg, java.lang.String uri)	Transforms uri so that it points to the domain-specific uri for the domain the message is in.
void	ProcessingResult.warn(PlatformMessage pm, ErrorCode errorCode, java.lang.Throwable t, java.lang.String msg)

Method parameters in com.attivio.sdk.esb with type arguments of type PlatformMessage

Modifier and Type	Method	Description
boolean	MessageList.containsMessage(java.lang.Class<? extends PlatformMessage> clazz)	Checks to see if this list contains a message of the specified class type.

Constructors in com.attivio.sdk.esb with parameters of type PlatformMessage

Constructor	Description
MessageList(java.util.UUID clientId, PlatformMessage... msgs)	Constructor with a client ID and a list of messages.

Uses of PlatformMessage in com.attivio.sdk.ingest

Subinterfaces of PlatformMessage in com.attivio.sdk.ingest

Modifier and Type	Interface	Description
interface	IndexMessage	Defines the interface for messages which flow through the indexing workflow.

Classes in com.attivio.sdk.ingest that implement PlatformMessage

Modifier and Type	Class	Description
class	AbstractIndexMessage	Base class for IndexMessages which are not DocumentList.
class	Backup	Message used to initiate an index backup.
class	BulkUpdate	Message that applies a "template" document to multiple document ids.
class	Commit	Signifies that the index or other underlying data store should commit currently held documents to disk.
class	DocumentList	The basic container for a collection of IngestDocuments.
class	Optimize	Represents an 'optimize' index message.

Uses of PlatformMessage in com.attivio.sdk.scanner

Methods in com.attivio.sdk.scanner that return types with arguments of type PlatformMessage

Modifier and Type	Method	Description
java.util.List<PlatformMessage>	TestScannerRunner.getSentMessages()
java.util.List<PlatformMessage>	TestScannerRunnerImpl.getSentMessages()

Uses of PlatformMessage in com.attivio.sdk.search

Classes in com.attivio.sdk.search that implement PlatformMessage

Modifier and Type	Class	Description
class	QueryRequest	Represents a search query and all associated meta data about the query such as sorting, faceting, linguistic options, etc.
class	QueryResponse	QueryResponse contains the response to a QueryRequest.

Uses of PlatformMessage in com.attivio.sdk.security

Classes in com.attivio.sdk.security that implement PlatformMessage

Modifier and Type	Class	Description
class	AuthenticationRequest	PlatformMessage for authentication
class	AuthenticationResponse	PlatformMessage for returning AuthenticationRequest's response.

Uses of PlatformMessage in com.attivio.sdk.server.component

Methods in com.attivio.sdk.server.component that return PlatformMessage

Modifier and Type	Method	Description
PlatformMessage	CgiRequestProcessor.handleCgiRequest(CgiRequest cgi)	Called by the Attivio Engine to convert a CgiRequest into a PlatformMessage to be handled by the Attivio Engine.
PlatformMessage	MessageHandlingWorkflowStage.processMessage(PlatformMessage msg)	Called whenever a message is received for the component.

Methods in com.attivio.sdk.server.component with parameters of type PlatformMessage

Modifier and Type	Method	Description
PlatformMessage	MessageHandlingWorkflowStage.processMessage(PlatformMessage msg)	Called whenever a message is received for the component.

Uses of PlatformMessage in com.attivio.sdk.server.component.ingest

Methods in com.attivio.sdk.server.component.ingest with parameters of type PlatformMessage

Modifier and Type	Method	Description
void	ProcessingFeedbackHandler.drop(PlatformMessage message)	Report a dropped message

Uses of PlatformMessage in com.attivio.sdk.service

Fields in com.attivio.sdk.service with type parameters of type PlatformMessage

Modifier and Type	Field	Description
java.util.ArrayList<PlatformMessage>	MockIngestApi.msgs

Methods in com.attivio.sdk.service that return types with arguments of type PlatformMessage

Modifier and Type	Method	Description
java.util.List<PlatformMessage>	MockIngestApi.getMessages()

Methods in com.attivio.sdk.service with parameters of type PlatformMessage

Modifier and Type	Method	Description
void	MockIngestApi.feed(PlatformMessage msg)

Constructors in com.attivio.sdk.service with parameters of type PlatformMessage

Constructor	Description
MockAuditDetail(PlatformMessage msg, ProcessingResultCode code)

Uses of PlatformMessage in com.attivio.sdk.test

Methods in com.attivio.sdk.test with parameters of type PlatformMessage

Modifier and Type	Method	Description
void	MockProcessingFeedbackHandler.drop(PlatformMessage message)	Report a dropped message

Uses of PlatformMessage in com.attivio.sdk.transport

Methods in com.attivio.sdk.transport that return PlatformMessage

Modifier and Type	Method	Description
PlatformMessage	MessageEmitter.emit(PlatformMessage msg, boolean synchronous, java.net.URI srcURI)	send a message to the internal URI.
PlatformMessage	SyncronousMessageHandle.getRequestMessage()	Get the request message received by the Transport.
PlatformMessage	ClientTransport.sendMessage(PlatformMessage msg, S sender)	Synchronously send a message via the provided sender.
PlatformMessage	MultiRegionTransport.sendMessage(PlatformMessage msg, S sender)	Synchronously send a message via the provided sender.

Methods in com.attivio.sdk.transport with parameters of type PlatformMessage

Modifier and Type	Method	Description
void	ClientTransport.dispatchMessage(PlatformMessage msg, S sender)	Asynchronously send a message via the provided sender with no expected return.
void	MultiRegionTransport.dispatchMessage(PlatformMessage msg, S sender)	Asynchronously send a message via the provided sender with no expected return.
PlatformMessage	MessageEmitter.emit(PlatformMessage msg, boolean synchronous, java.net.URI srcURI)	send a message to the internal URI.
void	SyncronousMessageHandle.handleReplyMessage(PlatformMessage msg)	Handle the reply message from the bus.
abstract void	MultiRegionTransport.release(PlatformMessage msg)	Release a message from potential re-emission
PlatformMessage	ClientTransport.sendMessage(PlatformMessage msg, S sender)	Synchronously send a message via the provided sender.
PlatformMessage	MultiRegionTransport.sendMessage(PlatformMessage msg, S sender)	Synchronously send a message via the provided sender.

Uses of PlatformMessage in com.attivio.service

Methods in com.attivio.service with parameters of type PlatformMessage

Modifier and Type	Method	Description
void	IngestApi.feed(PlatformMessage msg)

Uses of PlatformMessage in com.attivio.sysstate

Methods in com.attivio.sysstate with parameters of type PlatformMessage

Modifier and Type	Method	Description
void	NoOpSystemStateMonitor.startDocumentEvent(PlatformMessage msg, java.lang.String componentName, IngestDocument doc)	Starts a document event.
void	SystemStateMonitor.startDocumentEvent(PlatformMessage msg, java.lang.String componentName, IngestDocument doc)	Starts a document event.
void	NoOpSystemStateMonitor.startEvent(SystemStateMonitor.ComponentEvent event, PlatformMessage msg, java.lang.String componentName, java.lang.String docIdOrUri)	Starts an event.
void	SystemStateMonitor.startEvent(SystemStateMonitor.ComponentEvent event, PlatformMessage msg, java.lang.String componentName, java.lang.String docIdOrUriOrThreadType)	Starts an event.
void	MetricsCollector.startProcessingDocument(PlatformMessage msg, IngestDocument doc)	Call this method when this MetricsCollector's component starts processing a document.
void	NoOpSystemStateMonitor.stopDocumentEvent(PlatformMessage msg, java.lang.String componentName, IngestDocument doc, long duration)	Stops a document event.
void	SystemStateMonitor.stopDocumentEvent(PlatformMessage msg, java.lang.String componentName, IngestDocument doc, long durationInNano)	Stops a document event.
void	MetricsCollector.stopProcessingDocument(PlatformMessage msg, IngestDocument doc, long timeSpentProcessingDocument)	Call this method when this MetricsCollector's component stops processing a document.

Uses of PlatformMessage in com.attivio.transport

Methods in com.attivio.transport that return PlatformMessage

Modifier and Type	Method	Description
PlatformMessage	HttpClientTransport.sendMessage(PlatformMessage msg, java.net.URI sender)	Synchronously send a message via the provided sender.

Methods in com.attivio.transport with parameters of type PlatformMessage

Modifier and Type	Method	Description
void	HttpClientTransport.dispatchMessage(PlatformMessage msg, java.net.URI sender)	Asynchronously send a message via the provided sender with no expected return.
PlatformMessage	HttpClientTransport.sendMessage(PlatformMessage msg, java.net.URI sender)	Synchronously send a message via the provided sender.

Uses of PlatformMessage in com.attivio.util

Methods in com.attivio.util that return PlatformMessage

Modifier and Type	Method	Description
static PlatformMessage	MessageUtils.rawSend(PlatformMessage msg, java.lang.String endpointName, boolean synchronous)	Sends a message to the endpointName.
static PlatformMessage	MessageUtils.rawSendWithRetry(PlatformMessage msg, java.lang.String endpointName, boolean synchronous)	Sends a message to the endpointName.
static PlatformMessage	MessageUtils.rawSendWithRetry(PlatformMessage msg, java.lang.String endpointName, boolean synchronous, int maxRetries, long retryWaitTime)	Method for sending a message, retrying on transport error.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName)	Sends a message to the endpointName synchronously.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName, boolean allowNullResponse)	Sends a message to the endpointName synchronously.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName, boolean allowNullResponse, int maxRetries, long retryWaitTime)	Sends a message to endpointName synchronously, retrying on transport error.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName, int maxRetries, long retryWaitTime)	Sends a message to endpointName synchronously, retrying on transport error.

Methods in com.attivio.util with parameters of type PlatformMessage

Modifier and Type	Method	Description
static void	MessageUtils.dispatch(PlatformMessage msg, java.lang.String endpointName)	Sends the message to the endpointName asynchronously.
static boolean	MessageUtils.hasVisitedComponent(PlatformMessage msg, java.lang.String componentName)
static PlatformMessage	MessageUtils.rawSend(PlatformMessage msg, java.lang.String endpointName, boolean synchronous)	Sends a message to the endpointName.
static PlatformMessage	MessageUtils.rawSendWithRetry(PlatformMessage msg, java.lang.String endpointName, boolean synchronous)	Sends a message to the endpointName.
static PlatformMessage	MessageUtils.rawSendWithRetry(PlatformMessage msg, java.lang.String endpointName, boolean synchronous, int maxRetries, long retryWaitTime)	Method for sending a message, retrying on transport error.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName)	Sends a message to the endpointName synchronously.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName, boolean allowNullResponse)	Sends a message to the endpointName synchronously.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName, boolean allowNullResponse, int maxRetries, long retryWaitTime)	Sends a message to endpointName synchronously, retrying on transport error.
static PlatformMessage	MessageUtils.send(PlatformMessage msg, java.lang.String endpointName, int maxRetries, long retryWaitTime)	Sends a message to endpointName synchronously, retrying on transport error.

Uses of PlatformMessage in com.attivio.util.ft

Methods in com.attivio.util.ft with parameters of type PlatformMessage

Modifier and Type	Method	Description
default boolean	TransactionReceiver.add(long progress, PlatformMessage message)	Receive a PlatformMessage from the transaction log
void	TransactionLog.addMessage(PlatformMessage msg)	Add a PlatformMessage to the transaction log.

Uses of PlatformMessage in com.attivio.util.serialization

Methods in com.attivio.util.serialization with parameters of type PlatformMessage

Modifier and Type	Method	Description
static void	AbstractPlatformMessageConverter.marshalMessage(PlatformMessage msg, com.thoughtworks.xstream.io.HierarchicalStreamWriter writer, com.thoughtworks.xstream.converters.MarshallingContext context, com.thoughtworks.xstream.mapper.Mapper mapper)	Marshals a message
static void	AbstractPlatformMessageConverter.unmarshalMessage(PlatformMessage msg, com.thoughtworks.xstream.io.HierarchicalStreamReader reader, com.thoughtworks.xstream.converters.UnmarshallingContext context, com.thoughtworks.xstream.mapper.Mapper mapper)	Unmarshals a message