Index (jenjin-io 1.0.1 API)

A B C D E G I M P Q R S U V W

A

authenticate(T, String, Map<String, String>) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Authenticate the user with the given unique id and valid credentials and, if successful, populating the given ExecutionContext with the user data from the backing data store.
authenticate(T, String, String) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Authenticate the user with the given unique id and valid password and, if successful, populating the given ExecutionContext with the user data from the backing data store.
AuthenticationException - Exception in com.jenjinstudios.io.authentication: Thrown when there is an unexpected error while authenticating.
AuthenticationException(String, Throwable) - Constructor for exception com.jenjinstudios.io.authentication.AuthenticationException: Construct a new AuthenticationException with the given message and cause.
AuthenticationException(String) - Constructor for exception com.jenjinstudios.io.authentication.AuthenticationException: Construct a new AuthenticationException with the given message.
Authenticator<T extends ExecutionContext> - Interface in com.jenjinstudios.io.authentication: Interface defining several methods that are useful for authentication.

B

broadcast(Message) - Method in class com.jenjinstudios.io.server.Server: Broadcast the given message to all connections.
broadcast(Message, Predicate<Connection>) - Method in class com.jenjinstudios.io.server.Server: Broadcast a message to all connections that fulfill the given predicate.
build(Socket) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a Connection using the given Socket.
build(InputStream, OutputStream) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a Connection using the given input and output streams.
build(MessageReader, MessageWriter) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a Connection using the given MessageReader and MessageWriter.
build() - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server using the properties supplied to this builder.

C

cancel() - Method in class com.jenjinstudios.io.concurrency.RecurringTask: Cancel this task; after this method is called, the task will not be run again.
close() - Method in interface com.jenjinstudios.io.authentication.Authenticator: Close the backing database connection.
close() - Method in interface com.jenjinstudios.io.MessageReader: Close the underlying stream.
close() - Method in interface com.jenjinstudios.io.MessageWriter: Close the underlying stream.
close() - Method in class com.jenjinstudios.io.serialization.GsonMessageReader
close() - Method in class com.jenjinstudios.io.serialization.GsonMessageWriter
com.jenjinstudios.io - package com.jenjinstudios.io
com.jenjinstudios.io.annotations - package com.jenjinstudios.io.annotations
com.jenjinstudios.io.authentication - package com.jenjinstudios.io.authentication
com.jenjinstudios.io.concurrency - package com.jenjinstudios.io.concurrency
com.jenjinstudios.io.connection - package com.jenjinstudios.io.connection
com.jenjinstudios.io.serialization - package com.jenjinstudios.io.serialization
com.jenjinstudios.io.server - package com.jenjinstudios.io.server
Connection<C extends ExecutionContext> - Class in com.jenjinstudios.io.connection: Used for making connections so that Message objects can be read, written, and executed in a non-blocking fashion.
ConnectionBuilder<T extends ExecutionContext> - Class in com.jenjinstudios.io.connection: Superclass for connection builders.
ConnectionBuilder() - Constructor for class com.jenjinstudios.io.connection.ConnectionBuilder
createInstance() - Method in interface com.jenjinstudios.io.concurrency.RecurringTaskFactory: Create a new RecurringTask.
createInstance() - Method in interface com.jenjinstudios.io.ExecutionContextFactory: Create a new instance of an ExecutionContext.
createReader(InputStream) - Method in interface com.jenjinstudios.io.MessageReaderFactory: Create a MessageReader from the given InputStream.
createReader(InputStream) - Method in class com.jenjinstudios.io.serialization.GsonMessageIOFactory
createWriter(OutputStream) - Method in interface com.jenjinstudios.io.MessageWriterFactory: Create a MessageWriter from the given OutputStream.
createWriter(OutputStream) - Method in class com.jenjinstudios.io.serialization.GsonMessageIOFactory
credentialsValid(String, Map<String, String>) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Determine whether the given credentials are valid for the user with the specified unique identifier.

D

deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.jenjinstudios.io.serialization.GsonMessageDeserializer

E

errorEncountered(Throwable) - Method in class com.jenjinstudios.io.concurrency.MessageQueue: Indicate than an exception has occurred and store the exception in the queue.
ErrorTask<T extends ExecutionContext> - Class in com.jenjinstudios.io.concurrency: Checks for errors, and raises a flag if necessary.
ErrorTask(MessageQueue<T>, Consumer<Throwable>) - Constructor for class com.jenjinstudios.io.concurrency.ErrorTask: Construct a new ErrorTask that will utilize the given MessageQueue.
execute(T) - Method in class com.jenjinstudios.io.concurrency.RecurringTask: This method is invoked by the execution thread when at least the number of milliseconds specified by getInterval have passed since the last time it was executed.
execute(C) - Method in interface com.jenjinstudios.io.Message: Execute any actions required by the message.
ExecutionContext - Interface in com.jenjinstudios.io: Used to provide context to executing messages.
ExecutionContextFactory<T extends ExecutionContext> - Interface in com.jenjinstudios.io: Used to create ExecutionContext instances.
ExecutionTask<T extends ExecutionContext> - Class in com.jenjinstudios.io.concurrency: Executes ExecutableMessage objects which have been read.
ExecutionTask(MessageQueue<T>, T, Collection<Consumer<T>>) - Constructor for class com.jenjinstudios.io.concurrency.ExecutionTask: Construct a new ExecuteTask that will execute messages from the given MessageQueue.

G

getConnectionCount() - Method in class com.jenjinstudios.io.server.Server
getErrorsAndClear() - Method in class com.jenjinstudios.io.concurrency.MessageQueue: Get any errors reported to this queue and clear the internal list.
getId() - Method in class com.jenjinstudios.io.connection.Connection
getIncomingAndClear() - Method in class com.jenjinstudios.io.concurrency.MessageQueue: Get all messages that have been received since the last time this method was called, and clear the internal list.
getInterval() - Method in class com.jenjinstudios.io.concurrency.RecurringTask
getOutgoingAndClear() - Method in class com.jenjinstudios.io.concurrency.MessageQueue: Get all messages that have been queued since the last time this method was called, and clear the internal list.
getRecurringTasks() - Method in class com.jenjinstudios.io.concurrency.MessageQueue
GsonMessageDeserializer - Class in com.jenjinstudios.io.serialization: Used to deserialize Message objects with Gson.
GsonMessageDeserializer() - Constructor for class com.jenjinstudios.io.serialization.GsonMessageDeserializer
GsonMessageIOFactory - Class in com.jenjinstudios.io.serialization: Used to create GsonMessageReader and GsonMessageWriter instances from Java InputStream and OutputStream instances.
GsonMessageIOFactory() - Constructor for class com.jenjinstudios.io.serialization.GsonMessageIOFactory
GsonMessageReader - Class in com.jenjinstudios.io.serialization: Implements a MessageWriter which relies on Gson to deserialize incoming data.
GsonMessageReader(InputStream) - Constructor for class com.jenjinstudios.io.serialization.GsonMessageReader: Construct a new GsonMessageReader that will read Messages from the given InputStream.
GsonMessageSerializer - Class in com.jenjinstudios.io.serialization: Used to serialize Messages with Gson.
GsonMessageSerializer() - Constructor for class com.jenjinstudios.io.serialization.GsonMessageSerializer
GsonMessageWriter - Class in com.jenjinstudios.io.serialization: Implements a MessageWriter which relies on Gson to serialize outgoing data.
GsonMessageWriter(OutputStream) - Constructor for class com.jenjinstudios.io.serialization.GsonMessageWriter: Construct a new GsonMessageWriter that will write Messages to the given stream.

I

isAuthenticated(String) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Determine whether the user specified by the given unique identifier is authenticated.
isCancelled() - Method in class com.jenjinstudios.io.concurrency.RecurringTask
isPaused() - Method in class com.jenjinstudios.io.concurrency.RecurringTask
isSkipped() - Method in class com.jenjinstudios.io.concurrency.RecurringTask

M

Message<C extends ExecutionContext> - Interface in com.jenjinstudios.io: Read from a MessageReader, executed, or written to a MessageWriter.
MessageAdapter - Annotation Type in com.jenjinstudios.io.annotations: Used for converting a message of one class into another class.
MessageIOFactory - Interface in com.jenjinstudios.io: Convenience interface combining MessageReaderFactory and MessageWriterFactory.
MessageQueue<T extends ExecutionContext> - Class in com.jenjinstudios.io.concurrency: Queues incoming and outgoing messages in a thread-safe manner.
MessageQueue() - Constructor for class com.jenjinstudios.io.concurrency.MessageQueue: Construct a new MessageQueue.
MessageQueue(Collection<RecurringTask<T>>) - Constructor for class com.jenjinstudios.io.concurrency.MessageQueue: Construct a new MessageQueue with the given recurring tasks.
MessageReader - Interface in com.jenjinstudios.io: Used to read messages from an input stream.
MessageReaderFactory - Interface in com.jenjinstudios.io: Used to create a MessageReader from an InputStream.
messageReceived(Message) - Method in class com.jenjinstudios.io.concurrency.MessageQueue: Indicate that a message has been received and add it to the incoming queue.
MessageWriter - Interface in com.jenjinstudios.io: Used to write messages to an output stream.
MessageWriterFactory - Interface in com.jenjinstudios.io: Used to create a MessageWriter from an OutputStream.

P

PASSWORD - Static variable in interface com.jenjinstudios.io.authentication.Authenticator: This constant is provided an a convenience, to specify a "password" credential in a Map.
passwordValid(String, String) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Determine whether the given password is valid.
pause() - Method in class com.jenjinstudios.io.concurrency.RecurringTask: Pause this task; it will not be executed again until it is resumed.
populate(T, String) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Populate the given ExecutionContext with data for the user with the given unique identifier.

Q

queueOutgoing(Message) - Method in class com.jenjinstudios.io.concurrency.MessageQueue: Queue an outgoing message.

R

read() - Method in interface com.jenjinstudios.io.MessageReader: Read a message from the backing InputStream.
read() - Method in class com.jenjinstudios.io.serialization.GsonMessageReader
ReadTask<T extends ExecutionContext> - Class in com.jenjinstudios.io.concurrency: Reads incoming messages and stores them in a MessageQueue.
ReadTask(MessageQueue<T>, MessageReader) - Constructor for class com.jenjinstudios.io.concurrency.ReadTask: Construct a new ReadTask that will read from the given message input stream and store the incoming messages in the given MessageQueue.
RecurringTask<T extends ExecutionContext> - Class in com.jenjinstudios.io.concurrency: Represents a task with access to an ExecutionContext that should be repeated at a given interval until it is cancelled.
RecurringTask() - Constructor for class com.jenjinstudios.io.concurrency.RecurringTask: Construct a RecurringTask that should execute roughly once per second.
RecurringTask(TimeUnit) - Constructor for class com.jenjinstudios.io.concurrency.RecurringTask: Construct a RecurringTask that should execute roughly once per the time unit specified.
RecurringTask(long) - Constructor for class com.jenjinstudios.io.concurrency.RecurringTask: Construct a RecurringTask that will execute roughly once every interval milliseconds.
RecurringTaskFactory<T extends ExecutionContext> - Interface in com.jenjinstudios.io.concurrency: Used for generating recurring tasks by a ConnectionBuilder.
resume() - Method in class com.jenjinstudios.io.concurrency.RecurringTask: Resume this task; if it is currently paused, it will begin executing at it's regular interval again.
run() - Method in class com.jenjinstudios.io.concurrency.ErrorTask
run() - Method in class com.jenjinstudios.io.concurrency.ExecutionTask
run() - Method in class com.jenjinstudios.io.concurrency.ReadTask
run() - Method in class com.jenjinstudios.io.concurrency.WriteTask

S

sendMessage(Message) - Method in class com.jenjinstudios.io.connection.Connection: Send the specified Message from this connection.
serialize(Message, Type, JsonSerializationContext) - Method in class com.jenjinstudios.io.serialization.GsonMessageSerializer
Server<T extends ExecutionContext> - Class in com.jenjinstudios.io.server: Used to accept and manage incoming connections.
ServerBuilder<T extends ExecutionContext> - Class in com.jenjinstudios.io.server: Used to build Server objects.
ServerBuilder() - Constructor for class com.jenjinstudios.io.server.ServerBuilder
skip() - Method in class com.jenjinstudios.io.concurrency.RecurringTask: Skip the next execution of this task.
start() - Method in class com.jenjinstudios.io.connection.Connection: Start sending, receiving, and executing messages.
start() - Method in class com.jenjinstudios.io.server.Server: Start listening for inbound connections.
stop() - Method in class com.jenjinstudios.io.connection.Connection: Stop sending, receiving, and executing messages, and close input and output streams.
stop() - Method in class com.jenjinstudios.io.server.Server: Stop listening for inbound connections and attempt to gracefully close all existing connections.

U

unauthenticate(T, String) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Unauthenticate the user with the given unique id, restoring the given context to an unauthenticated state.
update(T, String) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Update the backing data store, for the user with the given id, with data from the given context.
userExists(String) - Method in interface com.jenjinstudios.io.authentication.Authenticator: Determine whether the user specified by the given unique identifier exists.

V

VERIFICATION_CODE - Static variable in interface com.jenjinstudios.io.authentication.Authenticator: This constant is provided an a convenience, to specify a "verification code" credential in a Map.

W

withConnectionAddedCallbacks(Iterable<Consumer<Connection<T>>>) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks when a Connection is added.
withConnectionAddedCallbacks(Consumer<Connection<T>>...) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks when a Connection is added.
withConnectionRemovedCallbacks(Iterable<Consumer<Connection<T>>>) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks when a Connection is removed.
withConnectionRemovedCallbacks(Consumer<Connection<T>>...) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks when a Connection is removed.
withContextualTasks(Consumer<T>...) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a connection that includes the given contextual task to be executed synchronously with message execution.
withContextualTasks(BiConsumer<Server, T>...) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given tasks each time a Connection executes its contextual tasks.
withContextualTasks(Iterable<BiConsumer<Server, T>>) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given tasks each time a Connection executes its contextual tasks.
withErrorCallback(BiConsumer<Connection<T>, Throwable>) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a connection with the given error callback function.
withExecutionContextFactory(ExecutionContextFactory<T>) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a connection with the given ExecutionContext.
withMessageIOFactory(MessageIOFactory) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Use the given MessageIOFactory to create MessageReader and MessageWriter instances from Java Input and Output streams.
withMessageReaderFactory(MessageReaderFactory) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Use the specified MessageReaderFactory to build a MessageReader from any InputStreams.
withMessageWriterFactory(MessageWriterFactory) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Use the specified MessageWriterFactory to build a MessageWriter from any OutputStreams.
withMultiConnectionBuilder(ConnectionBuilder<T>) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will use the given ReusableConnectionBuilder to build new connections.
withRecurringTaskFactories(RecurringTaskFactory<T>...) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Specify factories which generate recurring tasks.
withRecurringTasks(RecurringTask<T>...) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a connection that include the given recurring tasks; these tasks are executed synchronously with message execution, and at regular (although undefined) intervals.
withServerSocket(ServerSocket) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server using the given ServerSocket.
withShutdownCallbacks(Consumer<Connection<T>>...) - Method in class com.jenjinstudios.io.connection.ConnectionBuilder: Build a connection that includes the given contextual task to be executed synchronously with message execution.
withShutdownCallbacks(Iterable<Consumer<Server<T>>>) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks after shutdown.
withShutdownCallbacks(Consumer<Server<T>>...) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks after shutdown.
withStartupCallbacks(Iterable<Consumer<Server<T>>>) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks after startup.
withStartupCallbacks(Consumer<Server<T>>...) - Method in class com.jenjinstudios.io.server.ServerBuilder: Build a Server which will execute the given callbacks after startup.
write(Message) - Method in interface com.jenjinstudios.io.MessageWriter: Write the given message to the backing output stream.
write(Message) - Method in class com.jenjinstudios.io.serialization.GsonMessageWriter
WriteTask<T extends ExecutionContext> - Class in com.jenjinstudios.io.concurrency: Writes messages from the outgoing list in the MessageQueue.
WriteTask(MessageQueue<T>, MessageWriter) - Constructor for class com.jenjinstudios.io.concurrency.WriteTask: Construct a new WriteTask that will send messages from the given MessageQueue via the given MessageWriter.

A B C D E G I M P Q R S U V W