Java Doc for NGContext.java in  » Net » NailGun » com » martiansoftware » nailgun » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » NailGun » com.martiansoftware.nailgun 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.martiansoftware.nailgun.NGContext

NGContext
public class NGContext (Code)

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
public  PrintStreamerr
    
public  InputStreamin
    
public  PrintStreamout
    

Constructor Summary
 NGContext()
    

Method Summary
public  voidassertLocalClient()
     Throws a java.lang.SecurityException if the client is not connected from the local machine.
public  voidassertLoopbackClient()
     Throws a java.lang.SecurityException if the client is not connected via the loopback address.
public  voidexit(int exitCode)
     Sends an exit command with the specified exit code to the client.
public  String[]getArgs()
     Returns the command line arguments for the command implementation (nail) on the server.
public  StringgetCommand()
     Returns the command that was issued by the client (either an alias or the name of a class).
public  PropertiesgetEnv()
    
public  StringgetFileSeparator()
     Returns the file separator ('/' or '\\') used by the client's os.
public  InetAddressgetInetAddress()
     Returns the address of the client at the other side of this connection.
public  NGServergetNGServer()
    
public  StringgetPathSeparator()
     Returns the path separator (':' or ';') used by the client's os.
public  intgetPort()
     Returns the port on the client connected to the NailGun server.
public  StringgetWorkingDirectory()
     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.
 voidsetArgs(String[] args)
    
 voidsetCommand(String command)
    
 voidsetEnv(Properties remoteEnvironment)
    
 voidsetExitStream(PrintStream exitStream)
    
 voidsetInetAddress(InetAddress remoteHost)
    
 voidsetNGServer(NGServer server)
    
 voidsetPort(int remotePort)
    
 voidsetWorkingDirectory(String workingDirectory)
    

Field Detail
err
public PrintStream err(Code)
The client's stderr



in
public InputStream in(Code)
The client's stdin



out
public PrintStream out(Code)
The client's stdout




Constructor Detail
NGContext
NGContext()(Code)
Creates a new, empty NGContext




Method Detail
assertLocalClient
public void assertLocalClient()(Code)
Throws a java.lang.SecurityException if the client is not connected from the local machine.



assertLoopbackClient
public void assertLoopbackClient()(Code)
Throws a java.lang.SecurityException if the client is not connected via the loopback address.



exit
public void exit(int exitCode)(Code)
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 clientshould exit



getArgs
public String[] getArgs()(Code)
Returns the command line arguments for the command implementation (nail) on the server. the command line arguments for the commandimplementation (nail) on the server.



getCommand
public String getCommand()(Code)
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. the command issued by the client



getEnv
public Properties getEnv()(Code)
Returns a java.util.Properties object containing a copy of the client's environment variables
See Also:   java.util.Properties a java.util.Properties object containing a copyof the client's environment variables



getFileSeparator
public String getFileSeparator()(Code)
Returns the file separator ('/' or '\\') used by the client's os. the file separator ('/' or '\\') used by the client's os.



getInetAddress
public InetAddress getInetAddress()(Code)
Returns the address of the client at the other side of this connection. the address of the client at the other side of this connection.



getNGServer
public NGServer getNGServer()(Code)
Returns the NGServer that accepted this connection the NGServer that accepted this connection



getPathSeparator
public String getPathSeparator()(Code)
Returns the path separator (':' or ';') used by the client's os. the path separator (':' or ';') used by the client's os.



getPort
public int getPort()(Code)
Returns the port on the client connected to the NailGun server. the port on the client connected to the NailGunserver.



getWorkingDirectory
public String getWorkingDirectory()(Code)
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. the current working directory of the client



setArgs
void setArgs(String[] args)(Code)



setCommand
void setCommand(String command)(Code)



setEnv
void setEnv(Properties remoteEnvironment)(Code)



setExitStream
void setExitStream(PrintStream exitStream)(Code)



setInetAddress
void setInetAddress(InetAddress remoteHost)(Code)



setNGServer
void setNGServer(NGServer server)(Code)



setPort
void setPort(int remotePort)(Code)



setWorkingDirectory
void setWorkingDirectory(String workingDirectory)(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.