Overview | Package | Class | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

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

## A

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.
addAlias(Alias) - Method in class com.martiansoftware.nailgun.AliasManager
  Adds an Alias, replacing any previous entries with the same name.
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

CHUNKTYPE_ARGUMENT - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for command line arguments
CHUNKTYPE_COMMAND - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for the command (alias or class)
CHUNKTYPE_ENVIRONMENT - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for client environment variables
CHUNKTYPE_EXIT - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for client exit chunks
CHUNKTYPE_STDERR - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for stderr
CHUNKTYPE_STDIN - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for stdin
CHUNKTYPE_STDIN_EOF - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for the end of stdin
CHUNKTYPE_STDOUT - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for stdout
CHUNKTYPE_WORKINGDIRECTORY - Static variable in class com.martiansoftware.nailgun.NGConstants
  Chunk type marker for client working directory
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
clone() - Method in class com.martiansoftware.nailgun.NailStats
  Creates a copy of this `NailStats` object.
com.martiansoftware.nailgun - package com.martiansoftware.nailgun
com.martiansoftware.nailgun.builtins - package com.martiansoftware.nailgun.builtins
compareTo(Object) - Method in class com.martiansoftware.nailgun.Alias
  Compares Alias names - no other fields are compared.

## D

DEFAULT_PORT - Static variable 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.
DefaultNail() - Constructor for class com.martiansoftware.nailgun.builtins.DefaultNail

## E

EXIT_EXCEPTION - Static variable in class com.martiansoftware.nailgun.NGConstants
  The exit code sent to clients if an exception occurred on the server
EXIT_NOSUCHCOMMAND - Static variable in class com.martiansoftware.nailgun.NGConstants
  The exit code sent to clients if an invalid command is sent
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 - Variable in class com.martiansoftware.nailgun.NGContext
  The client's stderr
err - Variable 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.

## G

getAlias(String) - Method in class com.martiansoftware.nailgun.AliasManager
  Returns the Alias with the specified name
getAliasManager() - Method in class com.martiansoftware.nailgun.NGServer
  Returns the AliasManager in use by this NGServer.
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.
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.
getNGServer() - Method in class com.martiansoftware.nailgun.NGContext
  Returns the NGServer that accepted 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
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 - Variable in class com.martiansoftware.nailgun.NGContext
  The client's stdin
in - Variable 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

NGAlias - class com.martiansoftware.nailgun.builtins.NGAlias.
  Provides a means to view and add aliases.
NGAlias() - Constructor for class com.martiansoftware.nailgun.builtins.NGAlias
NGClasspath - class com.martiansoftware.nailgun.builtins.NGClasspath.
  Provides a means to display and add to the system classpath at runtime.
NGClasspath() - Constructor for class com.martiansoftware.nailgun.builtins.NGClasspath
NGConstants - class com.martiansoftware.nailgun.NGConstants.
  Just a simple holder for various NailGun-related contants.
NGConstants() - Constructor for class com.martiansoftware.nailgun.NGConstants
NGContext - class com.martiansoftware.nailgun.NGContext.
  Provides quite a bit of potentially useful information to classes specifically written for NailGun.
NGExitException - exception 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(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.
NGServer() - Constructor for class com.martiansoftware.nailgun.NGServer
  Creates a new NGServer that will listen on the default port (defined in `NGConstants.DEFAULT_PORT`).
NGServerStats - class com.martiansoftware.nailgun.builtins.NGServerStats.
  Displays all NailStats tracked by the server.
NGServerStats() - Constructor for class com.martiansoftware.nailgun.builtins.NGServerStats
NGStop - class com.martiansoftware.nailgun.builtins.NGStop.
  Shuts down the currently running server.
NGStop() - Constructor for class com.martiansoftware.nailgun.builtins.NGStop
NGVersion - class com.martiansoftware.nailgun.builtins.NGVersion.
  Displays the version of the NailGun server and exits.
NGVersion() - Constructor for class com.martiansoftware.nailgun.builtins.NGVersion
NailStats - class com.martiansoftware.nailgun.NailStats.
  Collects and provides statistics on a nail.
nailMain(NGContext) - Static method in class com.martiansoftware.nailgun.builtins.DefaultNail
nailMain(NGContext) - Static method in class com.martiansoftware.nailgun.builtins.NGAlias
nailMain(NGContext) - Static method in class com.martiansoftware.nailgun.builtins.NGClasspath
nailMain(NGContext) - Static method in class com.martiansoftware.nailgun.builtins.NGServerStats
nailMain(NGContext) - Static method in class com.martiansoftware.nailgun.builtins.NGStop
nailMain(NGContext) - Static method in class com.martiansoftware.nailgun.builtins.NGVersion
nailShutdown(NGServer) - Static method in class com.martiansoftware.nailgun.builtins.NGServerStats

## O

out - Variable in class com.martiansoftware.nailgun.NGContext
  The client's stdout
out - Variable 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 variable in class com.martiansoftware.nailgun.NGConstants
  Server version number

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

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

© 2004, Martian Software, Inc.