com.googlecode.jmxtrans.model

Class Server

java.lang.Object

com.googlecode.jmxtrans.model.Server

All Implemented Interfaces:

JmxConnectionProvider

@Immutable
 @ThreadSafe
public class Server
extends 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(String alias, String pid, String host, String port, String username, String password, String protocolProviderPackages, String url, String cronExpression, Integer runPeriodSeconds, Integer numQueryThreads, boolean local, List<Query> queries, com.google.common.collect.ImmutableList<OutputWriter> outputWriters, org.apache.commons.pool.KeyedObjectPool<JmxConnectionProvider,JMXConnection> pool)
Server(String alias, String pid, String host, String port, String username, String password, String protocolProviderPackages, String url, String cronExpression, Integer runPeriodSeconds, Integer numQueryThreads, boolean local, List<Query> queries, 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)
Iterable<Result>	execute(Query query)
com.google.common.collect.ImmutableMap<String,?>	getEnvironment() Generates the proper username/password environment for JMX connections.
String	getHost()
JMXServiceURL	getJmxServiceURL()
MBeanServer	getLocalMBeanServer()
String	getPort()
JMXConnector	getServerConnection() Helper method for connecting to a Server.
String	getSource()
String	getUrl() The jmx url to connect to.
boolean	isQueriesMultiThreaded()
void	runOutputWriters(Query query, 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(String alias,
              String pid,
              String host,
              String port,
              String username,
              String password,
              String protocolProviderPackages,
              String url,
              String cronExpression,
              Integer runPeriodSeconds,
              Integer numQueryThreads,
              boolean local,
              List<Query> queries,
              List<OutputWriterFactory> outputWriters,
              org.apache.commons.pool.KeyedObjectPool<JmxConnectionProvider,JMXConnection> pool)

Server

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

Method Detail

execute

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

Throws:

Exception

getEnvironment

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

Generates the proper username/password environment for JMX connections.

getServerConnection

public JMXConnector getServerConnection()
                                 throws IOException

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

Specified by:

getServerConnection in interface JmxConnectionProvider

Throws:

IOException

getLocalMBeanServer

public MBeanServer getLocalMBeanServer()

Specified by:

getLocalMBeanServer in interface JmxConnectionProvider

getHost

public String getHost()

getSource

public String getSource()

getPort

public String getPort()

getUrl

public 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 JMXServiceURL getJmxServiceURL()
                               throws IOException

Throws:

IOException

isQueriesMultiThreaded

public boolean isQueriesMultiThreaded()

runOutputWriters

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

Throws:

Exception

builder

public static Server.Builder builder()

builder

public static Server.Builder builder(Server server)