A B C D E F G H I J K L M N O P Q R S T U V W

A

acceptInsecure() - Method in class org.avis.client.Subscription

True if ALLOW_INSECURE_DELIVERY is enabled.

add(SingleKeyScheme, Key) - Method in class org.avis.security.Keys

Add a key for single key scheme.

add(DualKeyScheme, DualKeyScheme.Subset, Key) - Method in class org.avis.security.Keys

Add a key for dual key scheme.

add(Keys) - Method in class org.avis.security.Keys

Add all keys in a collection.

add(K) - Method in class org.avis.util.ConcurrentHashSet

add(E) - Method in class org.avis.util.ListenerList

addAll(Collection<? extends K>) - Method in class org.avis.util.ConcurrentHashSet

addCloseListener(CloseListener) - Method in class org.avis.client.Elvin

Add listener to the close event sent when the client's connection to the router is disconnected.

added - Variable in class org.avis.security.Keys.Delta

addedTo(Keys) - Method in class org.avis.security.Keys

Shortcut to efficiently generate a key collection that represents this key collection's union with another.

addListener(NotificationListener) - Method in class org.avis.client.Subscription

Add a listener for notifications matched by this subscription.

addLogListener(ElvinLogListener) - Method in class org.avis.client.Elvin

Add a listener for log events emitted by the client.

addNotificationListener(GeneralNotificationListener) - Method in class org.avis.client.Elvin

Add a listener to all notifications received by all subscriptions of this connection.

appendEscaped(StringBuilder, String, char) - Static method in class org.avis.util.Text

Append a string to a builder, escaping (with '\') any instances of a special character.

appendEscaped(StringBuilder, String, String) - Static method in class org.avis.util.Text

Append a string to a builder, escaping (with '\') any instances of a set of special characters.

appendHex(StringBuilder, byte) - Static method in class org.avis.util.Text

Append the hex form of a byte to a builder.

appendHexBytes(StringBuilder, byte[]) - Static method in class org.avis.util.Text

Append a byte array to a builder in form: 01 e2 fe ff ...

asList() - Method in class org.avis.util.ListenerList

asMap() - Method in class org.avis.client.ConnectionOptions

Generate an immutable, live map of the current options.

asMap() - Method in class org.avis.client.Notification

A live, unmodifiable Map view of this notification.

AvisEventObject - Class in org.avis.client

Extends java.util.EventObject to add useful utilities such as general data association.

AvisEventObject(Object) - Constructor for class org.avis.client.AvisEventObject

Create a new instance.

AvisEventObject(Object, Map<String, Object>) - Constructor for class org.avis.client.AvisEventObject

Create a new instance.

B

bufferedReaderFor(Reader) - Static method in class org.avis.util.Streams

Generate a buffered reader wrapper for a reader, if it is not already one.

bytesFrom(InputStream) - Static method in class org.avis.util.Streams

Read all the bytes from a stream and then close it.

bytesToHex(byte[]) - Static method in class org.avis.util.Text

Turn an array of bytes into a hex-encoded string e.g.

C

checkNotNull(Object, String) - Static method in class org.avis.util.Util

Check a value is non-null or throw an IllegalArgumentException.

className(Object) - Static method in class org.avis.util.Text

Return just the name (minus the package) of an object's class.

className(Class<?>) - Static method in class org.avis.util.Text

Return just the name (minus the package) of a class.

clear() - Method in class org.avis.client.Notification

Remove all attributes from the notification.

clear() - Method in class org.avis.util.ConcurrentHashSet

CLIENT_VERSION_MAJOR - Static variable in class org.avis.common.Common

CLIENT_VERSION_MINOR - Static variable in class org.avis.common.Common

clone() - Method in class org.avis.client.ElvinOptions

Create a copy of this option set.

clone() - Method in class org.avis.client.Notification

clone() - Method in class org.avis.security.SHA1

Clones this object.

close() - Method in class org.avis.client.Elvin

Close the connection to the router.

close(Closeable) - Static method in class org.avis.util.Streams

Close an input stream.

CloseEvent - Class in org.avis.client

An event sent when the connection to the Elvin router is closed.

CloseEvent(Object, int, String, Throwable) - Constructor for class org.avis.client.CloseEvent

CloseListener - Interface in org.avis.client

A listener to the close event sent when the client's connection to the router is disconnected.

closeOnExit() - Method in class org.avis.client.Elvin

Signal that this connection should be automatically closed when the VM exits.

Collections - Class in org.avis.util

General collection utilities.

CommandLine - Class in org.avis.util

General command line utilities.

CommandLineOptions - Class in org.avis.util

A set of command line options.

CommandLineOptions() - Constructor for class org.avis.util.CommandLineOptions

Create a new instance.

CommandLineOptions(String...) - Constructor for class org.avis.util.CommandLineOptions

Create a new instance and immediately parse an array of command line options and create an option set.

Common - Class in org.avis.common

Common Avis definitions.

ConcurrentHashSet<K> - Class in org.avis.util

Concurrent hash set built on ConcurrentHashMap.

ConcurrentHashSet() - Constructor for class org.avis.util.ConcurrentHashSet

connectionClosed(CloseEvent) - Method in interface org.avis.client.CloseListener

Called when the connection to the Elvin router is closed.

ConnectionOptions - Class in org.avis.client

Connection options sent by the client to the server.

ConnectionOptions() - Constructor for class org.avis.client.ConnectionOptions

Create an empty instance.

connectionOptions() - Method in class org.avis.client.Elvin

The connection options established with the router.

connectionOptions - Variable in class org.avis.client.ElvinOptions

The options sent to the router to negotiate connection parameters.

ConnectionOptionsException - Exception in org.avis.client

Thrown when the Elvin client receives a rejection of one or more requested connection options.

consumer - Variable in class org.avis.security.KeyScheme

True of this scheme is a consumer scheme.

contains(Object) - Method in class org.avis.util.ConcurrentHashSet

containsAll(Collection<?>) - Method in class org.avis.util.ConcurrentHashSet

D

data - Variable in class org.avis.security.Key

The key's data block.

dataToBytes(byte[]) - Static method in class org.avis.util.Text

Turn a data block expression into a block of bytes.

decode(ByteBuffer) - Static method in class org.avis.security.Keys

DEFAULT_PORT - Static variable in class org.avis.common.Common

defaultProtocol() - Static method in class org.avis.common.ElvinURI

The default URI protocol stack: "tcp", "none", "xdr"

delta(Keys, Keys) - Method in class org.avis.security.Keys

Create a new key collection with some keys added/removed.

deltaFrom(Keys) - Method in class org.avis.security.Keys

Compute the changes between one key collection and another.

difference(Set<T>, Set<T>) - Static method in class org.avis.util.Collections

Compute the difference between set1 and set2.

DualKeyScheme - Class in org.avis.security

A key scheme that requires a pair of keys.

DualKeyScheme.Subset - Enum in org.avis.security

Specifies which of the two subsets of a dual scheme a key is part of: the producer subset (for sending notifications) or consumer subset (for receiving notifications).

E

Elvin - Class in org.avis.client

The core class in the Avis client library which manages a client's connection to an Elvin router.

Elvin(String) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

Elvin(String, ConnectionOptions) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

Elvin(ElvinURI) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

Elvin(ElvinURI, ConnectionOptions) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

Elvin(ElvinURI, Keys, Keys) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

Elvin(ElvinURI, ConnectionOptions, Keys, Keys) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

Elvin(String, ElvinOptions) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

Elvin(ElvinURI, ElvinOptions) - Constructor for class org.avis.client.Elvin

Create a new connection to an Elvin router.

elvin() - Method in class org.avis.client.ElvinLogEvent

The elvin client connection that fired the event.

elvin() - Method in class org.avis.client.GeneralNotificationEvent

The Elvin connection that the notification was received from.

elvin() - Method in class org.avis.client.Subscription

The elvin connection that created this subscription.

ElvinLogEvent - Class in org.avis.client

A logging event fired by an elvin client.

ElvinLogEvent(Elvin, ElvinLogEvent.Type, String, Throwable) - Constructor for class org.avis.client.ElvinLogEvent

ElvinLogEvent.Type - Enum in org.avis.client

ElvinLogListener - Interface in org.avis.client

A listener for messages logged by an elvin client.

ElvinOptions - Class in org.avis.client

Options for configuring an Elvin client connection.

ElvinOptions() - Constructor for class org.avis.client.ElvinOptions

ElvinOptions(ConnectionOptions, Keys, Keys) - Constructor for class org.avis.client.ElvinOptions

ElvinURI - Class in org.avis.common

An Elvin URI identifying an Elvin router as described in the "Elvin URI Scheme" specification at http://elvin.org/specs/draft-elvin-uri-prelim-02.txt.

ElvinURI(String) - Constructor for class org.avis.common.ElvinURI

Create a new instance.

ElvinURI(String, int) - Constructor for class org.avis.common.ElvinURI

Create a new instance from a host and port using defaults for others.

ElvinURI(String, ElvinURI) - Constructor for class org.avis.common.ElvinURI

Create a new instance using an existing URI for defaults.

ElvinURI(ElvinURI) - Constructor for class org.avis.common.ElvinURI

Create a copy of a URI.

EMPTY_DELTA - Static variable in class org.avis.security.Keys.Delta

EMPTY_KEYS - Static variable in class org.avis.security.Keys

An empty, immutable key collection.

EMPTY_OPTIONS - Static variable in class org.avis.client.ConnectionOptions

An immutable set of empty options.

encode(ByteBuffer) - Method in class org.avis.security.Keys

engineDigest() - Method in class org.avis.security.SHA1

Completes the hash computation by performing final operations such as padding.

engineDigest(byte[], int, int) - Method in class org.avis.security.SHA1

Completes the hash computation by performing final operations such as padding.

engineGetDigestLength() - Method in class org.avis.security.SHA1

Returns the digest length in bytes.

engineUpdate(byte) - Method in class org.avis.security.SHA1

Updates the digest using the specified byte.

engineUpdate(byte[], int, int) - Method in class org.avis.security.SHA1

Updates the digest using the specified array of bytes, starting at the specified offset.

entrySet() - Method in class org.avis.client.Notification

Get the fields/values of this notification as a unmodifiable, live set of java.util.Map.Entry's that can be iterated over.

eof(Reader) - Static method in class org.avis.util.Streams

Reader's and InputStream's (almost unbelievably) do not have a way to tell when the stream is at eof without modifying it.

equals(Object) - Method in class org.avis.client.Notification

equals(Notification) - Method in class org.avis.client.Notification

Compare two notifications.

equals(Object) - Method in class org.avis.common.ElvinURI

equals(ElvinURI) - Method in class org.avis.common.ElvinURI

equals(Object) - Method in class org.avis.security.Key

equals(Key) - Method in class org.avis.security.Key

equals(Object) - Method in class org.avis.security.Keys

equals(Keys) - Method in class org.avis.security.Keys

equals(Object) - Method in class org.avis.security.KeyScheme

error - Variable in class org.avis.client.CloseEvent

The exception that was associated with the reason for closing.

escapeField(String) - Static method in class org.avis.client.Subscription

Escape illegal characters in a field name for use in a subscription expression.

escapeString(String) - Static method in class org.avis.client.Subscription

Escape illegal characters in a string value for use in a subscription expression.

exception - Variable in class org.avis.client.ElvinLogEvent

The exception that triggered the message, if any (or null).

expandBackslashes(String) - Static method in class org.avis.util.Text

Expand C-like backslash codes such as \n \x90 etc into their literal values.

expression - Variable in exception org.avis.client.InvalidSubscriptionException

The subscription expression that was rejected.

F

fileStream(File) - Static method in class org.avis.util.Streams

Open an input stream on a file.

fileStream(String) - Static method in class org.avis.util.Streams

Open an input stream on a file.

Filter<T> - Interface in org.avis.util

A filter that selects values of the generic type T.

findFirstNonEscaped(String, char) - Static method in class org.avis.util.Text

Find the first index of the given character, skipping instances that are escaped by '\'.

findFirstNonEscaped(String, int, char) - Static method in class org.avis.util.Text

Find the first index of the given character, skipping instances that are escaped by '\'.

fire(Object) - Method in class org.avis.util.ListenerList

Fire an event.

fire(Object...) - Method in class org.avis.util.ListenerList

Fire an event.

formatNotification(Map<String, Object>) - Static method in class org.avis.util.Text

Generate a string value of the notification.

G

GeneralNotificationEvent - Class in org.avis.client

A notification event sent to Elvin subscription listeners.

GeneralNotificationListener - Interface in org.avis.client

A listener to notifications received by any subscription created by an elvin connection.

get(String) - Method in class org.avis.client.ConnectionOptions

Get the value for a connection option, or null if not defined.

get(String) - Method in class org.avis.client.Notification

Get a field value.

getBoolean(String) - Method in class org.avis.client.ConnectionOptions

Get a boolean value.

getBoolean(String, boolean) - Method in class org.avis.client.ConnectionOptions

Get a boolean value.

getData(String) - Method in class org.avis.client.AvisEventObject

Get some data previously associated with the event.

getDouble(String) - Method in class org.avis.client.Notification

Get a double value.

getIndent() - Method in class org.avis.util.IndentingWriter

Get the current indent level.

getIndentIncr() - Method in class org.avis.util.IndentingWriter

Get the amount of spaces to increment the indent level by when using IndentingWriter.indent().

getInt(String) - Method in class org.avis.client.ConnectionOptions

Get an integer value.

getInt(String, int) - Method in class org.avis.client.ConnectionOptions

Get an integer value.

getInt(String) - Method in class org.avis.client.Notification

Get an integer value.

getLong(String) - Method in class org.avis.client.Notification

Get a long value.

getOpaque(String) - Method in class org.avis.client.Notification

Get an opaque byte array value.

getString(String) - Method in class org.avis.client.ConnectionOptions

Get a string value.

getString(String, String) - Method in class org.avis.client.ConnectionOptions

Get a string value.

getString(String) - Method in class org.avis.client.Notification

Get a string value.

H

handleError(String, String, Exception) - Static method in class org.avis.util.CommandLineOptions

Handle an error in parsing command line options or starting the command line application by printing an error on the console and exiting the VM with an error code.

hasField(String) - Method in class org.avis.client.Notification

Test if this notification has a field with a given name.

hash(byte[]) - Method in enum org.avis.security.SecureHash

Perform the hash scheme on an input byte array.

hashCode() - Method in class org.avis.client.Notification

hashCode() - Method in class org.avis.common.ElvinURI

hashCode() - Method in class org.avis.security.Key

hashCode() - Method in class org.avis.security.Keys

hashCode() - Method in class org.avis.security.KeyScheme

hasListeners() - Method in class org.avis.client.Subscription

True if any listeners are in the listener list.

hasListeners() - Method in class org.avis.util.ListenerList

Test if any listeners are in this list.

hasSubscription(Subscription) - Method in class org.avis.client.Elvin

Test if a given subscription is part of this connection.

hexToByte(String) - Static method in class org.avis.util.Text

Parse a string expression as a hex-coded unsigned byte.

hexToBytes(String) - Static method in class org.avis.util.Text

Parse a series of hex pairs as a sequence of unsigned bytes.

highestPrecision(Class<? extends Number>, Class<? extends Number>) - Static method in class org.avis.util.Numbers

Return the highest precision (class with the largest range) of two classes.

host - Variable in class org.avis.common.ElvinURI

The host name.

I

id - Variable in class org.avis.security.KeyScheme

The unique ID of the scheme.

idFor(Object) - Static method in class org.avis.util.Text

Generate a hex ID for an object.

IllegalCommandLineOption - Exception in org.avis.util

IllegalCommandLineOption(String) - Constructor for exception org.avis.util.IllegalCommandLineOption

IllegalCommandLineOption(String, String) - Constructor for exception org.avis.util.IllegalCommandLineOption

IllegalConfigOptionException - Exception in org.avis.util

Thrown when an illegal option name or value is used in a configuration.

IllegalConfigOptionException(String) - Constructor for exception org.avis.util.IllegalConfigOptionException

IllegalConfigOptionException(String, String) - Constructor for exception org.avis.util.IllegalConfigOptionException

includeLegacy(boolean) - Method in class org.avis.client.ConnectionOptions

Enable legacy connection option compatibility (default is enabled).

indent() - Method in class org.avis.util.IndentingWriter

Increment the indent level by IndentingWriter.getIndentIncr() spaces.

indent(int) - Method in class org.avis.util.IndentingWriter

IndentingWriter - Class in org.avis.util

A PrintWriter that provides auto indented output.

IndentingWriter(OutputStream) - Constructor for class org.avis.util.IndentingWriter

IndentingWriter(Writer) - Constructor for class org.avis.util.IndentingWriter

indentln() - Method in class org.avis.util.IndentingWriter

Increment indent and start a new line.

insecureMatches - Variable in class org.avis.client.GeneralNotificationEvent

The subscriptions that insecurely matched the notification.

insecureMatches() - Method in class org.avis.client.GeneralNotificationEvent

Deprecated. Since release 1.1, use GeneralNotificationEvent.insecureMatches instead.

intArg(String[], int) - Static method in class org.avis.util.CommandLine

Get an integer argument from a given index, throwing a descriptive exception if the argument is missing or not a number.

InvalidFormatException - Exception in org.avis.util

Thrown when a parsing process detects some sort of invalid format in its input.

InvalidFormatException(String) - Constructor for exception org.avis.util.InvalidFormatException

InvalidSubscriptionException - Exception in org.avis.client

Thrown when a subscription parse error is detected by the router.

InvalidURIException - Exception in org.avis.common

Unchecked invalid URI exception.

InvalidURIException(String, String) - Constructor for exception org.avis.common.InvalidURIException

InvalidURIException(URISyntaxException) - Constructor for exception org.avis.common.InvalidURIException

isActive() - Method in class org.avis.client.Subscription

Test if this subscription is still able to receive notifications.

isDual() - Method in class org.avis.security.KeyScheme

True if the scheme requires dual key sets.

isEmpty() - Method in class org.avis.client.Notification

True if size () == 0.

isEmpty() - Method in class org.avis.security.Keys.Delta

isEmpty() - Method in class org.avis.security.Keys

True if no keys are in the collection.

isEmpty() - Method in class org.avis.util.ConcurrentHashSet

isNull() - Method in class org.avis.util.WildcardFilter

isOpen() - Method in class org.avis.client.Elvin

Test if this connection is open i.e.

isSecure() - Method in class org.avis.common.ElvinURI

True if this URI specifies secure TLS transport (protocol.equals (secureProtocol ())).

item1 - Variable in class org.avis.util.Pair

item2 - Variable in class org.avis.util.Pair

iterator() - Method in class org.avis.client.Notification

Create an iterator over this notification.

iterator() - Method in class org.avis.util.ConcurrentHashSet

J

join(StringBuilder, Iterable<?>, char) - Static method in class org.avis.util.Collections

Join a collection of items with a separator and append to a string builder.

join(Object[]) - Static method in class org.avis.util.Text

Join a list of objects into a string.

join(Object[], String) - Static method in class org.avis.util.Text

Join a list of objects into a string.

join(List<?>, String) - Static method in class org.avis.util.Text

Join a list of objects into a string.

K

K - Static variable in class org.avis.common.Common

Key - Class in org.avis.security

A key value used to secure notifications.

Key(String) - Constructor for class org.avis.security.Key

Create a key from a password by using the password's UTF-8 representation as the data block.

Key(byte[]) - Constructor for class org.avis.security.Key

Create a key from a block of data.

keyHash - Variable in class org.avis.security.KeyScheme

The secure hash used in this scheme.

keys() - Method in class org.avis.client.Subscription

The keys used to receive secure notifications.

Keys - Class in org.avis.security

A key collection used to secure notifications.

Keys() - Constructor for class org.avis.security.Keys

Keys(Keys) - Constructor for class org.avis.security.Keys

Keys.Delta - Class in org.avis.security

Represents a delta (diff) between two key sets.

KeyScheme - Class in org.avis.security

An enumeration of supported Elvin security schemes.

keystore - Variable in class org.avis.client.ElvinOptions

The keystore used for TLS/SSL secure connections (i.e.

keystorePassphrase - Variable in class org.avis.client.ElvinOptions

The passphrase used to secure the keystore and its keys.

L

list(E...) - Static method in class org.avis.util.Collections

Create an immutable list from a number of items.

ListenerList<E> - Class in org.avis.util

A generic event listener list.

ListenerList(Class<E>, String, Class<?>) - Constructor for class org.avis.util.ListenerList

Create a new instance.

ListenerList(Class<E>, String, Class<?>...) - Constructor for class org.avis.util.ListenerList

Create a new instance.

livenessTimeout() - Method in class org.avis.client.Elvin

livenessTimeout - Variable in class org.avis.client.ElvinOptions

The liveness timeout period (in milliseconds).

M

map(E...) - Static method in class org.avis.util.Collections

Create an immutable map from a number of item pairs: even items are keys, their adjacent items are values.

mapToString(Map<?, ?>) - Static method in class org.avis.util.Text

Generate human friendly string dump of a Map.

match(Keys) - Method in class org.avis.security.Keys

Test whether a given key collection matches this one for the purpose of notification delivery.

MATCH_ALL - Static variable in interface org.avis.util.Filter

Matches nothing.

MATCH_NONE - Static variable in interface org.avis.util.Filter

Matches anything.

matches - Variable in class org.avis.client.GeneralNotificationEvent

All subscriptions that matched the notification.

matches() - Method in class org.avis.client.GeneralNotificationEvent

Deprecated. Since release 1.1, use GeneralNotificationEvent.matches instead.

matches(T) - Method in interface org.avis.util.Filter

Test if the filter matches.

matches(String) - Method in class org.avis.util.WildcardFilter

MAX - Static variable in class org.avis.common.Common

MB - Static variable in class org.avis.common.Common

message - Variable in class org.avis.client.CloseEvent

The message from the router, if any, or the client's description of the reason otherwise.

message - Variable in class org.avis.client.ElvinLogEvent

The message text.

messageLogged(ElvinLogEvent) - Method in interface org.avis.client.ElvinLogListener

Called when a message is logged by the elvin client.

mutex() - Method in class org.avis.client.Elvin

Return the mutex used to synchronize access to this connection.

N

name - Variable in class org.avis.security.KeyScheme

The unique, human-readable name of this scheme.

names() - Method in class org.avis.client.Notification

The set of names in the notification.

NotConnectedException - Exception in org.avis.client

Thrown when an operation that requires a connection to the router is attempted on a closed connection.

NotConnectedException(String) - Constructor for exception org.avis.client.NotConnectedException

notification - Variable in class org.avis.client.GeneralNotificationEvent

The notification.

Notification - Class in org.avis.client

A notification sent via an Elvin router.

Notification() - Constructor for class org.avis.client.Notification

Create an empty notification.

Notification(Object...) - Constructor for class org.avis.client.Notification

Create a notification from an array of name/value pairs.

Notification(Map<?, ?>) - Constructor for class org.avis.client.Notification

Create a notification from the values in a map.

Notification(String) - Constructor for class org.avis.client.Notification

Create an instance from an string encoded notification.

Notification(Reader) - Constructor for class org.avis.client.Notification

Create an instance from an encoded notification read from a stream.

notification - Variable in class org.avis.client.NotificationEvent

The notification received from the router.

NotificationEvent - Class in org.avis.client

A notification event sent to subscription listeners.

notificationKeys() - Method in class org.avis.client.Elvin

notificationKeys - Variable in class org.avis.client.ElvinOptions

The global notification keys that apply to all notifications.

NotificationListener - Interface in org.avis.client

A listener to notifications from a subscription.

notificationReceived(GeneralNotificationEvent) - Method in interface org.avis.client.GeneralNotificationListener

Called when a notification is received.

notificationReceived(NotificationEvent) - Method in interface org.avis.client.NotificationListener

Called when a notification is received on a subscription.

Numbers - Class in org.avis.util

General utility functions for messing with numbers.

O

options - Variable in exception org.avis.client.ConnectionOptionsException

The requested options

options() - Method in class org.avis.client.Elvin

Return the current options for the connection.

options - Variable in class org.avis.common.ElvinURI

The URI options.

org.avis.client - package org.avis.client

org.avis.common - package org.avis.common

org.avis.security - package org.avis.security

org.avis.util - package org.avis.util

P

Pair<T1,T2> - Class in org.avis.util

A pair items.

Pair(T1, T2) - Constructor for class org.avis.util.Pair

parse(Notification, Reader) - Static method in class org.avis.client.Notification

Parse an expression representing a notification and populate the given notification with the values.

port - Variable in class org.avis.common.ElvinURI

The port.

println() - Method in class org.avis.util.IndentingWriter

producer - Variable in class org.avis.security.KeyScheme

True if this scheme is a producer scheme.

propertiesFrom(InputStream) - Static method in class org.avis.util.Streams

Load a set of java.util.Properties from an input stream and close it.

protocol - Variable in class org.avis.common.ElvinURI

The stack of protocol modules in (transport,security,marshalling) order.

publicKeyFor(KeyScheme) - Method in class org.avis.security.Key

Shortcut to generate the public (prime) key for a given scheme.

publicKeyFor(Key) - Method in class org.avis.security.KeyScheme

Create the public (aka prime) key for a given private (aka raw) key using this scheme's hash.

Q

quotedStringToString(String) - Static method in class org.avis.util.Text

Parse a string value in the format "string", allowing escaped "'s inside the string.

R

readLine(Reader) - Static method in class org.avis.util.Streams

Read a line from a Reader.

reason - Variable in class org.avis.client.CloseEvent

The reason for the shutdown: CloseEvent.REASON_CLIENT_SHUTDOWN, CloseEvent.REASON_ROUTER_SHUTDOWN, CloseEvent.REASON_ROUTER_SHUTDOWN_UNEXPECTEDLY, CloseEvent.REASON_ROUTER_STOPPED_RESPONDING, CloseEvent.REASON_PROTOCOL_VIOLATION, CloseEvent.REASON_IO_ERROR.

reason - Variable in exception org.avis.client.InvalidSubscriptionException

The reason the expression was rejected: one of InvalidSubscriptionException.SYNTAX_ERROR or InvalidSubscriptionException.TRIVIAL_EXPRESSION.

REASON_CLIENT_SHUTDOWN - Static variable in class org.avis.client.CloseEvent

The client was shut down normally with a call to Elvin.close().

REASON_IO_ERROR - Static variable in class org.avis.client.CloseEvent

An I/O exception was thrown while communicating with the router.

REASON_PROTOCOL_VIOLATION - Static variable in class org.avis.client.CloseEvent

Either the client or the router decided that the protocol rules have been violated.

REASON_ROUTER_SHUTDOWN - Static variable in class org.avis.client.CloseEvent

The router was shut down normally.

REASON_ROUTER_SHUTDOWN_UNEXPECTEDLY - Static variable in class org.avis.client.CloseEvent

The network connection to the router was terminated abnormally without the standard shutdown protocol.

REASON_ROUTER_STOPPED_RESPONDING - Static variable in class org.avis.client.CloseEvent

The router failed to respond to a liveness check.

receiveTimeout() - Method in class org.avis.client.Elvin

receiveTimeout - Variable in class org.avis.client.ElvinOptions

The amount of time (in milliseconds) that must pass before the router is assumed to not be responding to a request.

rejectedOptions - Variable in exception org.avis.client.ConnectionOptionsException

The rejected options and the actual value that the server will use.

remove(String) - Method in class org.avis.client.Notification

Remove (unset) a value.

remove() - Method in class org.avis.client.Subscription

Remove this subscription (unsubscribe).

remove(SingleKeyScheme, Key) - Method in class org.avis.security.Keys

Remove a key for single key scheme.

remove(DualKeyScheme, DualKeyScheme.Subset, Key) - Method in class org.avis.security.Keys

Remove a key for dual key scheme.

remove(Keys) - Method in class org.avis.security.Keys

Remove all keys in a collection.

remove(Object) - Method in class org.avis.util.ConcurrentHashSet

remove(E) - Method in class org.avis.util.ListenerList

removeAll(Collection<?>) - Method in class org.avis.util.ConcurrentHashSet

removeCloseListener(CloseListener) - Method in class org.avis.client.Elvin

Remove a previously added close listener.

removed - Variable in class org.avis.security.Keys.Delta

removeListener(NotificationListener) - Method in class org.avis.client.Subscription

Remove a previously added listener.

removeLogListener(ElvinLogListener) - Method in class org.avis.client.Elvin

Remove a previously added log listener.

removeNotificationListener(GeneralNotificationListener) - Method in class org.avis.client.Elvin

Remove a listener to all notifications received by all subscriptions of this connection.

require(String, Class<E>) - Method in class org.avis.client.Notification

Shortcut to get a non-null value of specified type, or generate an exception.

requireAuthenticatedServer - Variable in class org.avis.client.ElvinOptions

Used to ensure that the router the client is connected to is authentic.

resourceStream(String) - Static method in class org.avis.util.Streams

Open an input stream on a resource.

retainAll(Collection<?>) - Method in class org.avis.util.ConcurrentHashSet

RouterNackException - Exception in org.avis.client

An exception indicating the Elvin router rejected (NACK'd) one of the client's requests.

routerUri() - Method in class org.avis.client.Elvin

The router's URI.

RuntimeInterruptedException - Exception in org.avis.common

Like InterruptedException, but less annoying.

RuntimeInterruptedException(InterruptedException) - Constructor for exception org.avis.common.RuntimeInterruptedException

S

scheme - Variable in class org.avis.common.ElvinURI

The URI scheme (i.e the part before the ":").

schemeFor(int) - Static method in class org.avis.security.KeyScheme

Look up the scheme for a given ID.

schemes() - Static method in class org.avis.security.KeyScheme

The set of all supported schemes.

secure - Variable in class org.avis.client.NotificationEvent

True if the notification was received securely from a client with compatible security keys.

SecureHash - Enum in org.avis.security

An enumeration of supported secure hash algorithms.

secureMatches - Variable in class org.avis.client.GeneralNotificationEvent

The subscriptions that securely matched the notification.

secureMatches() - Method in class org.avis.client.GeneralNotificationEvent

Deprecated. Since release 1.1, use GeneralNotificationEvent.secureMatches instead.

SecureMode - Enum in org.avis.client

Specifies the secure delivery mode for notifications.

secureMode() - Method in class org.avis.client.Subscription

The secure mode specified for receipt of notifications.

secureProtocol() - Static method in class org.avis.common.ElvinURI

The secure URI protocol stack: "ssl", "none", "xdr"

send(Notification) - Method in class org.avis.client.Elvin

Send a notification.

send(Notification, Keys) - Method in class org.avis.client.Elvin

Send a notification with a set of keys but with no requirement for secure delivery: use send (notification, REQUIRE_SECURE_DELIVERY, keys) if you want only subscriptions with matching keys to receive a notification.

send(Notification, SecureMode) - Method in class org.avis.client.Elvin

Send a notification with a specified security mode.

send(Notification, Keys, SecureMode) - Method in class org.avis.client.Elvin

Send a notification.

set(String, Object) - Method in class org.avis.client.ConnectionOptions

Set a connection option.

set(String, int) - Method in class org.avis.client.ConnectionOptions

Set an integer value.

set(String, boolean) - Method in class org.avis.client.ConnectionOptions

Set a boolean value.

set(String, String) - Method in class org.avis.client.ConnectionOptions

Set a string value.

set(String, Object) - Method in class org.avis.client.Notification

Set a field value.

set(String, int) - Method in class org.avis.client.Notification

Set an integer value.

set(String, long) - Method in class org.avis.client.Notification

Set a long value.

set(String, double) - Method in class org.avis.client.Notification

Set a double value.

set(String, String) - Method in class org.avis.client.Notification

Set a string value.

set(String, byte[]) - Method in class org.avis.client.Notification

Set an opaque byte array value.

set(E...) - Static method in class org.avis.util.Collections

Create an immutable set from a number of items.

setAll(Map<String, Object>) - Method in class org.avis.client.ConnectionOptions

Set a number of options at once.

setAll(Map<?, ?>) - Method in class org.avis.client.Notification

Copy all values in a map into this notification.

setData(String, Object) - Method in class org.avis.client.AvisEventObject

Set some generic data associated with the event.

setIndent(int) - Method in class org.avis.util.IndentingWriter

Set the current indent level.

setIndentIncr(int) - Method in class org.avis.util.IndentingWriter

Set the amount of spaces to increment the indent level by when using IndentingWriter.indent().

setKeys(Keys, Keys) - Method in class org.avis.client.Elvin

Change the connection-wide keys used to secure the receipt and delivery of notifications.

setKeys(Keys) - Method in class org.avis.client.Subscription

Change the keys used for receiving secure notifications.

setKeystore(String, String) - Method in class org.avis.client.ElvinOptions

Shortcut to load a keystore from a Java keystore file.

setKeystore(URL, String) - Method in class org.avis.client.ElvinOptions

Shortcut to load a keystore from a Java keystore file.

setLivenessTimeout(long) - Method in class org.avis.client.Elvin

Set the liveness timeout period (default is 60 seconds).

setNotificationKeys(Keys) - Method in class org.avis.client.Elvin

Set the connection-wide notification keys used to secure delivery of notifications.

setReceiveTimeout(long) - Method in class org.avis.client.Elvin

Set the amount of time that must pass before the router is assumed not to be responding to a request message (default is 10 seconds).

setSecureMode(SecureMode) - Method in class org.avis.client.Subscription

Change the subscription's secure delivery requirement.

setSubscriptionExpr(String) - Method in class org.avis.client.Subscription

Change the subscription expression.

setSubscriptionKeys(Keys) - Method in class org.avis.client.Elvin

Set the connection-wide subscription keys used to secure receipt of notifications.

SHA1 - Class in org.avis.security

Implements the SHA-1 secure hash algorithm.

SHA1() - Constructor for class org.avis.security.SHA1

Creates a SHA1 object with default initial state.

SHA1(SHA1) - Constructor for class org.avis.security.SHA1

Creates a SHA1 object with state (for cloning).

SHA1_CONSUMER - Static variable in class org.avis.security.KeyScheme

The SHA-1 Consumer key scheme.

SHA1_DUAL - Static variable in class org.avis.security.KeyScheme

The SHA-1 Dual key scheme.

SHA1_PRODUCER - Static variable in class org.avis.security.KeyScheme

The SHA-1 Producer key scheme.

shortException(Throwable) - Static method in class org.avis.util.Text

Generate a short exception message without package name and message (if null).

SingleKeyScheme - Class in org.avis.security

A key scheme that requires a single key set.

size() - Method in class org.avis.client.Notification

The number of name/value pairs in the notification.

size() - Method in class org.avis.security.Keys

Return the total number of keys in this key collection.

size() - Method in class org.avis.util.ConcurrentHashSet

slice(byte[], int, int) - Static method in class org.avis.util.Text

split(String) - Static method in class org.avis.util.Text

Shortcut to execute split on any whitespace character.

split(String, String) - Static method in class org.avis.util.Text

String.split ("") returns {""} rather than {} like you might expect: this returns empty array on "".

Streams - Class in org.avis.util

General utilities for messing with I/O streams.

stringArg(String[], int) - Static method in class org.avis.util.CommandLine

Get a string argument from a given index, throwing a descriptive exception if the argument is missing.

stringFrom(InputStream) - Static method in class org.avis.util.Streams

Read the entirety of a UTF-8 encoded input stream into a string.

stringFrom(Reader) - Static method in class org.avis.util.Streams

Read the entirety of stream into a string.

stringToNumber(String) - Static method in class org.avis.util.Text

Parse a numeric int, long or double value.

stringToOpaque(String) - Static method in class org.avis.util.Text

Parse an opaque value expression e.g.

stringToValue(String) - Static method in class org.avis.util.Text

Parse a string expression as a value.

stripBackslashes(String) - Static method in class org.avis.util.Text

Remove any \'s from a string.

subscribe(String) - Method in class org.avis.client.Elvin

Create a new subscription.

subscribe(String, Keys) - Method in class org.avis.client.Elvin

Create a new subscription with a given set of security keys to enable secure delivery, but also allowing insecure notifications.

subscribe(String, SecureMode) - Method in class org.avis.client.Elvin

Create a new subscription with a given security mode but with an empty key set.

subscribe(String, Keys, SecureMode) - Method in class org.avis.client.Elvin

Create a new subscription.

subscription - Variable in class org.avis.client.NotificationEvent

The subscription that matched the notification.

Subscription - Class in org.avis.client

A subscription to notifications from an Elvin connection.

subscriptionExpr() - Method in class org.avis.client.Subscription

The subscription expression.

subscriptionKeys() - Method in class org.avis.client.Elvin

subscriptionKeys - Variable in class org.avis.client.ElvinOptions

The global subscription keys that apply to all subscriptions.

SYNTAX_ERROR - Static variable in exception org.avis.client.InvalidSubscriptionException

Rejection code indicating there was a syntax error that prevented parsing.

T

Text - Class in org.avis.util

General text formatting utilities.

toArray() - Method in class org.avis.util.ConcurrentHashSet

toArray(T[]) - Method in class org.avis.util.ConcurrentHashSet

toCanonicalString() - Method in class org.avis.common.ElvinURI

Generate a canonical text version of this URI.

toPattern(String) - Static method in class org.avis.util.Wildcard

Generate a patten matcher for a wildcard expression.

toPattern(String, int) - Static method in class org.avis.util.Wildcard

Generate a patten matcher for a wildcard expression.

toString() - Method in class org.avis.client.Notification

Generate a string value of the notification.

toString() - Method in class org.avis.common.ElvinURI

toString() - Method in class org.avis.security.KeyScheme

toString() - Method in class org.avis.util.IndentingWriter

Make it easier for StringWriter users.

TRIVIAL_EXPRESSION - Static variable in exception org.avis.client.InvalidSubscriptionException

Rejection code indicating the expression was constant.

type - Variable in class org.avis.client.ElvinLogEvent

The type of message.

U

unindent() - Method in class org.avis.util.IndentingWriter

Reverse the effect of an IndentingWriter.indent().

unindent(int) - Method in class org.avis.util.IndentingWriter

union(Set<T>, Set<T>) - Static method in class org.avis.util.Collections

Compute the union of set1 and set2.

union(Map<K, V>, Map<K, V>) - Static method in class org.avis.util.Collections

Compute the union of map1 and map2.

upconvert(Number, Class<? extends Number>) - Static method in class org.avis.util.Numbers

Convert a numeric value upwards to a given type.

uriString - Variable in class org.avis.common.ElvinURI

The original URI string as passed into the constructor.

Util - Class in org.avis.util

General Avis utility functions.

V

valueOf(String) - Static method in enum org.avis.client.ElvinLogEvent.Type

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

valueOf(String) - Static method in enum org.avis.client.SecureMode

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

valueOf(String) - Static method in enum org.avis.security.DualKeyScheme.Subset

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

valueOf(String) - Static method in enum org.avis.security.SecureHash

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

values() - Static method in enum org.avis.client.ElvinLogEvent.Type

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

values() - Method in class org.avis.client.Notification

The set of values in the notification.

values() - Static method in enum org.avis.client.SecureMode

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

values() - Static method in enum org.avis.security.DualKeyScheme.Subset

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

values() - Static method in enum org.avis.security.SecureHash

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

valuesEqual(Object, Object) - Static method in class org.avis.util.Util

Test if two objects are equal, handling null values and type differences.

versionMajor - Variable in class org.avis.common.ElvinURI

Major protocol version.

versionMinor - Variable in class org.avis.common.ElvinURI

Minor protocol version.

W

Wildcard - Class in org.avis.util

Generates regex patterns that match Unix-style wildcards * and ?.

WildcardFilter - Class in org.avis.util

A filter that matches strings against wildcard patterns.

WildcardFilter(String) - Constructor for class org.avis.util.WildcardFilter

WildcardFilter(String...) - Constructor for class org.avis.util.WildcardFilter

WildcardFilter(Collection<String>) - Constructor for class org.avis.util.WildcardFilter

write(int) - Method in class org.avis.util.IndentingWriter

write(char[], int, int) - Method in class org.avis.util.IndentingWriter

write(String, int, int) - Method in class org.avis.util.IndentingWriter

A B C D E F G H I J K L M N O P Q R S T U V W