Alphabetical Index

A C D E G H I L M N O P R S T V

A

addAlias(com.martiansoftware.nailgun.Alias) - method in class com.martiansoftware.nailgun.AliasManager
Adds an Alias, replacing any previous entries with the same name.
Alias - class com.martiansoftware.nailgun.Alias
Provides a means to map memorable, short names to classes in order to make the issuing of commands more convenient.
Alias(String,String,Class) - constructor for class com.martiansoftware.nailgun.Alias
Creates a new Alias with the specified properties.
AliasManager - class com.martiansoftware.nailgun.AliasManager
An AliasManager is used to store and lookup command Aliases by name.
AliasManager() - constructor for class com.martiansoftware.nailgun.AliasManager
Creates a new AliasManager, populating it with default Aliases.
allowsNailsByClassName() - method in class com.martiansoftware.nailgun.NGServer
Returns a flag that indicates whether Nail lookups by classname are allowed.
assertLocalClient() - method in class com.martiansoftware.nailgun.NGContext
Throws a java.lang.SecurityException if the client is not connected from the local machine.
assertLoopbackClient() - method in class com.martiansoftware.nailgun.NGContext
Throws a java.lang.SecurityException if the client is not connected via the loopback address.

C

checkExit(int) - method in class com.martiansoftware.nailgun.NGSecurityManager
checkPermission(Permission) - method in class com.martiansoftware.nailgun.NGSecurityManager
checkPermission(Permission,Object) - method in class com.martiansoftware.nailgun.NGSecurityManager
CHUNKTYPE_ARGUMENT - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for command line arguments
CHUNKTYPE_COMMAND - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for the command (alias or class)
CHUNKTYPE_ENVIRONMENT - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for client environment variables
CHUNKTYPE_EXIT - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for client exit chunks
CHUNKTYPE_STDERR - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for stderr
CHUNKTYPE_STDIN - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for stdin
CHUNKTYPE_STDIN_EOF - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for the end of stdin
CHUNKTYPE_STDOUT - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for stdout
CHUNKTYPE_WORKINGDIRECTORY - static field in class com.martiansoftware.nailgun.NGConstants
Chunk type marker for client working directory
clone() - method in class com.martiansoftware.nailgun.NailStats
Creates a copy of this NailStats object.
compareTo(Object) - method in class com.martiansoftware.nailgun.Alias
Compares Alias names - no other fields are compared.

D

DEFAULT_PORT - static field in class com.martiansoftware.nailgun.NGConstants
The default NailGun port (2113)
DefaultNail - class com.martiansoftware.nailgun.builtins.DefaultNail
The default nail class used by the server when an invalid command (nonexisting classname or alias) is issued.

E

equals(Object) - method in class com.martiansoftware.nailgun.Alias
Checks whether two Aliases have the same name.
equals(Object) - method in class com.martiansoftware.nailgun.NailStats
Returns true iff the specified NailStats object is tracking the same class.
err - field in class com.martiansoftware.nailgun.NGContext
The client's stderr
err - field in class com.martiansoftware.nailgun.NGServer
System.err at the time of the NGServer's creation
exit(int) - method in class com.martiansoftware.nailgun.NGContext
Sends an exit command with the specified exit code to the client.
EXIT_EXCEPTION - static field in class com.martiansoftware.nailgun.NGConstants
The exit code sent to clients if an exception occurred on the server
EXIT_NOSUCHCOMMAND - static field in class com.martiansoftware.nailgun.NGConstants
The exit code sent to clients if an invalid command is sent

G

getAlias(String) - method in class com.martiansoftware.nailgun.AliasManager
Returns the Alias with the specified name
getAliasedClass() - method in class com.martiansoftware.nailgun.Alias
Returns the Class object providing a static main() or nailMain() method for this command.
getAliases() - method in class com.martiansoftware.nailgun.AliasManager
Returns a Set that is a snapshot of the Alias list.
getAliasManager() - method in class com.martiansoftware.nailgun.NGServer
Returns the AliasManager in use by this NGServer.
getArgs() - method in class com.martiansoftware.nailgun.NGContext
Returns the command line arguments for the command implementation (nail) on the server.
getCommand() - method in class com.martiansoftware.nailgun.NGContext
Returns the command that was issued by the client (either an alias or the name of a class).
getDefaultNailClass() - method in class com.martiansoftware.nailgun.NGServer
Returns the default class that will be used if no Nails can be found via alias or classname.
getDescription() - method in class com.martiansoftware.nailgun.Alias
Returns a description for the aliased command
getEnv() - method in class com.martiansoftware.nailgun.NGContext
Returns a java.util.Properties object containing a copy of the client's environment variables
getFileSeparator() - method in class com.martiansoftware.nailgun.NGContext
Returns the file separator ('/' or '\\') used by the client's os.
getInetAddress() - method in class com.martiansoftware.nailgun.NGContext
Returns the address of the client at the other side of this connection.
getNailClass() - method in class com.martiansoftware.nailgun.NailStats
Returns the class for which we're tracking statistics
getNailStats() - method in class com.martiansoftware.nailgun.NGServer
Returns a snapshot of this NGServer's nail statistics.
getName() - method in class com.martiansoftware.nailgun.Alias
Returns the name of the aliased command
getNGServer() - method in class com.martiansoftware.nailgun.NGContext
Returns the NGServer that accepted this connection
getPathSeparator() - method in class com.martiansoftware.nailgun.NGContext
Returns the path separator (':' or ';') used by the client's os.
getPort() - method in class com.martiansoftware.nailgun.NGContext
Returns the port on the client connected to the NailGun server.
getPort() - method in class com.martiansoftware.nailgun.NGServer
Returns the port on which this server is (or will be) listening.
getRefCount() - method in class com.martiansoftware.nailgun.NailStats
Returns the number of sessions currently running this nail.
getRunCount() - method in class com.martiansoftware.nailgun.NailStats
Returns the number of times this nail has been run.
getWorkingDirectory() - method in class com.martiansoftware.nailgun.NGContext
Returns the current working directory of the client, as reported by the client.

H

hashCode() - method in class com.martiansoftware.nailgun.Alias
hashCode() - method in class com.martiansoftware.nailgun.NailStats

I

in - field in class com.martiansoftware.nailgun.NGContext
The client's stdin
in - field in class com.martiansoftware.nailgun.NGServer
System.in at the time of the NGServer's creation
isRunning() - method in class com.martiansoftware.nailgun.NGServer
Returns true iff the server is currently running.

L

loadFromProperties(Properties) - method in class com.martiansoftware.nailgun.AliasManager
Loads Aliases from a java.util.Properties file located at the specified URL.

M

main(String[]) - static method in class com.martiansoftware.nailgun.NGServer
Creates and starts a new NGServer.

N

nailMain(com.martiansoftware.nailgun.NGContext) - static method in class com.martiansoftware.nailgun.builtins.DefaultNail
nailMain(com.martiansoftware.nailgun.NGContext) - static method in class com.martiansoftware.nailgun.builtins.NGAlias
nailMain(com.martiansoftware.nailgun.NGContext) - static method in class com.martiansoftware.nailgun.builtins.NGClasspath
nailMain(com.martiansoftware.nailgun.NGContext) - static method in class com.martiansoftware.nailgun.builtins.NGServerStats
nailMain(com.martiansoftware.nailgun.NGContext) - static method in class com.martiansoftware.nailgun.builtins.NGStop
nailMain(com.martiansoftware.nailgun.NGContext) - static method in class com.martiansoftware.nailgun.builtins.NGVersion
nailShutdown(com.martiansoftware.nailgun.NGServer) - static method in class com.martiansoftware.nailgun.builtins.NGServerStats
NailStats - class com.martiansoftware.nailgun.NailStats
Collects and provides statistics on a nail.
NGAlias - class com.martiansoftware.nailgun.builtins.NGAlias
Provides a means to view and add aliases.
NGClasspath - class com.martiansoftware.nailgun.builtins.NGClasspath
Provides a means to display and add to the system classpath at runtime.
NGConstants - class com.martiansoftware.nailgun.NGConstants
Just a simple holder for various NailGun-related contants.
NGContext - class com.martiansoftware.nailgun.NGContext
Provides quite a bit of potentially useful information to classes specifically written for NailGun.
NGExitException - class com.martiansoftware.nailgun.NGExitException
Security exception which wraps an exit status code.
NGExitException(int) - constructor for class com.martiansoftware.nailgun.NGExitException
NGSecurityManager - class com.martiansoftware.nailgun.NGSecurityManager
Security manager which does nothing other than trap checkExit, or delegate all non-deprecated methods to a base manager.
NGSecurityManager(SecurityManager) - constructor for class com.martiansoftware.nailgun.NGSecurityManager
Construct an NGSecurityManager with the given base.
NGServer - class com.martiansoftware.nailgun.NGServer
Listens for new connections from NailGun clients and launches NGSession threads to process them.
NGServer() - constructor for class com.martiansoftware.nailgun.NGServer
Creates a new NGServer that will listen on the default port (defined in NGConstants.DEFAULT_PORT).
NGServer(InetAddress,int) - constructor for class com.martiansoftware.nailgun.NGServer
Creates a new NGServer that will listen at the specified address and on the specified port.
NGServerStats - class com.martiansoftware.nailgun.builtins.NGServerStats
Displays all NailStats tracked by the server.
NGStop - class com.martiansoftware.nailgun.builtins.NGStop
Shuts down the currently running server.
NGVersion - class com.martiansoftware.nailgun.builtins.NGVersion
Displays the version of the NailGun server and exits.

O

out - field in class com.martiansoftware.nailgun.NGContext
The client's stdout
out - field in class com.martiansoftware.nailgun.NGServer
System.out at the time of the NGServer's creation

P

printStackTrace(PrintStream) - method in class com.martiansoftware.nailgun.NGExitException
A lot of code out there, for example ant's Launcher, runs inside a try/catch (Throwable) which will squash this exception; most also calll printStackTrace(), so this re-throws the exception to escape the handling code.

R

reallyPrintStackTrace(PrintStream) - method in class com.martiansoftware.nailgun.NGExitException
removeAlias(String) - method in class com.martiansoftware.nailgun.AliasManager
Removes the Alias with the specified name from the AliasManager.
run() - method in class com.martiansoftware.nailgun.NGServer
Listens for new connections and launches NGSession threads to process them.

S

setAllowNailsByClassName(boolean) - method in class com.martiansoftware.nailgun.NGServer
Sets a flag that determines whether Nails can be executed by class name.
setDefaultNailClass(Class) - method in class com.martiansoftware.nailgun.NGServer
Sets the default class to use for the Nail if no Nails can be found via alias or classname.
setExit(PrintStream) - static method in class com.martiansoftware.nailgun.NGSecurityManager
shutdown(boolean) - method in class com.martiansoftware.nailgun.NGServer
Shuts down the server.

T

toString() - method in class com.martiansoftware.nailgun.NailStats
Returns a String representation of this NailStats object, in the form "classname: runcount/refcount".

V

VERSION - static field in class com.martiansoftware.nailgun.NGConstants
Server version number

© 2004, Martian Software, Inc.