JGDMS Project 3.0-SNAPSHOT API Documentation

Skip navigation links
A B C D E F G H J L M O P R S T U W 

A

accept(File) - Method in class org.apache.river.system.JavaSourceFilter
Method required by FilenameFilter interface.
add(Class) - Method in class org.apache.river.api.lookup.DefaultEntries
Add an Entry class.
addPlatformEntries() - Method in class org.apache.river.api.lookup.DefaultEntries
All all the Jini Platform Entry's
applyUpdate(Object) - Method in class org.apache.river.reliableLog.LogHandler
Reads a stably logged update (a serializable object) from a stream.
available() - Method in class org.apache.river.reliableLog.LogInputStream
Returns the number of bytes that can be read without blocking.

B

BadInvocationException(Object) - Constructor for exception org.apache.river.system.CommandLine.BadInvocationException
Create an "Argument required" exception for the given option.
BadInvocationException(String) - Constructor for exception org.apache.river.system.CommandLine.BadInvocationException
Create an exception with the given detail string.

C

close() - Method in class org.apache.river.reliableLog.LogInputStream
Closes the input stream.
close() - Method in class org.apache.river.reliableLog.LogOutputStream
A LogOutputStream cannot be closed, so this does nothing.
close() - Method in class org.apache.river.reliableLog.ReliableLog
Closes the stable storage directory in an orderly manner.
CommandLine - Class in org.apache.river.system
CommandLine is a base class for command line parsing classes.
CommandLine() - Constructor for class org.apache.river.system.CommandLine
 
CommandLine.BadInvocationException - Exception in org.apache.river.system
Signal that the user specified an option in an improper way.
CommandLine.HelpOnlyException - Exception in org.apache.river.system
Signal that this was a "help only" invocation.
CommandLine.ProgrammingException - Exception in org.apache.river.system
Signal that the programmer has invoked a method out of order.

D

DefaultEntries - Class in org.apache.river.api.lookup
A little builder utility class that creates an array of Entry classes to be used as a parameter for StreamServiceRegistrar.
DefaultEntries() - Constructor for class org.apache.river.api.lookup.DefaultEntries
 
deletePersistentStore() - Method in class org.apache.river.reliableLog.ReliableLog
Closes the incremental update log file, removes all ReliableLog-related files from the stable storage directory, and deletes the directory.
destroy(File, boolean) - Static method in class org.apache.river.system.FileSystem
Remove this completely.
detail - Variable in exception org.apache.river.reliableLog.LogException
 

E

ensureDir(String) - Static method in class org.apache.river.system.FileSystem
Ensure that the given path is a directory, creating it if necessary.
equals(Object) - Method in class org.apache.river.api.lookup.DefaultEntries
 

F

FileObserver - Class in org.apache.river.system
Observer class that gets notified when a change has been noted, that is a file has been found, by an Observable object.
FileObserver(String) - Constructor for class org.apache.river.system.FileObserver
Constructor that allows the user to specify interest in a particular suffix.
FileSystem - Class in org.apache.river.system
Miscellaneous file system manipulation methods.
FileSystem() - Constructor for class org.apache.river.system.FileSystem
 
FileWalker - Class in org.apache.river.system
Class to recursively traverse a given directory.
FileWalker() - Constructor for class org.apache.river.system.FileWalker
 
finalize() - Method in class org.apache.river.reliableLog.LogInputStream
Closes the stream when garbage is collected.

G

getBoolean(String) - Method in class org.apache.river.system.MultiCommandLine
Return true if the given option is specified on the command line.
getBoolean(char) - Method in class org.apache.river.system.POSIXCommandLine
Return true if the given option is specified on the command line.
getDouble(String, double) - Method in class org.apache.river.system.MultiCommandLine
Return the value of the given double from the command line.
getDouble(char, double) - Method in class org.apache.river.system.POSIXCommandLine
Return the value of the given double from the command line.
getEntries() - Method in class org.apache.river.api.lookup.DefaultEntries
Generate a new array containing all Entry's added since last reset.
getFileList() - Method in class org.apache.river.system.FileObserver
Get the complete list of found files.
getFileTimeList() - Method in class org.apache.river.system.FileObserver
Get the time stamps of the found files.
getInputStream(String, InputStream) - Method in class org.apache.river.system.MultiCommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given option.
getInputStream(String, String) - Method in class org.apache.river.system.MultiCommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given option.
getInputStream(char, InputStream) - Method in class org.apache.river.system.POSIXCommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given option.
getInputStream(char, String) - Method in class org.apache.river.system.POSIXCommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given option.
getInt(String, int) - Method in class org.apache.river.system.MultiCommandLine
Return the argument of the given int option from the command line.
getInt(char, int) - Method in class org.apache.river.system.POSIXCommandLine
Return the argument of the given int option from the command line.
getLong(String, long) - Method in class org.apache.river.system.MultiCommandLine
Return the argument of the given long option from the command line.
getLong(char, long) - Method in class org.apache.river.system.POSIXCommandLine
Return the argument of the given long option from the command line.
getMessage() - Method in exception org.apache.river.reliableLog.LogException
Produce the message; including the message from the nested exception if there is one.
getOperands() - Method in class org.apache.river.system.MultiCommandLine
Return the command line operands that come after the options.
getOperands() - Method in class org.apache.river.system.POSIXCommandLine
Return the command line operands that come after the options.
getOutputStream(String, OutputStream) - Method in class org.apache.river.system.MultiCommandLine
Return a OutputStream that is the result of creating a new FileOutputStream object for the file named by the given option.
getOutputStream(String, String) - Method in class org.apache.river.system.MultiCommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given option.
getOutputStream(char, OutputStream) - Method in class org.apache.river.system.POSIXCommandLine
Return a OutputStream that is the result of creating a new FileOutputStream object for the file named by the given option.
getOutputStream(char, String) - Method in class org.apache.river.system.POSIXCommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given option.
getRandomAccessFile(String, RandomAccessFile, String) - Method in class org.apache.river.system.MultiCommandLine
Return a RandomAccessFile that is the result of creating a new RandomAccessFile object for the file named by the given option, using the given mode.
getRandomAccessFile(String, String, String) - Method in class org.apache.river.system.MultiCommandLine
Return a RandomAccessFile that is the result of creating a new RandomAccessFile object for the file named by the given option, using the given mode.
getRandomAccessFile(char, RandomAccessFile, String) - Method in class org.apache.river.system.POSIXCommandLine
Return a RandomAccessFile that is the result of creating a new RandomAccessFile object for the file named by the given option, using the given mode.
getRandomAccessFile(char, String, String) - Method in class org.apache.river.system.POSIXCommandLine
Return a RandomAccessFile that is the result of creating a new RandomAccessFile object for the file named by the given option, using the given mode.
getReader(String, Reader) - Method in class org.apache.river.system.MultiCommandLine
Return a Reader that is the result of creating a new FileReader object for the file named by the given option.
getReader(String, String) - Method in class org.apache.river.system.MultiCommandLine
Return a Reader that is the result of creating a new FileReader object for the file named by the given option.
getReader(char, Reader) - Method in class org.apache.river.system.POSIXCommandLine
Return a Reader that is the result of creating a new FileReader object for the file named by the given option.
getReader(char, String) - Method in class org.apache.river.system.POSIXCommandLine
Return a Reader that is the result of creating a new FileReader object for the file named by the given option.
getString(String, String) - Method in class org.apache.river.system.MultiCommandLine
Return the argument of the given string option from the command line.
getString(char, String) - Method in class org.apache.river.system.POSIXCommandLine
Return the argument of the given string option from the command line.
getWriter(String, Writer) - Method in class org.apache.river.system.MultiCommandLine
Return a Writer that is the result of creating a new FileWriter object for the file named by the given option.
getWriter(String, String) - Method in class org.apache.river.system.MultiCommandLine
Return a Writer that is the result of creating a new FileWriter object for the file named by the given option.
getWriter(char, Writer) - Method in class org.apache.river.system.POSIXCommandLine
Return a Writer that is the result of creating a new FileWriter object for the file named by the given option.
getWriter(char, String) - Method in class org.apache.river.system.POSIXCommandLine
Return a Writer that is the result of creating a new FileWriter object for the file named by the given option.

H

hashCode() - Method in class org.apache.river.api.lookup.DefaultEntries
 
HelpOnlyException() - Constructor for exception org.apache.river.system.CommandLine.HelpOnlyException
Create a new HelpOnlyException with a descriptive string.

J

JavaSourceFilter - Class in org.apache.river.system
Implementation of FilenameFilter to allow us to just look for java files by default, or other file extensions if the user wishes to use a different extension.
JavaSourceFilter() - Constructor for class org.apache.river.system.JavaSourceFilter
Create a filter for *.java files.
JavaSourceFilter(String) - Constructor for class org.apache.river.system.JavaSourceFilter
Create a filter for a user defined extension.

L

LifeCycle - Interface in org.apache.river.start.lifecycle
The interface used to manage the lifecycle of shared, non-activatable services started by the service starter.
LogException - Exception in org.apache.river.reliableLog
This class can be used to represent all exceptional conditions that occur during any logging process.
LogException() - Constructor for exception org.apache.river.reliableLog.LogException
Create a wrapper exception for exceptions that occur during a logging operation.
LogException(String) - Constructor for exception org.apache.river.reliableLog.LogException
For exceptions that occur during a logging operation, create a wrapper exception with the specified description string.
LogException(String, Throwable) - Constructor for exception org.apache.river.reliableLog.LogException
For exceptions that occur during a logging operation, create a wrapper exception with the specified description string and the specified nested exception.
LogHandler - Class in org.apache.river.reliableLog
A LogHandler represents snapshots and update records as serializable objects.
LogHandler() - Constructor for class org.apache.river.reliableLog.LogHandler
Creates a LogHandler for a ReliableLog.
LogInputStream - Class in org.apache.river.reliableLog
This class extends the functionality of the java.io.InputStream class in order to provide an input mechanism that can be used by processes that perform logging operations; in particular, processes that store state in order to provide persistence.
LogInputStream(InputStream, int) - Constructor for class org.apache.river.reliableLog.LogInputStream
Creates a log input file with the specified input stream.
LogOutputStream - Class in org.apache.river.reliableLog
This class extends the functionality of the java.io.OutputStream class in order to provide an output mechanism that can be used by processes that perform logging operations; in particular, processes that store state in order to provide persistence.
LogOutputStream(RandomAccessFile) - Constructor for class org.apache.river.reliableLog.LogOutputStream
Creates an output file with the specified RandomAccessFile
logSize() - Method in class org.apache.river.reliableLog.ReliableLog
Returns the current size of the incremental update log file in bytes;

M

MultiCommandLine - Class in org.apache.river.system
This class parses a command line that uses multi-character options, such as -verbose or -help.
MultiCommandLine(String[]) - Constructor for class org.apache.river.system.MultiCommandLine
Create a new MultiCommandLine object that will return specified options, arguments, and operands.
MultiCommandLine(String, String[]) - Constructor for class org.apache.river.system.MultiCommandLine
Create a new MultiCommandLine object that will return specified options, arguments, and operands.

O

org.apache.river.api.lookup - package org.apache.river.api.lookup
 
org.apache.river.reliableLog - package org.apache.river.reliableLog
Reliable log is used to store state in case of system crash or reboot.
org.apache.river.start.lifecycle - package org.apache.river.start.lifecycle
 
org.apache.river.system - package org.apache.river.system
Utility classes helping with interactions with the underlying system.

P

parseDouble(String, double) - Static method in class org.apache.river.system.CommandLine
Return the result of parsing the given double from the command line.
parseInputStream(String, InputStream) - Static method in class org.apache.river.system.CommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given path.
parseInputStream(String, String) - Static method in class org.apache.river.system.CommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given path.
parseInt(String, int) - Static method in class org.apache.river.system.CommandLine
Return the result of parsing the given int from the command line.
parseLong(String, long) - Static method in class org.apache.river.system.CommandLine
Return the result of parsing the given long from the command line.
parseOutputStream(String, OutputStream) - Static method in class org.apache.river.system.CommandLine
Return a OutputStream that is the result of creating a new FileOutputStream object for the file named by the given path.
parseOutputStream(String, String) - Static method in class org.apache.river.system.CommandLine
Return a InputStream that is the result of creating a new FileInputStream object for the file named by the given path.
parseRandomAccessFile(String, RandomAccessFile, String) - Static method in class org.apache.river.system.CommandLine
Return a RandomAccessFile that is the result of creating a new RandomAccessFile object for the file named by the given path, using the given mode.
parseRandomAccessFile(String, String, String) - Static method in class org.apache.river.system.CommandLine
Return a RandomAccessFile that is the result of creating a new RandomAccessFile object for the file named by the given path, using the given mode.
parseReader(String, Reader) - Static method in class org.apache.river.system.CommandLine
Return a Reader that is the result of creating a new FileReader object for the file named by the given path.
parseReader(String, String) - Static method in class org.apache.river.system.CommandLine
Return a Reader that is the result of creating a new FileReader object for the file named by the given path.
parseString(String, String) - Static method in class org.apache.river.system.CommandLine
Return the result of parsing the given string from the command line.
parseWriter(String, Writer) - Static method in class org.apache.river.system.CommandLine
Return a Writer that is the result of creating a new FileWriter object for the file named by the given path.
parseWriter(String, String) - Static method in class org.apache.river.system.CommandLine
Return a Writer that is the result of creating a new FileWriter object for the file named by the given path.
POSIXCommandLine - Class in org.apache.river.system
This class parses a command line using POSIX 1003.2-1992 rules.
POSIXCommandLine(String[]) - Constructor for class org.apache.river.system.POSIXCommandLine
Create a new CommandLine object that will return specified options, arguments, and operands.
POSIXCommandLine(String, String[]) - Constructor for class org.apache.river.system.POSIXCommandLine
Create a new CommandLine object that will return specified options, arguments, and operands.
ProgrammingException(String) - Constructor for exception org.apache.river.system.CommandLine.ProgrammingException
Create an exception with the given detail string.

R

read() - Method in class org.apache.river.reliableLog.LogInputStream
Reads a byte of data.
read(byte[]) - Method in class org.apache.river.reliableLog.LogInputStream
Reads data into an array of bytes.
read(byte[], int, int) - Method in class org.apache.river.reliableLog.LogInputStream
Reads data into an array of bytes.
readUpdate(InputStream) - Method in class org.apache.river.reliableLog.LogHandler
Reads a stably logged update (a serializable object) from a stream.
recover(InputStream) - Method in class org.apache.river.reliableLog.LogHandler
Read the snapshot from a stream.
recover() - Method in class org.apache.river.reliableLog.ReliableLog
Retrieves the contents of the snapshot file by calling the client supplied recover callback and then applies the incremental updates by calling the readUpdate callback for each logged updated.
ReliableLog - Class in org.apache.river.reliableLog
This class is a simple implementation of a reliable Log.
ReliableLog(String, LogHandler) - Constructor for class org.apache.river.reliableLog.ReliableLog
Creates a ReliableLog to handle snapshots and logging in a stable storage directory, and sets up to recover any existing data from the stable storage directory.
reset() - Method in class org.apache.river.api.lookup.DefaultEntries
Remove all Entry's

S

skip(long) - Method in class org.apache.river.reliableLog.LogInputStream
Skips n bytes of input.
snapshot(OutputStream) - Method in class org.apache.river.reliableLog.LogHandler
Writes the snapshot to a stream.
snapshot() - Method in class org.apache.river.reliableLog.ReliableLog
Records the client-defined current snapshot by invoking the client supplied snapshot callback, and then empties the log of incremental updates.
snapshotSize() - Method in class org.apache.river.reliableLog.ReliableLog
Returns the size of the current snapshot file in bytes;

T

toString() - Method in class org.apache.river.api.lookup.DefaultEntries
 

U

unregister(Object) - Method in interface org.apache.river.start.lifecycle.LifeCycle
Method invoked by a server to inform the LifeCycle object that it can release any resources associated with the server.
update(Object) - Method in class org.apache.river.reliableLog.ReliableLog
Records this update in the log file and forces the update to disk.
update(Object, boolean) - Method in class org.apache.river.reliableLog.ReliableLog
Records this update in the log file and optionally forces the update to disk.
update(Observable, Object) - Method in class org.apache.river.system.FileObserver
Called when an Observer monitors a change.
usage() - Method in class org.apache.river.system.MultiCommandLine
Print out a summary of the commands usage, inferred from the requested options.
usage() - Method in class org.apache.river.system.POSIXCommandLine
Print out a summary of the commands usage, inferred from the requested options.

W

walk(File, boolean) - Method in class org.apache.river.system.FileWalker
Method to call that starts the directory traversal.
write(int) - Method in class org.apache.river.reliableLog.LogOutputStream
Writes a byte of data.
write(byte[]) - Method in class org.apache.river.reliableLog.LogOutputStream
Writes an array of bytes.
write(byte[], int, int) - Method in class org.apache.river.reliableLog.LogOutputStream
Writes a sub-array of bytes.
writeUpdate(OutputStream, Object) - Method in class org.apache.river.reliableLog.LogHandler
Writes the representation (a serializable object) of an update to a stream.
A B C D E F G H J L M O P R S T U W 
Skip navigation links
Copyright ©, multiple authors.

Copyright © 2016–2018. All rights reserved.