gov.va.vinci.leo.tools

Class JamService

java.lang.Object

gov.va.vinci.leo.tools.JamService

public class JamService
extends Object

This is part of the Jmx Analytics Monitor package, and allows a client to register with a running JAM instance anywhere on the network using HTTP Web Services.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	LOGGER Logger for this class.

Constructor Summary

Constructors

Constructor and Description
JamService(String jamServerBaseUrl) The base url for the JAM server.

Method Summary

Modifier and Type	Method and Description
void	addServerToServiceQueue(String queueName, String brokerUrl, String host, int port) A web service that add a server to an existing service queue.
protected String	createJmxServerXml(String queueName, String brokerUrl, String host, int port) Creates the XML request used by other methods when calling the web service.
void	disableServiceQueue(String queueName) Disable monitoring of a service queue.
boolean	doesServiceQueueExist(String queueName, String brokerUrl) Given a queue name, determine if it already exists.
protected String	doHttpCall(org.apache.commons.httpclient.HttpMethod method) Does the HTTP call and returns the response body as a string, or throws and HttpException.
void	enableServiceQueue(String queueName) Enable monitoring on an existing service queue.
org.apache.commons.httpclient.HttpClient	getClient() Return the HttpClient used for communication, or null if one has not been set/created yet.
String	getJamServerBaseUrl() Get the JAM server base url.
protected String	getRegisterServiceRequestBody(String queueName, String brokerUrl, int queryIntervalInSeconds, boolean resetStatisticsAfterQuery, boolean profileEnabled) Returns the xml for the registerServiceRequest method.
protected String	getServiceQueueExistRequestBody(String queueName, String brokerUrl) Get the serviceQueueExistRequest body xml.
int	loadJMXAgent(int port) Load the JMX Agent for gathering statistics via JMX on this running service.
void	registerServiceQueue(String queueName, String brokerUrl, int queryIntervalInSeconds, boolean resetStatisticsAfterQuery, boolean profileEnabled) Registers a new service queue in Jam.
void	removeServerFromServiceQueue(String queueName, String brokerUrl, String host, int port) Remove a host/port from a service queue.
void	removeServiceQueue(String queueName) Removes a service queue, and all related hosts and monitoring jobs.
void	runGather(String queueName, String brokerUrl) Given a queuename and broker, do an immediate gather of stats.
void	setClient(org.apache.commons.httpclient.HttpClient client) Set the HttpClient to use for communication.
void	setJamServerBaseUrl(String jamServerBaseUrl) Set the JAM server base url.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.apache.log4j.Logger LOGGER

Logger for this class.

Constructor Detail

JamService

public JamService(String jamServerBaseUrl)

The base url for the JAM server. For example: http://localhost:8080/jam/

Parameters:

jamServerBaseUrl - the base url for the JAM server to communicate with.

Method Detail

getClient

public org.apache.commons.httpclient.HttpClient getClient()

Return the HttpClient used for communication, or null if one has not been set/created yet.

Returns:

the HttpClient used for communication

setClient

public void setClient(org.apache.commons.httpclient.HttpClient client)

Set the HttpClient to use for communication. Generally not used, and the default HttpClient inside of this object is used.

Parameters:

client - An HttpClient to use for communication.

getJamServerBaseUrl

public String getJamServerBaseUrl()

Get the JAM server base url. (ie - http://localhost:8080/jam/)

Returns:

the JAM server base url

setJamServerBaseUrl

public void setJamServerBaseUrl(String jamServerBaseUrl)

Set the JAM server base url. (ie - http://localhost:8080/jam/)

Parameters:

jamServerBaseUrl - the JAM server base url

addServerToServiceQueue

public void addServerToServiceQueue(String queueName,
                                    String brokerUrl,
                                    String host,
                                    int port)
                             throws IOException

A web service that add a server to an existing service queue.

Parameters:

queueName - the name of the queue to add this host to.

host - the host name to add to the service queue

port - the port on the host that is added to the service queue

brokerUrl - the broker url this service is using.

Throws:

IOException - if any communication exception occurs.

disableServiceQueue

public void disableServiceQueue(String queueName)
                         throws IOException

Disable monitoring of a service queue.

Parameters:

queueName - the queue name to disable.

Throws:

IOException - if any communication exception occurs.

doesServiceQueueExist

public boolean doesServiceQueueExist(String queueName,
                                     String brokerUrl)
                              throws IOException

Given a queue name, determine if it already exists.

Parameters:

queueName - the ServiceQueue.queueName to check for

brokerUrl - the broker url this service is using.

Returns:

returns TRUE if the service queue name exists, or false if it does not.

Throws:

IOException - if any communication exception occurs.

enableServiceQueue

public void enableServiceQueue(String queueName)
                        throws IOException

Enable monitoring on an existing service queue.

Parameters:

queueName - the name of the queue to enable monitoring on.

Throws:

IOException - if any communication exception occurs.

registerServiceQueue

public void registerServiceQueue(String queueName,
                                 String brokerUrl,
                                 int queryIntervalInSeconds,
                                 boolean resetStatisticsAfterQuery,
                                 boolean profileEnabled)
                          throws IOException

Registers a new service queue in Jam. Note: Service queue names MUST be unique in the jam system.

Parameters:

queueName - the name of the queue to register with.

brokerUrl - the broker url this service is using.

queryIntervalInSeconds - the interval in seconds to query the running service for metrics.

resetStatisticsAfterQuery - if true, statistics are reset to 0 after each gather. If false, statistics are cumulative.

profileEnabled - if true the profile is enabled for gathering, if false, it is registered, but not enabled for gathering.

Throws:

IOException - if any communication exception occurs.

removeServerFromServiceQueue

public void removeServerFromServiceQueue(String queueName,
                                         String brokerUrl,
                                         String host,
                                         int port)
                                  throws IOException

Remove a host/port from a service queue.

If the host is not part of the service queue, no-op. If it is part of the Service Queue, it is removed.

Parameters:

queueName - the name of the queue to remove.

brokerUrl - the broker url this service is using.

host - the host the service is running on.

port - the port the service is running on.

Throws:

IOException - if any communication exception occurs.

removeServiceQueue

public void removeServiceQueue(String queueName)
                        throws IOException

Removes a service queue, and all related hosts and monitoring jobs.

Parameters:

queueName - the queue name to remove.

Throws:

IOException - if any communication exception occurs.

runGather

public void runGather(String queueName,
                      String brokerUrl)
               throws IOException

Given a queuename and broker, do an immediate gather of stats.

Parameters:

queueName - the queue name of the service.

brokerUrl - the broker url for the service.

Throws:

IOException - if any communication exception occurs.

createJmxServerXml

protected String createJmxServerXml(String queueName,
                                    String brokerUrl,
                                    String host,
                                    int port)

Creates the XML request used by other methods when calling the web service. The request is in the format:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <jmxServer>
 		<queueName>queueName</queueName>
 		<brokerUrl>brokerUrl</brokerUrl>
 		<host>host</host>
 		<port>port</port>
 </jmxServer>
 
 

Parameters:

queueName - queue name for this service.

brokerUrl - UIMA broker url for this service.

host - Host the service is running on.

port - Port JMX is enabled on for the service.

Returns:

the xml body.

doHttpCall

protected String doHttpCall(org.apache.commons.httpclient.HttpMethod method)
                     throws IOException,
                            org.apache.commons.httpclient.HttpException

Does the HTTP call and returns the response body as a string, or throws and HttpException.

Parameters:

method - The HttpMethod to call.

Returns:

Response body as a string.

Throws:

IOException - if any communication exception occurs.

org.apache.commons.httpclient.HttpException - If HttpStatus is NOT SC_OK, an HttpException is thrown with the error.

getRegisterServiceRequestBody

protected String getRegisterServiceRequestBody(String queueName,
                                               String brokerUrl,
                                               int queryIntervalInSeconds,
                                               boolean resetStatisticsAfterQuery,
                                               boolean profileEnabled)

Returns the xml for the registerServiceRequest method. The xml is in the format:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <serviceQueue>
     <queueName>queueName</queueName>
     <brokerUrl>brokerUrl</brokerUrl>
     <queryIntervalInSeconds>queryIntervalInSeconds</queryIntervalInSeconds>
     <resetStatisticsAfterQuery>resetStatisticsAfterQuery</resetStatisticsAfterQuery>
     <profileEnabled>profileEnabled</profileEnabled>
 </serviceQueue>
 
 

Parameters:

queueName - the queue name of the service.

brokerUrl - the broker url for the service.

queryIntervalInSeconds - the interval in seconds to query the running service for metrics.

resetStatisticsAfterQuery - if true, statistics are reset to 0 after each gather. If false, statistics are cumulative.

profileEnabled - if true the profile is enabled for gathering, if false, it is registered, but not enabled for gathering.

Returns:

returns the register service request body in xml

getServiceQueueExistRequestBody

protected String getServiceQueueExistRequestBody(String queueName,
                                                 String brokerUrl)

Get the serviceQueueExistRequest body xml. It is in the format:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <serviceQueue>
     <queueName>queueName</queueName>
     <brokerUrl>brokerUrl</brokerUrl>
 </serviceQueue>
 
 

Parameters:

queueName - the queue name of the service.

brokerUrl - the broker url for the service.

Returns:

the xml for the serviceQueueExistRequest method.

loadJMXAgent

public int loadJMXAgent(int port)
                 throws IOException,
                        com.sun.tools.attach.AttachNotSupportedException,
                        com.sun.tools.attach.AgentLoadException,
                        com.sun.tools.attach.AgentInitializationException

Load the JMX Agent for gathering statistics via JMX on this running service. Note: If parameters were set on the command line, this existing JMX server is used and the connect url from the existing JMX server returned. The command line options are: -Dcom.sun.management.jmxremote.port=#### -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false

Parameters:

port - The port to bind the jmx server to. If -1, an open port is automatically chosen.

Returns:

the port used for the JMX Server.

Throws:

IOException

com.sun.tools.attach.AttachNotSupportedException

com.sun.tools.attach.AgentLoadException

com.sun.tools.attach.AgentInitializationException