org.objectweb.cjdbc.common.jmx
Class JmxConstants

java.lang.Object
  org.objectweb.cjdbc.common.jmx.JmxConstants

public final class JmxConstants

extends java.lang.Object

This class contains static information on the jmx services.

Version:

1.0

Author:

Nicolas Modrzyk

Field Summary

static java.lang.String	ADAPTOR_TYPE_HTTP Http adaptor
static java.lang.String	ADAPTOR_TYPE_RMI RMI Adaptor
static java.lang.String	CJDBC_DOMAIN_NAME This is in the xsl transformation file, so we should leave as is.
static java.lang.String	CJDBC_TYPE_BACKEND the backend mbean type
private static java.lang.String	CJDBC_TYPE_CACHE the cache mbean type
static java.lang.String	CJDBC_TYPE_CONTROLLER the controller mbean type
static java.lang.String	CJDBC_TYPE_DATACOLLECTOR the data collector mbean type
private static java.lang.String	CJDBC_TYPE_LOAD_BALANCER
private static java.lang.String	CJDBC_TYPE_RECOVERYLOG the recovery log mbean type
private static java.lang.String	CJDBC_TYPE_REQUEST_MANAGER the request manager mbean type
static java.lang.String	CJDBC_TYPE_VIRTUALDATABASE the virtual database mbean type
static java.lang.String	CONNECTOR_AUTH_PASSWORD jmx authenticator password
static java.lang.String	CONNECTOR_AUTH_USERNAME jmx authenticator username
static java.lang.String	CONNECTOR_RMI_SSL ssl config for rmi
static boolean	DEBUG Overall Debug tag for Jmx calls
static java.lang.String	DEFAULT_JMX_AGENT_NAME The default jmx name for the agent to connect to
static int	DEFAULT_JMX_HTTP_PORT Default JMX server HTTP adaptor port value.
static int	DEFAULT_JMX_RMI_PORT Default RMI port number value.
static java.lang.String	JMX_DEFAULT_DOMAIN_NAME Default domain name for JMX
static java.lang.String	JMX_DEFAULT_MBEAN_TYPE Default Jmx type
static java.lang.String	JndiName Reference name for Jndi
static boolean	KEEP_CONNECTION_ALIVE Keep connection alive ?

Constructor Summary

JmxConstants()

Method Summary

static javax.management.ObjectName	getCacheObjectName(java.lang.String vdbName) Get the associated cache object name
static javax.management.ObjectName	getControllerObjectName() Get the associated controller object name
static javax.management.ObjectName	getDatabaseBackendObjectName(java.lang.String vdbName, java.lang.String name) Get the associated data collector object name
static javax.management.ObjectName	getDataCollectorObjectName() Get the associated data collector object name
static javax.management.ObjectName	getJmxObjectName(java.lang.String name, java.lang.String type) Get the associated jmx object name
static javax.management.ObjectName	getLoadBalancerObjectName(java.lang.String name) Get the associated request manager object name
static javax.management.ObjectName	getRecoveryLogObjectName(java.lang.String vdbName) Get the associated recovery log object name
static javax.management.ObjectName	getRequestManagerObjectName(java.lang.String vdbName) Get the associated request manager object name
static javax.management.ObjectName	getVirtualDbObjectName(java.lang.String name) Get the associated virtualdatabase object name
static javax.management.ObjectName	getVirtualDbObjectNameFromBackend(javax.management.ObjectName backend) Retrieve the owning database objectname of this backend's objectname
static boolean	mbeanNeedAuthentication(javax.management.ObjectName mbean) C-JDBC rules to determine if a mbean need authentication or not.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final boolean DEBUG

Overall Debug tag for Jmx calls

See Also:

Constant Field Values

KEEP_CONNECTION_ALIVE

public static final boolean KEEP_CONNECTION_ALIVE

Keep connection alive ?

See Also:

Constant Field Values

JMX_DEFAULT_DOMAIN_NAME

public static final java.lang.String JMX_DEFAULT_DOMAIN_NAME

Default domain name for JMX

See Also:

Constant Field Values

JMX_DEFAULT_MBEAN_TYPE

public static final java.lang.String JMX_DEFAULT_MBEAN_TYPE

Default Jmx type

See Also:

Constant Field Values

JndiName

public static final java.lang.String JndiName

Reference name for Jndi

See Also:

Constant Field Values

DEFAULT_JMX_AGENT_NAME

public static final java.lang.String DEFAULT_JMX_AGENT_NAME

The default jmx name for the agent to connect to

See Also:

Constant Field Values

ADAPTOR_TYPE_RMI

public static final java.lang.String ADAPTOR_TYPE_RMI

RMI Adaptor

See Also:

Constant Field Values

CONNECTOR_RMI_SSL

public static final java.lang.String CONNECTOR_RMI_SSL

ssl config for rmi

See Also:

Constant Field Values

ADAPTOR_TYPE_HTTP

public static final java.lang.String ADAPTOR_TYPE_HTTP

Http adaptor

See Also:

Constant Field Values

CONNECTOR_AUTH_USERNAME

public static final java.lang.String CONNECTOR_AUTH_USERNAME

jmx authenticator username

See Also:

Constant Field Values

CONNECTOR_AUTH_PASSWORD

public static final java.lang.String CONNECTOR_AUTH_PASSWORD

jmx authenticator password

See Also:

Constant Field Values

DEFAULT_JMX_RMI_PORT

public static final int DEFAULT_JMX_RMI_PORT

Default RMI port number value.

See Also:

Constant Field Values

DEFAULT_JMX_HTTP_PORT

public static final int DEFAULT_JMX_HTTP_PORT

Default JMX server HTTP adaptor port value.

See Also:

Constant Field Values

CJDBC_DOMAIN_NAME

public static final java.lang.String CJDBC_DOMAIN_NAME

This is in the xsl transformation file, so we should leave as is. Other domain are filtered.

See Also:

Constant Field Values

CJDBC_TYPE_CONTROLLER

public static final java.lang.String CJDBC_TYPE_CONTROLLER

the controller mbean type

See Also:

Constant Field Values

CJDBC_TYPE_VIRTUALDATABASE

public static final java.lang.String CJDBC_TYPE_VIRTUALDATABASE

the virtual database mbean type

See Also:

Constant Field Values

CJDBC_TYPE_DATACOLLECTOR

public static final java.lang.String CJDBC_TYPE_DATACOLLECTOR

the data collector mbean type

See Also:

Constant Field Values

CJDBC_TYPE_BACKEND

public static final java.lang.String CJDBC_TYPE_BACKEND

the backend mbean type

See Also:

Constant Field Values

CJDBC_TYPE_RECOVERYLOG

private static final java.lang.String CJDBC_TYPE_RECOVERYLOG

the recovery log mbean type

See Also:

Constant Field Values

CJDBC_TYPE_CACHE

private static final java.lang.String CJDBC_TYPE_CACHE

the cache mbean type

See Also:

Constant Field Values

CJDBC_TYPE_REQUEST_MANAGER

private static final java.lang.String CJDBC_TYPE_REQUEST_MANAGER

the request manager mbean type

See Also:

Constant Field Values

CJDBC_TYPE_LOAD_BALANCER

private static final java.lang.String CJDBC_TYPE_LOAD_BALANCER

See Also:

Constant Field Values

Constructor Detail

JmxConstants

public JmxConstants()

Method Detail

getJmxObjectName

public static javax.management.ObjectName getJmxObjectName(java.lang.String name,
                                                           java.lang.String type)

Get the associated jmx object name

Parameters:

name - the name of the mbean

type - the c-jdbc type of the mbean

Returns:

the associated object name, no exception is thrown as the object name calculated is always valid ex; c-jdbc:type:=<type>:name:=<name>

getControllerObjectName

public static javax.management.ObjectName getControllerObjectName()

Get the associated controller object name

Returns:

c-jdbc:type:=<controller>:name:=<name>

getVirtualDbObjectName

public static javax.management.ObjectName getVirtualDbObjectName(java.lang.String name)

Get the associated virtualdatabase object name

Parameters:

name - the name of the virtualdatabase

Returns:

c-jdbc:type:=<virtualdatabase>:name:=<name>

getDataCollectorObjectName

public static javax.management.ObjectName getDataCollectorObjectName()

Get the associated data collector object name

Returns:

c-jdbc:type:=<datacollector>:name:=<name>

getDatabaseBackendObjectName

public static javax.management.ObjectName getDatabaseBackendObjectName(java.lang.String vdbName,
                                                                       java.lang.String name)

Get the associated data collector object name

Parameters:

vdbName - name of the virtual database

name - name of the backend

Returns:

c-jdbc:type:=<datacollector>:name:=<name>

getRecoveryLogObjectName

public static javax.management.ObjectName getRecoveryLogObjectName(java.lang.String vdbName)

Get the associated recovery log object name

Parameters:

vdbName - name of the virtual database

Returns:

c-jdbc:type:=<recoverylog>:name:=<name>

getCacheObjectName

public static javax.management.ObjectName getCacheObjectName(java.lang.String vdbName)

Get the associated cache object name

Parameters:

vdbName - name of the virtual database

Returns:

c-jdbc:type:=<cache>:name:=<name>

getRequestManagerObjectName

public static javax.management.ObjectName getRequestManagerObjectName(java.lang.String vdbName)

Get the associated request manager object name

Parameters:

vdbName - name of the virtual database

Returns:

c-jdbc:type:=<requestmanager>:name:=<name>

getVirtualDbObjectNameFromBackend

public static javax.management.ObjectName getVirtualDbObjectNameFromBackend(javax.management.ObjectName backend)

Retrieve the owning database objectname of this backend's objectname

Parameters:

backend - the objectname of the backend

Returns:

the objectname of the owning database.

getLoadBalancerObjectName

public static javax.management.ObjectName getLoadBalancerObjectName(java.lang.String name)

Get the associated request manager object name

Parameters:

name - name of the virtual database

Returns:

c-jdbc:type:=<--loadbalancer>:name:=<name>

mbeanNeedAuthentication

public static boolean mbeanNeedAuthentication(javax.management.ObjectName mbean)

C-JDBC rules to determine if a mbean need authentication or not. By default all the mbeans need authentication apart from the controller mbean and the data collector mbean

Parameters:

mbean - ObjectName of the mbean to test

Returns:

true if the call to the mbean should have a user and a password attribute attached to it.