A B C D E F G H I M N O S T U V W

A

acknowledgeMessage() - Method in class org.vatplanner.commons.amqp.MessageSupplements

Acknowledges the message on AMQP (ACK confirmation); visible to sender.

AmqpSubscriptionCreator - Class in org.vatplanner.commons.amqp

Creates a new listener for a queue on AMQP to receive "raw" AMQP messages.

AmqpSubscriptionCreator.AmqpMessageHandler - Interface in org.vatplanner.commons.amqp

Handles a message received via AMQP.

AmqpSubscriptionCreator.ReceiptAction - Enum in org.vatplanner.commons.amqp

Describes how to handle message confirmation on AMQP.

B

build(Properties, String) - Method in class org.vatplanner.commons.amqp.ExchangeParameters.Builder

Applies the given Properties using default naming conventions using the given exchange name; see ExchangeParameters JavaDoc.

build() - Method in class org.vatplanner.commons.amqp.MessageSupplements.Builder

Builds a MessageSupplements instance as previously configured.

builder() - Static method in class org.vatplanner.commons.amqp.ExchangeParameters

Returns a new ExchangeParameters.Builder to construct ExchangeParameters.

Builder() - Constructor for class org.vatplanner.commons.amqp.ExchangeParameters.Builder

builder() - Static method in class org.vatplanner.commons.amqp.MessageSupplements

Instantiates a new MessageSupplements.Builder to construct MessageSupplements.

C

ConnectionFailed - Exception in org.vatplanner.commons.amqp

Thrown if an issue causes an AMQP channel or the entire connection to be terminated.

ConnectionFailed(String, Throwable) - Constructor for exception org.vatplanner.commons.amqp.ConnectionFailed

D

defaultingToDeclare(boolean) - Method in class org.vatplanner.commons.amqp.ExchangeParameters.Builder

Sets whether the exchange should be declared by default if left unconfigured by Properties.

defaultingToDefaultRoutingKey(String) - Method in class org.vatplanner.commons.amqp.ExchangeParameters.Builder

Sets the default routing key to use for binding queues that have no other requirement (see ExchangeParameters.getDefaultRoutingKey() for details).

defaultingToDurable(boolean) - Method in class org.vatplanner.commons.amqp.ExchangeParameters.Builder

Sets if the exchange should be declared durable by default if left unconfigured by Properties.

defaultingToName(String) - Method in class org.vatplanner.commons.amqp.ExchangeParameters.Builder

Sets the exchange name to default to if left unconfigured by Properties.

defaultingToType(String) - Method in class org.vatplanner.commons.amqp.ExchangeParameters.Builder

Sets the exchange type to default to if left unconfigured by Properties.

deserialize(AMQP.BasicProperties, byte[]) - Method in class org.vatplanner.commons.amqp.MessageCodec

Deserializes the given Message as received via AMQP.

E

ExchangeParameters - Class in org.vatplanner.commons.amqp

Holds and provides a ExchangeParameters.Builder for the parameters of AMQP exchanges as commonly used throughout VATPlanner configuration Properties.

ExchangeParameters.Builder - Class in org.vatplanner.commons.amqp

Builds ExchangeParameters from Properties, falling back to configurable default values for undefined parameters.

F

forExistingQueue(String) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Configures the listener to be subscribed to an existing queue.

forExistingQueue(String) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

fromJson(JsonObject) - Method in interface org.vatplanner.commons.amqp.Message.Parser

Deserializes a Message from given JSON.

G

getAmqpEnvelope() - Method in class org.vatplanner.commons.amqp.MessageSupplements

Returns the Envelope of the original AMQP message.

getAmqpProperties() - Method in class org.vatplanner.commons.amqp.MessageSupplements

Returns the AMQP.BasicProperties of the original AMQP message.

getDefaultRoutingKey() - Method in class org.vatplanner.commons.amqp.ExchangeParameters

Returns the routing key that should be used to bind queues to the exchange unless implementation has specific requirements to use different keys.

getMessageType() - Method in interface org.vatplanner.commons.amqp.Message

Returns a unique identification of this message type.

getMessageType() - Method in interface org.vatplanner.commons.amqp.Message.Parser

Returns a unique identification of this message type.

getName() - Method in class org.vatplanner.commons.amqp.ExchangeParameters

Returns the name of the AMQP exchange.

getPayload() - Method in class org.vatplanner.commons.amqp.MessageSupplements

Returns the payload that was sent together with the message, if present.

getTimestamp() - Method in interface org.vatplanner.commons.amqp.Message

Returns the creation timestamp of the Message.

getType() - Method in class org.vatplanner.commons.amqp.ExchangeParameters

Returns what type the exchange should be when being declared.

getVerifiedKeyIds() - Method in class org.vatplanner.commons.amqp.MessageSupplements

Returns the IDs of all keys related to the signature used for the Message as known to the MessageSubscriptionCreator's Cryptor instance at time of reception.

H

handleDelivery(String, Envelope, AMQP.BasicProperties, byte[]) - Method in interface org.vatplanner.commons.amqp.AmqpSubscriptionCreator.AmqpMessageHandler

Handles a message received via AMQP.

handleMessage(M, MessageSupplements) - Method in interface org.vatplanner.commons.amqp.MessageSubscriptionCreator.MessageHandler

I

ignoringMessages(Class<? extends Message>...) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Registers the given Message types to be ignored.

ignoringMessages(Collection<Class<? extends Message>>) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Registers the given Message types to be ignored.

isDurable() - Method in class org.vatplanner.commons.amqp.ExchangeParameters

Indicates whether the exchange should be declared durable.

M

Message - Interface in org.vatplanner.commons.amqp

Required to be implemented to make a message class compatible with MessageCodec serialization/deserialization.

Message.Parser<T extends Message> - Interface in org.vatplanner.commons.amqp

Deserializes messages of a specific type.

MessageCodec - Class in org.vatplanner.commons.amqp

Serializes and deserializes Messages with a basic container for transport over AMQP as JSON.

MessageCodec() - Constructor for class org.vatplanner.commons.amqp.MessageCodec

MessageSubscriptionCreator - Class in org.vatplanner.commons.amqp

Creates a new listener for a queue on AMQP to receive deserialized Messages.

MessageSubscriptionCreator.MessageHandler<M extends Message> - Interface in org.vatplanner.commons.amqp

MessageSupplements - Class in org.vatplanner.commons.amqp

Provides additional information and actions to MessageSubscriptionCreator.MessageHandlers.

MessageSupplements.Builder - Class in org.vatplanner.commons.amqp

Builder for MessageSupplements.

N

notOlderThan(Duration) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Sets the message timeout.

notSentAfter(Instant) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Sets the maximum timestamp received messages must indicate.

notSentBefore(Instant) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Sets the minimum timestamp received messages must indicate.

notSentBefore(AtomicReference<Instant>) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Sets the reference to read the minimum timestamp from which received messages must indicate.

O

onAcknowledge(Supplier<Boolean>) - Method in class org.vatplanner.commons.amqp.MessageSupplements.Builder

Sets the callback to be invoked through MessageSupplements.acknowledgeMessage().

onError(AmqpSubscriptionCreator.ReceiptAction) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Sets the message receipt to be sent to the AMQP server if an error occurred during message handling.

onError(AmqpSubscriptionCreator.ReceiptAction) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

onIgnore(AmqpSubscriptionCreator.ReceiptAction) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Sets the ReceiptAction for all ignored messages (filtered by timestamp or message type).

onMessage(AmqpSubscriptionCreator.AmqpMessageHandler) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Registers the AmqpSubscriptionCreator.AmqpMessageHandler to process received messages.

onMessage(Class<M>, MessageSubscriptionCreator.MessageHandler<M>) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Registers a MessageSubscriptionCreator.MessageHandler for the given Message type.

org.vatplanner.commons.amqp - package org.vatplanner.commons.amqp

S

serialize(AMQP.BasicProperties.Builder, Message) - Method in class org.vatplanner.commons.amqp.MessageCodec

Serializes the given Message for JSON-encoded transport over AMQP.

setAmqpEnvelope(Envelope) - Method in class org.vatplanner.commons.amqp.MessageSupplements.Builder

Sets the AMQP message Envelope for the associated message.

setAmqpProperties(AMQP.BasicProperties) - Method in class org.vatplanner.commons.amqp.MessageSupplements.Builder

Sets the AMQP message properties for the associated message.

setPayload(byte[]) - Method in class org.vatplanner.commons.amqp.MessageSupplements.Builder

Sets the payload for the associated message.

setVerifiedKeyIds(Set<Long>) - Method in class org.vatplanner.commons.amqp.MessageSupplements.Builder

Sets the key IDs related to signature verification as returned by Cryptor.verify(byte[], Cryptor.Signature).

shouldDeclare() - Method in class org.vatplanner.commons.amqp.ExchangeParameters

Indicates whether the exchange should be declared on AMQP.

subscribe() - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Subscribes to the exchange/queue as previously configured.

T

toJson() - Method in interface org.vatplanner.commons.amqp.Message

Serializes the message contents to JSON.

toString() - Method in class org.vatplanner.commons.amqp.ExchangeParameters

U

usingChannel(Channel) - Static method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Instantiates a new AmqpSubscriptionCreator for the given Channel.

usingChannel(Channel) - Static method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Instantiates a new MessageSubscriptionCreator for the given Channel.

V

valueOf(String) - Static method in enum org.vatplanner.commons.amqp.AmqpSubscriptionCreator.ReceiptAction

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.vatplanner.commons.amqp.AmqpSubscriptionCreator.ReceiptAction

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAutoAck(boolean) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Controls whether all messages should be automatically acknowledged.

withAutoAck(boolean) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

withCryptor(Cryptor) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

Provides a Cryptor to decrypt messages and verify signatures.

withExchangeParameters(ExchangeParameters) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Sets the ExchangeParameters to be used.

withExchangeParameters(ExchangeParameters) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

withLogPrefix(String) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Configures the prefix name to use for all log messages.

withLogPrefix(String) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

withQueueRoutingKeys(String...) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Configures the routing key(s) the queue should be bound to.

withQueueRoutingKeys(Collection<String>) - Method in class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Configures the routing keys the queue should be bound to.

withQueueRoutingKeys(String...) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

withQueueRoutingKeys(Collection<String>) - Method in class org.vatplanner.commons.amqp.MessageSubscriptionCreator

A B C D E F G H I M N O S T U V W