com.googlecode.jmxtrans.model

Class Server

java.lang.Object

com.googlecode.jmxtrans.model.Server

@Immutable
@ThreadSafe
public class Server
extends Object

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 host, String port, String username, String password, String protocolProviderPackages, String url, String cronExpression, Integer numQueryThreads, boolean local, List<Query> queries)

Method Summary

Methods

Modifier and Type	Method and Description
static Server.Builder	builder()
static Server.Builder	builder(Server server)
boolean	equals(Object o)
String	getAlias() Some writers (GraphiteWriter) use the alias in generation of the unique key which references this server.
String	getCronExpression() Each server can set a cronExpression for the scheduler.
com.google.common.collect.ImmutableMap<String,?>	getEnvironment() Generates the proper username/password environment for JMX connections.
String	getHost()
JMXServiceURL	getJmxServiceURL()
MBeanServer	getLocalMBeanServer()
Integer	getNumQueryThreads() The number of query threads for this server.
String	getPassword()
String	getPort()
String	getProtocolProviderPackages() This is some obtuse shit for enabling weblogic support.
com.google.common.collect.ImmutableSet<Query>	getQueries()
JMXConnector	getServerConnection() Helper method for connecting to a Server.
String	getUrl() The jmx url to connect to.
String	getUsername()
int	hashCode()
boolean	isLocal() Whether the current local Java process should be used or not (useful for polling the embedded JVM when using JmxTrans inside a JVM to poll JMX stats and push them remotely)
boolean	isQueriesMultiThreaded()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Server

public Server(String alias,
      String host,
      String port,
      String username,
      String password,
      String protocolProviderPackages,
      String url,
      String cronExpression,
      Integer numQueryThreads,
      boolean local,
      List<Query> queries)

Method Detail

getEnvironment

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

Generates the proper username/password environment for JMX connections.

getServerConnection

public JMXConnector getServerConnection()
                                 throws Exception

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

Throws:

Exception

getLocalMBeanServer

public MBeanServer getLocalMBeanServer()

getAlias

public String getAlias()

Some writers (GraphiteWriter) use the alias in generation of the unique key which references this server.

getHost

public String getHost()

getPort

public String getPort()

getUsername

public String getUsername()

getPassword

public String getPassword()

isLocal

public boolean isLocal()

Whether the current local Java process should be used or not (useful for polling the embedded JVM when using JmxTrans inside a JVM to poll JMX stats and push them remotely)

getQueries

public com.google.common.collect.ImmutableSet<Query> getQueries()

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 MalformedURLException

Throws:

MalformedURLException

isQueriesMultiThreaded

public boolean isQueriesMultiThreaded()

getNumQueryThreads

public Integer getNumQueryThreads()

The number of query threads for this server.

getCronExpression

public String getCronExpression()

Each server can set a cronExpression for the scheduler. If the cronExpression is null, then the job is run immediately and once. Otherwise, it is added to the scheduler for immediate execution and run according to the cronExpression.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getProtocolProviderPackages

public String getProtocolProviderPackages()

This is some obtuse shit for enabling weblogic support.

http://download.oracle.com/docs/cd/E13222_01/wls/docs90/jmx/accessWLS. html

You'd set this to: weblogic.management.remote

builder

public static Server.Builder builder()

builder

public static Server.Builder builder(Server server)