com.googlecode.jmxtrans.model

Class Server

java.lang.Object

com.googlecode.jmxtrans.model.Server

All Implemented Interfaces:

JmxConnectionProvider

@Immutable
 @ThreadSafe
public class Server
extends java.lang.Object
implements JmxConnectionProvider

Represents a jmx server that we want to connect to. This also stores the queries that we want to execute against the server.

Author:

jon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Server.Builder

Constructor Summary

Constructors

Constructor and Description
Server(java.lang.String alias, java.lang.String pid, java.lang.String host, java.lang.String port, java.lang.String username, java.lang.String password, java.lang.String protocolProviderPackages, java.lang.String url, java.lang.String cronExpression, java.lang.Integer runPeriodSeconds, java.lang.Integer numQueryThreads, boolean local, boolean ssl, java.util.List<Query> queries, com.google.common.collect.ImmutableList<OutputWriter> outputWriters, org.apache.commons.pool.KeyedObjectPool<JmxConnectionProvider,JMXConnection> pool)
Server(java.lang.String alias, java.lang.String pid, java.lang.String host, java.lang.String port, java.lang.String username, java.lang.String password, java.lang.String protocolProviderPackages, java.lang.String url, java.lang.String cronExpression, java.lang.Integer runPeriodSeconds, java.lang.Integer numQueryThreads, boolean local, boolean ssl, java.util.List<Query> queries, java.util.List<OutputWriterFactory> outputWriters, org.apache.commons.pool.KeyedObjectPool<JmxConnectionProvider,JMXConnection> pool)

Method Summary

Modifier and Type	Method and Description
static Server.Builder	builder()
static Server.Builder	builder(Server server)
java.lang.Iterable<Result>	execute(Query query)
com.google.common.collect.ImmutableMap<java.lang.String,?>	getEnvironment() Generates the proper username/password environment for JMX connections.
java.lang.String	getHost()
javax.management.remote.JMXServiceURL	getJmxServiceURL()
java.lang.String	getLabel()
javax.management.MBeanServer	getLocalMBeanServer()
java.lang.String	getPort()
javax.management.remote.JMXConnector	getServerConnection() Helper method for connecting to a Server.
java.lang.String	getSource()
java.lang.String	getUrl() The jmx url to connect to.
boolean	isQueriesMultiThreaded()
void	runOutputWriters(Query query, java.lang.Iterable<Result> results)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.googlecode.jmxtrans.connections.JmxConnectionProvider

isLocal

Constructor Detail

Server

public Server(java.lang.String alias,
              java.lang.String pid,
              java.lang.String host,
              java.lang.String port,
              java.lang.String username,
              java.lang.String password,
              java.lang.String protocolProviderPackages,
              java.lang.String url,
              java.lang.String cronExpression,
              java.lang.Integer runPeriodSeconds,
              java.lang.Integer numQueryThreads,
              boolean local,
              boolean ssl,
              java.util.List<Query> queries,
              java.util.List<OutputWriterFactory> outputWriters,
              org.apache.commons.pool.KeyedObjectPool<JmxConnectionProvider,JMXConnection> pool)

Server

public Server(java.lang.String alias,
              java.lang.String pid,
              java.lang.String host,
              java.lang.String port,
              java.lang.String username,
              java.lang.String password,
              java.lang.String protocolProviderPackages,
              java.lang.String url,
              java.lang.String cronExpression,
              java.lang.Integer runPeriodSeconds,
              java.lang.Integer numQueryThreads,
              boolean local,
              boolean ssl,
              java.util.List<Query> queries,
              com.google.common.collect.ImmutableList<OutputWriter> outputWriters,
              org.apache.commons.pool.KeyedObjectPool<JmxConnectionProvider,JMXConnection> pool)

Method Detail

execute

public java.lang.Iterable<Result> execute(Query query)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getEnvironment

public com.google.common.collect.ImmutableMap<java.lang.String,?> getEnvironment()

Generates the proper username/password environment for JMX connections.

getServerConnection

public javax.management.remote.JMXConnector getServerConnection()
                                                         throws java.io.IOException

Helper method for connecting to a Server. You need to close the resulting connection.

Specified by:

getServerConnection in interface JmxConnectionProvider

Throws:

java.io.IOException

getLocalMBeanServer

public javax.management.MBeanServer getLocalMBeanServer()

Specified by:

getLocalMBeanServer in interface JmxConnectionProvider

getLabel

public java.lang.String getLabel()

getHost

public java.lang.String getHost()

getSource

public java.lang.String getSource()

getPort

public java.lang.String getPort()

getUrl

public java.lang.String getUrl()

The jmx url to connect to. If null, it builds this from host/port with a standard configuration. Other JVM's may want to set this value.

getJmxServiceURL

public javax.management.remote.JMXServiceURL getJmxServiceURL()
                                                       throws java.io.IOException

Throws:

java.io.IOException

isQueriesMultiThreaded

public boolean isQueriesMultiThreaded()

runOutputWriters

public void runOutputWriters(Query query,
                             java.lang.Iterable<Result> results)
                      throws java.lang.Exception

Throws:

java.lang.Exception

builder

public static Server.Builder builder()

builder

public static Server.Builder builder(Server server)