Index

B C D E F G I M N O Q R S T V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

B

BusinessException - Exception in io.adamantic.quicknote.exceptions
Base class for business exceptions - i.e.
BusinessException(ExceptionCode) - Constructor for exception io.adamantic.quicknote.exceptions.BusinessException
Constructs a new business exception with the given code.
BusinessException(ExceptionCode, String) - Constructor for exception io.adamantic.quicknote.exceptions.BusinessException
Constructs a new business exception with the given code and message.
BusinessException(ExceptionCode, String, Throwable) - Constructor for exception io.adamantic.quicknote.exceptions.BusinessException
Constructs a new business exception with the given code, message and cause.

C

CFG_EXCEPTION - Enum constant in enum class io.adamantic.quicknote.exceptions.ExceptionCode
Configuration exception
Channel - Interface in io.adamantic.quicknote
Represents a channel for sending or receiving messages.
ChannelNotFound - Exception in io.adamantic.quicknote.exceptions
Exception thrown when a channel is not found.
ChannelNotFound(String) - Constructor for exception io.adamantic.quicknote.exceptions.ChannelNotFound
Constructor specifying the name of the channel that was not found.
ChannelNotFound(String, Throwable) - Constructor for exception io.adamantic.quicknote.exceptions.ChannelNotFound
Constructor specifying the name of the channel that was not found and the cause of lookup failure.
ChannelState - Enum Class in io.adamantic.quicknote.types
Simple representation of the state of a channel
CHN_NOTFOUND - Enum constant in enum class io.adamantic.quicknote.exceptions.ExceptionCode
Channel not found
clientId(String) - Static method in class io.adamantic.quicknote.Quicknote
Changes the default client ID used by the library.
close() - Method in interface io.adamantic.quicknote.Channel
Closes the channel.
CLOSED - Enum constant in enum class io.adamantic.quicknote.types.ChannelState
The channel is closed, it cannot transport data.
ConfigException - Exception in io.adamantic.quicknote.exceptions
Exception thrown when a configuration error is detected.
ConfigException(String) - Constructor for exception io.adamantic.quicknote.exceptions.ConfigException
Constructs a new configuration exception with the given message.
ConfigException(String, Throwable) - Constructor for exception io.adamantic.quicknote.exceptions.ConfigException
Constructs a new configuration exception with the given message and cause.
configForConnector(String) - Method in class io.adamantic.quicknote.QuicknoteConfig
Returns the main configuration entry point for a specific connector.
configForReceiver(String) - Method in class io.adamantic.quicknote.QuicknoteConfig
Returns the main configuration entry point for a specific receiver.
configForSender(String) - Method in class io.adamantic.quicknote.QuicknoteConfig
Returns the main configuration entry point for a specific sender.
connector(String) - Method in class io.adamantic.quicknote.Quicknote
Returns a connector for the given name, creating and starting it if necessary.
Connector - Interface in io.adamantic.quicknote
Handles connection details to specific remote relays Every module should have its connector.

D

DEFAULT_CONTENT_TYPE - Static variable in class io.adamantic.quicknote.types.Message
Default content type for messages.
DEFAULT_HEADERS - Static variable in class io.adamantic.quicknote.types.Message
Default headers for messages.
DEFAULT_PAYLOAD - Static variable in class io.adamantic.quicknote.types.Message
Default payload for messages.
DEFAULT_ROUTING - Static variable in class io.adamantic.quicknote.types.Message
Default routing key for messages.
DEFAULT_TTL - Static variable in class io.adamantic.quicknote.types.Message
Default time-to-live for messages.

E

ERROR - Enum constant in enum class io.adamantic.quicknote.types.ChannelState
The channel is in an error state, it cannot transport data until some remediation action is taken (e.g.
ExceptionCode - Enum Class in io.adamantic.quicknote.exceptions
An enumeration of exception codes that facilitates communication of error conditions across different layers and components of a distributed system.

F

FTR_NOTIMPL - Enum constant in enum class io.adamantic.quicknote.exceptions.ExceptionCode
Feature not implemented

G

globalConfig() - Method in class io.adamantic.quicknote.QuicknoteConfig
Returns the global configuration object.

I

IDGenerator() - Constructor for class io.adamantic.quicknote.types.Message.IDGenerator
 
initialize(QuicknoteConfig) - Method in interface io.adamantic.quicknote.Connector
Performs the connector initialization.
instance() - Static method in class io.adamantic.quicknote.Quicknote
Lazily creates and initializes a singleton instance of the Quicknote library.
io.adamantic.quicknote - package io.adamantic.quicknote
 
io.adamantic.quicknote.exceptions - package io.adamantic.quicknote.exceptions
 
io.adamantic.quicknote.types - package io.adamantic.quicknote.types
 

M

Message - Class in io.adamantic.quicknote.types
Simple representation of a message to be sent over a channel.
Message(long) - Constructor for class io.adamantic.quicknote.types.Message
Creates a new message with a specific id, rather than asking the ID generator to generate a new one.
Message.IDGenerator - Class in io.adamantic.quicknote.types
A very basic message id generator.
MSG_TTLEXP - Enum constant in enum class io.adamantic.quicknote.exceptions.ExceptionCode
Message time-to-live expired

N

name() - Method in interface io.adamantic.quicknote.Channel
The name of the channel.
nextId() - Method in class io.adamantic.quicknote.types.Message.IDGenerator
Generates a new message id.
nextId() - Static method in class io.adamantic.quicknote.types.Message
Delegates message id generation to the installed id generator.
NotImplemented - Exception in io.adamantic.quicknote.exceptions
Exception thrown when a feature is not implemented.
NotImplemented(String) - Constructor for exception io.adamantic.quicknote.exceptions.NotImplemented
Constructor specifying the name of the feature that is not implemented.

O

open() - Method in interface io.adamantic.quicknote.Channel
Opens the channel for sending or receiving messages.
OPEN - Enum constant in enum class io.adamantic.quicknote.types.ChannelState
The channel is open, it can be used to communicate.

Q

Quicknote - Class in io.adamantic.quicknote
Entry point for the Quicknote library.
QuicknoteConfig - Class in io.adamantic.quicknote
Quicknote main configuration class.
QuicknoteConfig() - Constructor for class io.adamantic.quicknote.QuicknoteConfig
 

R

receiver(String) - Method in interface io.adamantic.quicknote.Connector
Returns a receiver with the given name.
receiver(String) - Method in class io.adamantic.quicknote.Quicknote
Returns a receiver for the given name, delegating its retrieval to the specific connector hosting the receiver (specified in the configuration).
Receiver - Interface in io.adamantic.quicknote
Abstracts an incoming channel.
requireStringNotEmpty(Configuration, String) - Static method in class io.adamantic.quicknote.QuicknoteConfig
Loads a string from configuration, requiring that it's not empty.

S

send(Message) - Method in interface io.adamantic.quicknote.Sender
Sends a message to a remote destination.
sender(String) - Method in interface io.adamantic.quicknote.Connector
Returns a sender with the given name.
sender(String) - Method in class io.adamantic.quicknote.Quicknote
Returns a sender for the given name, delegating its retrieval to the specific connector hosting the sender (specified in the configuration).
Sender - Interface in io.adamantic.quicknote
A channel to send messages to a remote destination.
state() - Method in interface io.adamantic.quicknote.Channel
Returns the state of the channel.
subscribe(String, Flow.Subscriber<? super Message>) - Method in interface io.adamantic.quicknote.Receiver
Creates a new subscription for incoming messages over a specific routing key (i.e.
SystemException - Exception in io.adamantic.quicknote.exceptions
Base class for all system-level exceptions.
SystemException(ExceptionCode) - Constructor for exception io.adamantic.quicknote.exceptions.SystemException
Constructs a new system exception with the given code.
SystemException(ExceptionCode, String) - Constructor for exception io.adamantic.quicknote.exceptions.SystemException
Constructs a new system exception with the given code and message.
SystemException(ExceptionCode, String, Throwable) - Constructor for exception io.adamantic.quicknote.exceptions.SystemException
Constructs a new system exception with the given code, message and cause.

T

TimeToLiveExpired - Exception in io.adamantic.quicknote.exceptions
Exception thrown when a message has expired its time-to-live.
TimeToLiveExpired(Message) - Constructor for exception io.adamantic.quicknote.exceptions.TimeToLiveExpired
Creates a new exception instance, with a reference to the expired message.
touchTtl() - Method in class io.adamantic.quicknote.types.Message
Decrements the time to live of this message.

V

valueOf(String) - Static method in enum class io.adamantic.quicknote.exceptions.ExceptionCode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.adamantic.quicknote.types.ChannelState
Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.adamantic.quicknote.exceptions.ExceptionCode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.adamantic.quicknote.types.ChannelState
Returns an array containing the constants of this enum class, in the order they are declared.
B C D E F G I M N O Q R S T V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form