NGContext (nailgun-all 1.0.1 API)

java.lang.Object
- com.facebook.nailgun.NGContext

```
public class NGContext
extends Object
```
Provides quite a bit of potentially useful information to classes specifically written for NailGun. The NailGun server itself, its AliasManager, the remote client's environment variables, and other information is available via this class. For all intents and purposes, the NGContext represents a single connection from a NailGun client. If a class is written with a
```
 public static void nailMain(NGContext context)
 
```
method, that method will be called by NailGun instead of the traditional main(String[]) method normally used for programs. A fully populated NGContext object will then be provided to nailMain().
Author:

Marty Lamb

Field Summary

Fields
Modifier and Type Field and Description

PrintStream err
The client's stderr

InputStream in
The client's stdin

PrintStream out
The client's stdout

Fields
Modifier and Type	Field and Description
`PrintStream`	`err` The client's stderr
`InputStream`	`in` The client's stdin
`PrintStream`	`out` The client's stdout

Constructor Summary

Constructors
Constructor and Description

NGContext()
Creates a new, empty NGContext

Constructors
Constructor and Description
`NGContext()` Creates a new, empty NGContext

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClientListener(NGClientListener listener)`
`void`	`addHeartbeatListener(NGHeartbeatListener listener)`
`void`	`assertLocalClient()` Throws a `java.lang.SecurityException` if the client is not connected from the local machine.
`void`	`assertLoopbackClient()` Throws a `java.lang.SecurityException` if the client is not connected via the loopback address.
`void`	`exit(int exitCode)` Sends an exit command with the specified exit code to the client.
`String[]`	`getArgs()` Returns the command line arguments for the command implementation (nail) on the server.
`String`	`getCommand()` Returns the command that was issued by the client (either an alias or the name of a class).
`NGCommunicator`	`getCommunicator()`
`Properties`	`getEnv()` Returns a `java.util.Properties` object containing a copy of the client's environment variables
`String`	`getFileSeparator()` Returns the file separator ('/' or '\\') used by the client's os.
`InetAddress`	`getInetAddress()` Returns the address of the client at the other side of this connection.
`NGServer`	`getNGServer()` Returns the NGServer that accepted this connection
`String`	`getPathSeparator()` Returns the path separator (':' or ';') used by the client's os.
`int`	`getPort()` Returns the port on the client connected to the NailGun server.
`String`	`getWorkingDirectory()` Returns the current working directory of the client, as reported by the client.
`boolean`	`isClientConnected()`
`void`	`removeAllClientListeners()` Do not notify about client exit
`void`	`removeClientListener(NGClientListener listener)`
`void`	`removeHeartbeatListener(NGHeartbeatListener listener)`
`void`	`setArgs(String[] args)`
`void`	`setCommand(String command)`
`void`	`setCommunicator(NGCommunicator comm)`
`void`	`setErr(PrintStream err)` Sets the current `PrintStream` for standard error for the current nail.
`void`	`setIn(InputStream in)` Sets the current `InputStream` for standard input for the current nail.
`void`	`setOut(PrintStream out)` Sets the current `PrintStream` for standard output for the current nail.
`void`	`setPort(int remotePort)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - in
```
public InputStream in
```
    The client's stdin
  - out
```
public PrintStream out
```
    The client's stdout
  - err
```
public PrintStream err
```
    The client's stderr
- Constructor Detail
  - NGContext
```
public NGContext()
```
    Creates a new, empty NGContext
- Method Detail
  - setCommunicator
```
public void setCommunicator(NGCommunicator comm)
```
  - getCommunicator
```
public NGCommunicator getCommunicator()
```
  - setPort
```
public void setPort(int remotePort)
```
  - setCommand
```
public void setCommand(String command)
```
  - getCommand
```
public String getCommand()
```
    Returns the command that was issued by the client (either an alias or the name of a class). This allows multiple aliases to point to the same class but result in different behaviors.
    
    Returns:
    
    the command issued by the client
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
    Returns the current working directory of the client, as reported by the client. This is a String that will use the client's File.separator ('/' or '\'), which may differ from the separator on the server.
    
    Returns:
    
    the current working directory of the client
  - setIn
```
public void setIn(InputStream in)
```
    Sets the current InputStream for standard input for the current nail.
    
    Parameters:
    
    in - The InputStream to use as stdin for the current nail. This should be an InputStream that ultimately reads from NGInputStream.
  - setOut
```
public void setOut(PrintStream out)
```
    Sets the current PrintStream for standard output for the current nail.
    
    Parameters:
    
    out - The PrintStream to use as stdout for the current nail. This should be a PrintStream that ultimately writes to NGOutputStream.
  - setErr
```
public void setErr(PrintStream err)
```
    Sets the current PrintStream for standard error for the current nail.
    
    Parameters:
    
    err - The PrintStream to use as stderr for the current nail. This should be a PrintStream that ultimately writes to NGOutputStream.
  - setArgs
```
public void setArgs(String[] args)
```
  - getEnv
```
public Properties getEnv()
```
    Returns a java.util.Properties object containing a copy of the client's environment variables
    
    Returns:
    
    a java.util.Properties object containing a copy of the client's environment variables
    
    See Also:
    
    Properties
  - getFileSeparator
```
public String getFileSeparator()
```
    Returns the file separator ('/' or '\\') used by the client's os.
    
    Returns:
    
    the file separator ('/' or '\\') used by the client's os.
  - getPathSeparator
```
public String getPathSeparator()
```
    Returns the path separator (':' or ';') used by the client's os.
    
    Returns:
    
    the path separator (':' or ';') used by the client's os.
  - getInetAddress
```
public InetAddress getInetAddress()
```
    Returns the address of the client at the other side of this connection.
    
    Returns:
    
    the address of the client at the other side of this connection.
  - getArgs
```
public String[] getArgs()
```
    Returns the command line arguments for the command implementation (nail) on the server.
    
    Returns:
    
    the command line arguments for the command implementation (nail) on the server.
  - getNGServer
```
public NGServer getNGServer()
```
    Returns the NGServer that accepted this connection
    
    Returns:
    
    the NGServer that accepted this connection
  - exit
```
public void exit(int exitCode)
```
    Sends an exit command with the specified exit code to the client. The client will exit immediately with the specified exit code; you probably want to return from nailMain immediately after calling this.
    
    Parameters:
    
    exitCode - the exit code with which the client should exit
  - getPort
```
public int getPort()
```
    Returns the port on the client connected to the NailGun server.
    
    Returns:
    
    the port on the client connected to the NailGun server.
  - assertLoopbackClient
```
public void assertLoopbackClient()
```
    Throws a java.lang.SecurityException if the client is not connected via the loopback address.
  - assertLocalClient
```
public void assertLocalClient()
```
    Throws a java.lang.SecurityException if the client is not connected from the local machine.
  - isClientConnected
```
public boolean isClientConnected()
```
    Returns:
    
    true if client is connected, false if a client exit has been detected.
  - addClientListener
```
public void addClientListener(NGClientListener listener)
```
    Parameters:
    
    listener - the NGClientListener to be notified of client events.
  - removeClientListener
```
public void removeClientListener(NGClientListener listener)
```
    Parameters:
    
    listener - the NGClientListener to no longer be notified of client events.
  - removeAllClientListeners
```
public void removeAllClientListeners()
```
    Do not notify about client exit
  - addHeartbeatListener
```
public void addHeartbeatListener(NGHeartbeatListener listener)
```
    Parameters:
    
    listener - the NGHeartbeatListener to be notified of client events.
  - removeHeartbeatListener
```
public void removeHeartbeatListener(NGHeartbeatListener listener)
```
    Parameters:
    
    listener - the NGHeartbeatListener to no longer be notified of client events.

Class NGContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

in

out

err

Constructor Detail

NGContext

Method Detail

setCommunicator

getCommunicator

setPort

setCommand

getCommand

getWorkingDirectory

setIn

setOut

setErr

setArgs

getEnv

getFileSeparator

getPathSeparator

getInetAddress

getArgs

getNGServer

exit

getPort

assertLoopbackClient

assertLocalClient

isClientConnected

addClientListener

removeClientListener

removeAllClientListeners

addHeartbeatListener

removeHeartbeatListener