public class NGServer
extends java.lang.Object
implements java.lang.Runnable
Listens for new connections from NailGun clients and launches NGSession threads to process them.
This class can be run as a standalone server or can be embedded within larger applications as a means of providing command-line interaction with the application.
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_SESSIONPOOLSIZE
Default size for thread pool
|
java.io.PrintStream |
err
System.err at the time of the NGServer's creation |
java.io.InputStream |
in
System.in at the time of the NGServer's creation |
java.io.PrintStream |
out
System.out at the time of the NGServer's creation |
Constructor and Description |
---|
NGServer()
Creates a new NGServer that will listen on the default port
(defined in
NGConstants.DEFAULT_PORT ). |
NGServer(java.net.InetAddress addr,
int port)
Creates a new NGServer that will listen at the specified address and
on the specified port with the default session pool size.
|
NGServer(java.net.InetAddress addr,
int port,
int sessionPoolSize)
Creates a new NGServer that will listen at the specified address and
on the specified port with the specified session pool size.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowsNailsByClassName()
Returns a flag that indicates whether Nail lookups by classname
are allowed.
|
AliasManager |
getAliasManager()
Returns the AliasManager in use by this NGServer.
|
java.lang.Class |
getDefaultNailClass()
Returns the default class that will be used if no Nails
can be found via alias or classname.
|
java.util.Map |
getNailStats()
Returns a snapshot of this NGServer's nail statistics.
|
int |
getPort()
Returns the port on which this server is (or will be) listening.
|
boolean |
isRunning()
Returns true iff the server is currently running.
|
static void |
main(java.lang.String[] args)
Creates and starts a new
NGServer . |
void |
run()
Listens for new connections and launches NGSession threads
to process them.
|
void |
setAllowNailsByClassName(boolean allowNailsByClassName)
Sets a flag that determines whether Nails can be executed by class name.
|
void |
setDefaultNailClass(java.lang.Class defaultNailClass)
Sets the default class to use for the Nail if no Nails can
be found via alias or classname.
|
void |
shutdown(boolean exitVM)
Shuts down the server.
|
public static final int DEFAULT_SESSIONPOOLSIZE
public final java.io.PrintStream out
System.out
at the time of the NGServer's creationpublic final java.io.PrintStream err
System.err
at the time of the NGServer's creationpublic final java.io.InputStream in
System.in
at the time of the NGServer's creationpublic NGServer(java.net.InetAddress addr, int port, int sessionPoolSize)
Thread
wrapping this NGServer
and start it.addr
- the address at which to listen, or null
to bind
to all local addressesport
- the port on which to listen.sessionPoolSize
- the max number of idle sessions allowed by the poolpublic NGServer(java.net.InetAddress addr, int port)
Thread
wrapping this NGServer
and start it.addr
- the address at which to listen, or null
to bind
to all local addressesport
- the port on which to listen.sessionPoolSize
- the max number of idle sessions allowed by the poolpublic NGServer()
NGConstants.DEFAULT_PORT
).
This does not cause the server to start listening. To do
so, create a new Thread
wrapping this NGServer
and start it.public void setAllowNailsByClassName(boolean allowNailsByClassName)
allowNailsByClassName
- true iff Nail lookups by classname are allowedpublic boolean allowsNailsByClassName()
public void setDefaultNailClass(java.lang.Class defaultNailClass)
null
,
in which case NailGun will use its own default)defaultNailClass
- the default class to use for the Nail
if no Nails can be found via alias or classname.
(may be null
, in which case NailGun will use
its own default)public java.lang.Class getDefaultNailClass()
public java.util.Map getNailStats()
java.util.Map
,
keyed by class name, with NailStats objects as values.public AliasManager getAliasManager()
public void shutdown(boolean exitVM)
Shuts down the server. The server will stop listening and its thread will finish. Any running nails will be allowed to finish.
Any nails that provide a
public static void nailShutdown(NGServer)
method will have this method called with this NGServer as its sole
parameter.exitVM
- if true, this method will also exit the JVM after
calling nailShutdown() on any nails. This may prevent currently
running nails from exiting gracefully, but may be necessary in order
to perform some tasks, such as shutting down any AWT or Swing threads
implicitly launched by your nails.public boolean isRunning()
public int getPort()
public void run()
run
in interface java.lang.Runnable
public static void main(java.lang.String[] args) throws java.lang.NumberFormatException, java.net.UnknownHostException
NGServer
. A single optional
argument is valid, specifying the port on which this NGServer
should listen. If omitted, NGServer.DEFAULT_PORT
will be used.args
- a single optional argument specifying the port on which to listen.java.lang.NumberFormatException
- if a non-numeric port is specifiedjava.net.UnknownHostException
© 2004, Martian Software, Inc.