org.jolokia.jvmagent

Class JolokiaServer

java.lang.Object

org.jolokia.jvmagent.JolokiaServer

public class JolokiaServer
extends Object

Factory for creating the HttpServer used for exporting the Jolokia protocol

Since:

12.08.11

Author:

roland, nevenr

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JolokiaServer() No arg constructor usable by subclasses.
	JolokiaServer(com.sun.net.httpserver.HttpServer pServer, JolokiaServerConfig pConfig, boolean pLazy) Create the Jolokia server by using an existing HttpServer to which a request handler gets added.
	JolokiaServer(JolokiaServerConfig pConfig, boolean pLazy) Create the Jolokia server which in turn creates an HttpServer for serving Jolokia requests.

Method Summary

Methods

Modifier and Type	Method and Description
InetSocketAddress	getAddress()
JolokiaServerConfig	getServerConfig() Get configuration for this server
String	getUrl() URL how this agent can be reached from the outside.
protected void	init(com.sun.net.httpserver.HttpServer pServer, JolokiaServerConfig pConfig, boolean pLazy) Initialize this JolokiaServer with the given HttpServer.
protected void	init(JolokiaServerConfig pConfig, boolean pLazy) Initialize this JolokiaServer and use an own created HttpServer
void	start() Start this server.
void	stop() Stop the HTTP server

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JolokiaServer

public JolokiaServer(JolokiaServerConfig pConfig,
             boolean pLazy)
              throws IOException

Create the Jolokia server which in turn creates an HttpServer for serving Jolokia requests.

Parameters:

pConfig - configuration for this server

pLazy - lazy initialisation if true. This is required for agents configured via startup options since at this early boot time the JVM is not fully setup for the server detectors to work

Throws:

IOException - if initialization fails

JolokiaServer

public JolokiaServer(com.sun.net.httpserver.HttpServer pServer,
             JolokiaServerConfig pConfig,
             boolean pLazy)

Create the Jolokia server by using an existing HttpServer to which a request handler gets added.

Parameters:

pServer - HttpServer to use

pConfig - configuration for this server

pLazy - lazy initialisation if true. This is required for agents configured via startup options since at this early boot time the JVM is not fully setup for the server detectors to work

JolokiaServer

protected JolokiaServer()

No arg constructor usable by subclasses. The init(JolokiaServerConfig, boolean) must be called later on for initialization

Method Detail

start

public void start()

Start this server. If we manage an own HttpServer, then the HttpServer will be started as well.

stop

public void stop()

Stop the HTTP server

getUrl

public String getUrl()

URL how this agent can be reached from the outside.

Returns:

the agent URL

getServerConfig

public JolokiaServerConfig getServerConfig()

Get configuration for this server

Returns:

server configuration

init

protected final void init(JolokiaServerConfig pConfig,
        boolean pLazy)
                   throws IOException

Initialize this JolokiaServer and use an own created HttpServer

Parameters:

pConfig - configuartion to use

pLazy - whether to do the inialization lazy or not

Throws:

IOException - if the creation of the HttpServer fails

init

protected final void init(com.sun.net.httpserver.HttpServer pServer,
        JolokiaServerConfig pConfig,
        boolean pLazy)

Initialize this JolokiaServer with the given HttpServer. The calle is responsible for managing (starting/stopping) the HttpServer.

Parameters:

pServer - server to use

pConfig - configuration

pLazy - whether the initialization should be done lazy or not

getAddress

public InetSocketAddress getAddress()

Returns:

the address that the server is listening on. Thus, a program can initialize the server with 'port 0' and then retrieve the actual running port that was bound.