A B C D E G I L M O P R S T _

A

abandon(MessageEnvelop) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Returns message into the queue and makes it available for all subscribers to receive it again.

abandon(MessageEnvelop) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Returnes message into the queue and makes it available for all subscribers to receive it again.

abandon(MessageEnvelop) - Method in class org.pipservices.messaging.queues.MessageQueue

Returnes message into the queue and makes it available for all subscribers to receive it again.

B

beginListen(String, IMessageReceiver) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Listens for incoming messages without blocking the current thread.

beginListen(String, IMessageReceiver) - Method in class org.pipservices.messaging.queues.MessageQueue

Listens for incoming messages without blocking the current thread.

C

canAbandon() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to abandon messages.

canClear() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue can be cleared.

canDeadLetter() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to send messages to dead letter queue.

canMessageCount() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to read number of messages.

canPeek() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to peek messages.

canPeekBatch() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to peek multiple messages in one batch.

canReceive() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to receive messages.

canRenewLock() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to renew message lock.

canSend() - Method in class org.pipservices.messaging.queues.MessagingCapabilities

Informs if the queue is able to send messages.

clear(String) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Clears component state.

clear(String) - Method in class org.pipservices.messaging.queues.MessageQueue

Clears component state.

close(String) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Closes component and frees used resources.

close(String) - Method in class org.pipservices.messaging.queues.MessageQueue

Closes component and frees used resources.

complete(MessageEnvelop) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Permanently removes a message from the queue.

complete(MessageEnvelop) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Permanently removes a message from the queue.

complete(MessageEnvelop) - Method in class org.pipservices.messaging.queues.MessageQueue

Permanently removes a message from the queue.

configure(ConfigParams) - Method in class org.pipservices.messaging.queues.MessageQueue

Configures component by passing configuration parameters.

D

DefaultMessagingFactory - Class in org.pipservices.messaging.build

Creates MemoryMessageQueue components by their descriptors.

DefaultMessagingFactory() - Constructor for class org.pipservices.messaging.build.DefaultMessagingFactory

Create a new instance of the factory.

Descriptor - Static variable in class org.pipservices.messaging.build.DefaultMessagingFactory

Descriptor - Static variable in class org.pipservices.messaging.build.MemoryMessageQueueFactory

E

endListen(String) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Ends listening for incoming messages.

endListen(String) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Ends listening for incoming messages.

endListen(String) - Method in class org.pipservices.messaging.queues.MessageQueue

Ends listening for incoming messages.

G

getCapabilities() - Method in interface org.pipservices.messaging.queues.IMessageQueue

Gets the queue capabilities

getCapabilities() - Method in class org.pipservices.messaging.queues.MessageQueue

Gets the queue capabilities

getCorrelationId() - Method in class org.pipservices.messaging.queues.MessageEnvelop

getMessage() - Method in class org.pipservices.messaging.queues.MessageEnvelop

getMessageAsJson(Class<T>) - Method in class org.pipservices.messaging.queues.MessageEnvelop

getMessageCount() - Method in interface org.pipservices.messaging.queues.IMessageQueue

Gets the current number of messages in the queue to be delivered.

getMessageCount() - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Gets the current number of messages in the queue to be delivered.

getMessageCount() - Method in class org.pipservices.messaging.queues.MessageQueue

getMessageId() - Method in class org.pipservices.messaging.queues.MessageEnvelop

getMessageType() - Method in class org.pipservices.messaging.queues.MessageEnvelop

getName() - Method in interface org.pipservices.messaging.queues.IMessageQueue

Gets the queue name

getName() - Method in class org.pipservices.messaging.queues.MessageQueue

Gets the queue name

getReference() - Method in class org.pipservices.messaging.queues.MessageEnvelop

getSentTime() - Method in class org.pipservices.messaging.queues.MessageEnvelop

I

IMessageQueue - Interface in org.pipservices.messaging.queues

Interface for asynchronous message queues.

IMessageReceiver - Interface in org.pipservices.messaging.queues

Callback interface to receive incoming messages.

isOpen() - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Checks if the component is opened.

isOpen() - Method in class org.pipservices.messaging.queues.MessageQueue

Checks if the component is opened.

L

listen(String, IMessageReceiver) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Listens for incoming messages and blocks the current thread until queue is closed.

listen(String, IMessageReceiver) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Listens for incoming messages and blocks the current thread until queue is closed.

listen(String, IMessageReceiver) - Method in class org.pipservices.messaging.queues.MessageQueue

Listens for incoming messages and blocks the current thread until queue is closed.

M

MemoryMessageQueue - Class in org.pipservices.messaging.queues

Message queue that sends and receives messages within the same process by using shared memory.

MemoryMessageQueue() - Constructor for class org.pipservices.messaging.queues.MemoryMessageQueue

Creates a new instance of the message queue.

MemoryMessageQueue(String) - Constructor for class org.pipservices.messaging.queues.MemoryMessageQueue

Creates a new instance of the message queue.

MemoryMessageQueueDescriptor - Static variable in class org.pipservices.messaging.build.DefaultMessagingFactory

MemoryMessageQueueFactory - Class in org.pipservices.messaging.build

Creates MemoryMessageQueue components by their descriptors.

MemoryMessageQueueFactory() - Constructor for class org.pipservices.messaging.build.MemoryMessageQueueFactory

Create a new instance of the factory.

MemoryMessageQueueFactoryDescriptor - Static variable in class org.pipservices.messaging.build.DefaultMessagingFactory

MemoryQueueDescriptor - Static variable in class org.pipservices.messaging.build.MemoryMessageQueueFactory

MessageEnvelop - Class in org.pipservices.messaging.queues

Allows adding additional information to messages.

MessageEnvelop() - Constructor for class org.pipservices.messaging.queues.MessageEnvelop

Creates a new MessageEnvelope.

MessageEnvelop(String, String, Object) - Constructor for class org.pipservices.messaging.queues.MessageEnvelop

Creates a new MessageEnvelop, which adds a correlation id, message id, and a type to the data being sent/received.

MessageEnvelop(String, String, String) - Constructor for class org.pipservices.messaging.queues.MessageEnvelop

Creates a new MessageEnvelop, which adds a correlation id, message id, and a type to the data being sent/received.

MessageQueue - Class in org.pipservices.messaging.queues

Abstract message queue that is used as a basis for specific message queue implementations.

MessageQueue() - Constructor for class org.pipservices.messaging.queues.MessageQueue

Creates a new instance of the message queue.

MessageQueue(String) - Constructor for class org.pipservices.messaging.queues.MessageQueue

Creates a new instance of the message queue.

MessageQueue(String, ConfigParams) - Constructor for class org.pipservices.messaging.queues.MessageQueue

Creates a new instance of the message queue.

MessagingCapabilities - Class in org.pipservices.messaging.queues

Data object that contains supported capabilities of a message queue.

MessagingCapabilities(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class org.pipservices.messaging.queues.MessagingCapabilities

Creates a new instance of the capabilities object.

moveToDeadLetter(MessageEnvelop) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Permanently removes a message from the queue and sends it to dead letter queue.

moveToDeadLetter(MessageEnvelop) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Permanently removes a message from the queue and sends it to dead letter queue.

moveToDeadLetter(MessageEnvelop) - Method in class org.pipservices.messaging.queues.MessageQueue

Permanently removes a message from the queue and sends it to dead letter queue.

O

open(String, ConnectionParams, CredentialParams) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Opens the component with given connection and credential parameters.

open(String) - Method in class org.pipservices.messaging.queues.MessageQueue

Opens the component.

open(String, ConnectionParams, CredentialParams) - Method in class org.pipservices.messaging.queues.MessageQueue

Opens the component with given connection and credential parameters.

org.pipservices.messaging.build - package org.pipservices.messaging.build

org.pipservices.messaging.queues - package org.pipservices.messaging.queues

P

peek(String) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Peeks a single incoming message from the queue without removing it.

peek(String) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Peeks a single incoming message from the queue without removing it.

peek(String) - Method in class org.pipservices.messaging.queues.MessageQueue

Peeks a single incoming message from the queue without removing it.

peekBatch(String, int) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Peeks multiple incoming messages from the queue without removing them.

peekBatch(String, int) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Peeks multiple incoming messages from the queue without removing them.

peekBatch(String, int) - Method in class org.pipservices.messaging.queues.MessageQueue

Peeks multiple incoming messages from the queue without removing them.

R

receive(String, long) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Receives an incoming message and removes it from the queue.

receive(String, long) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Receives an incoming message and removes it from the queue.

receive(String, long) - Method in class org.pipservices.messaging.queues.MessageQueue

Receives an incoming message and removes it from the queue.

receiveMessage(MessageEnvelop, IMessageQueue) - Method in interface org.pipservices.messaging.queues.IMessageReceiver

Receives incoming message from the queue.

renewLock(MessageEnvelop, long) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Renews a lock on a message that makes it invisible from other receivers in the queue.

renewLock(MessageEnvelop, long) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Renews a lock on a message that makes it invisible from other receivers in the queue.

renewLock(MessageEnvelop, long) - Method in class org.pipservices.messaging.queues.MessageQueue

Renews a lock on a message that makes it invisible from other receivers in the queue.

S

send(String, MessageEnvelop) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Sends a message into the queue.

send(String, MessageEnvelop) - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Sends a message into the queue.

send(String, MessageEnvelop) - Method in class org.pipservices.messaging.queues.MessageQueue

Sends a message into the queue.

sendAsObject(String, String, Object) - Method in interface org.pipservices.messaging.queues.IMessageQueue

Sends an object into the queue.

sendAsObject(String, String, Object) - Method in class org.pipservices.messaging.queues.MessageQueue

Sends an object into the queue.

setCorrelationId(String) - Method in class org.pipservices.messaging.queues.MessageEnvelop

setMessage(Object) - Method in class org.pipservices.messaging.queues.MessageEnvelop

setMessageAsJson(Object) - Method in class org.pipservices.messaging.queues.MessageEnvelop

Stores the given string.

setMessageId(String) - Method in class org.pipservices.messaging.queues.MessageEnvelop

setMessageType(String) - Method in class org.pipservices.messaging.queues.MessageEnvelop

setReference(Object) - Method in class org.pipservices.messaging.queues.MessageEnvelop

Sets a lock token reference for this MessageEnvelope.

setReferences(IReferences) - Method in class org.pipservices.messaging.queues.MessageQueue

Sets references to dependent components.

setSentTime(ZonedDateTime) - Method in class org.pipservices.messaging.queues.MessageEnvelop

T

toString() - Method in class org.pipservices.messaging.queues.MemoryMessageQueue

Override toString() method, string representation of queue.

toString() - Method in class org.pipservices.messaging.queues.MessageEnvelop

Convert's this MessageEnvelope to a string, using the following format: "[correlation_id, message_type, message.toString]".

toString() - Method in class org.pipservices.messaging.queues.MessageQueue

Gets a string representation of the object.

_

_capabilities - Variable in class org.pipservices.messaging.queues.MessageQueue

_connectionResolver - Variable in class org.pipservices.messaging.queues.MessageQueue

_counters - Variable in class org.pipservices.messaging.queues.MessageQueue

_credentialResolver - Variable in class org.pipservices.messaging.queues.MessageQueue

_kind - Variable in class org.pipservices.messaging.queues.MessageQueue

_lock - Variable in class org.pipservices.messaging.queues.MessageQueue

_logger - Variable in class org.pipservices.messaging.queues.MessageQueue

_name - Variable in class org.pipservices.messaging.queues.MessageQueue

A B C D E G I L M O P R S T _