org.apache.derbyTesting.functionTests.tests.management

Class MBeanTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.apache.derbyTesting.junit.BaseTestCase

org.apache.derbyTesting.junit.BaseJDBCTestCase

org.apache.derbyTesting.functionTests.tests.management.MBeanTest

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

InactiveManagementMBeanTest, JDBCMBeanTest, JMXTest, ManagementMBeanTest, NetworkServerMBeanTest, VersionMBeanTest

abstract class MBeanTest
extends BaseJDBCTestCase

Class that provided utility methods for the testing of Derby's MBeans. Requires J2SE 5.0 or higher (platform management). Subclasses may require JDBC access for verifying values returned by the MBeans, which is why this class extends BaseJDBCTestCase instead of BaseTestCase.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.management.MBeanServerConnection	jmxConnection JMX connection to use throughout the instance.

Fields inherited from class org.apache.derbyTesting.junit.BaseTestCase

DEFAULT_DB_DIR, DERBY_LOG, ERRORSTACKTRACEFILE

Constructor Summary

Constructors

Constructor and Description
MBeanTest(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected void	assertBooleanAttribute(boolean expected, javax.management.ObjectName objName, java.lang.String name)
protected void	assertIntAttribute(int expected, javax.management.ObjectName objName, java.lang.String name)
protected void	assertLongAttribute(int expected, javax.management.ObjectName objName, java.lang.String name)
protected void	assertStringAttribute(java.lang.String expected, javax.management.ObjectName objName, java.lang.String name)
protected void	checkBooleanAttributeValue(javax.management.ObjectName objName, java.lang.String name) Checks the readability and type of an attribute value that is supposed to be a boolean.
protected void	checkIntAttributeValue(javax.management.ObjectName objName, java.lang.String name) Checks the readability and type of an attribute value that is supposed to be an int.
protected void	checkLongAttributeValue(javax.management.ObjectName objName, java.lang.String name) Checks the readability and type of an attribute value that is supposed to be a long.
protected void	checkStringAttributeValue(javax.management.ObjectName objName, java.lang.String name) Checks the readability and type of an attribute value that is supposed to be a String.
protected void	enableManagement() Enables Derby's MBeans in the MBeanServer by accessing Derby's ManagementMBean.
protected javax.management.ObjectName	getApplicationManagementMBean() Get the ObjectName for the application created ManagementMBean.
protected java.lang.Object	getAttribute(javax.management.ObjectName objName, java.lang.String name) Gets the value of a given attribute that is exposed by the MBean represented by the given object name.
protected static java.lang.String[]	getCommandLineProperties(boolean authentication) Returns a set of startup properties suitable for VersionMBeanTest.
protected java.util.Set<javax.management.ObjectName>	getDerbyDomainMBeans() Get all MBeans registered in Derby's domain.
protected javax.management.ObjectName	getDerbyMBeanName(java.util.Hashtable<java.lang.String,java.lang.String> keyProperties) Get the ObjectName for an MBean registered by Derby for a set of key properties.
protected javax.management.MBeanServerConnection	getMBeanServerConnection() Obtains a connection to an MBean server with no user name or password, opens a single connection for the lifetime of the fixture
protected javax.management.MBeanServerConnection	getMBeanServerConnection(java.lang.String user, java.lang.String password) Obtains a connection to an MBean server with a user name or password.
protected java.lang.Object	invokeOperation(javax.management.ObjectName objName, java.lang.String name) Invokes an operation with no arguments.
protected java.lang.Object	invokeOperation(javax.management.ObjectName objName, java.lang.String name, java.lang.Object[] params, java.lang.String[] sign) Invokes an operation with arguments.
protected boolean	isPlatformJMXClient() Is the JMX connecting using platform JMX.
protected void	setUp() Setup code to be run before each test fixture.
protected static junit.framework.Test	suite(java.lang.Class<? extends MBeanTest> testClass, java.lang.String suiteName)
protected void	tearDown() Tear down this fixture, sub-classes should call super.tearDown().

Methods inherited from class org.apache.derbyTesting.junit.BaseJDBCTestCase

assertCallError, assertCheckTable, assertCompileError, assertEquals, assertEquals, assertEquals, assertEquivalentDataType, assertErrorCode, assertGetIntError, assertNextError, assertPreparedStatementError, assertSQLExceptionEquals, assertSQLState, assertSQLState, assertStatementError, assertStatementError, assertStatementError, assertStatementError, assertStatementErrorUnordered, assertTableRowCount, assertUpdateCount, assertUpdateCount, assertWarning, checkAllConsistency, checkEstimatedRowCount, closeStatement, commit, createStatement, createStatement, createStatement, dropTable, dropTable, dropView, dropView, emptyStatementCache, getClientTransactionID, getConnection, getDatabaseProperty, getLastSQLException, initializeConnection, openConnection, openDefaultConnection, openDefaultConnection, openDefaultConnection, openUserConnection, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, rollback, runBare, runBareOverridable, runScript, runScript, runSQLCommands, setAutoCommit, usingDB2Client, usingDerbyNetClient, usingEmbedded

Methods inherited from class org.apache.derbyTesting.junit.BaseTestCase

alarm, assertDirectoryDeleted, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertExecJavaCmdAsExpected, assertLaunchedJUnitTestMethod, assertLaunchedJUnitTestMethod, assertSecurityManager, assertThrowableEquals, currentDirectory, execJavaCmd, execJavaCmd, fail, getClassVersionMajor, getEmmaJar, getFailureFolder, getFilesWith, getJavaExecutableName, getSystemProperty, getTestConfiguration, getTestResource, hasInterruptibleIO, isCVM, isIBMJVM, isJ9Platform, isJava5, isJava7, isJava8, isPhoneME, isPlatform, isSunJVM, isWindowsPlatform, openTestResource, println, printStackTrace, readProcessOutput, removeDirectory, removeDirectory, removeFiles, removeSystemProperty, runsWithEmma, runsWithJaCoCo, setSystemProperty, sleep, sleepAtLeastOneTick, traceit

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runTest, setName, toString

Methods inherited from class java.lang.Object

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

Field Detail

jmxConnection

private javax.management.MBeanServerConnection jmxConnection

JMX connection to use throughout the instance.

Constructor Detail

MBeanTest

public MBeanTest(java.lang.String name)

Method Detail

suite

protected static junit.framework.Test suite(java.lang.Class<? extends MBeanTest> testClass,
                                            java.lang.String suiteName)

getCommandLineProperties

protected static java.lang.String[] getCommandLineProperties(boolean authentication)

Returns a set of startup properties suitable for VersionMBeanTest. These properties are used to configure JMX in a different JVM. Will set up remote JMX using the port defined by the current test configuration, and with JMX security (authentication & SSL) disabled.

Returns:

a set of Java system properties to be set on the command line when starting a new JVM in order to enable remote JMX.

setUp

protected void setUp()
              throws java.lang.Exception

Setup code to be run before each test fixture. This method will make sure that JMX Management is enabled in Derby, so that the test fixtures can access Derby's MBeans without problems.

Overrides:

setUp in class junit.framework.TestCase

Throws:

java.lang.Exception - if an unexpected Exception occurs

tearDown

protected void tearDown()
                 throws java.lang.Exception

Description copied from class: BaseJDBCTestCase

Tear down this fixture, sub-classes should call super.tearDown(). This cleanups & closes the connection if it is open and any statement objects returned through the utility methods.

Overrides:

tearDown in class BaseJDBCTestCase

Throws:

java.lang.Exception

getMBeanServerConnection

protected javax.management.MBeanServerConnection getMBeanServerConnection()
                                                                   throws java.lang.Exception

Obtains a connection to an MBean server with no user name or password, opens a single connection for the lifetime of the fixture

Returns:

a plain connection to an MBean server

Throws:

java.lang.Exception

getMBeanServerConnection

protected javax.management.MBeanServerConnection getMBeanServerConnection(java.lang.String user,
                                                                          java.lang.String password)
                                                                   throws java.lang.Exception

Obtains a connection to an MBean server with a user name or password. A new connection is returned for each call.

Throws:

java.lang.Exception

isPlatformJMXClient

protected boolean isPlatformJMXClient()

Is the JMX connecting using platform JMX.

Returns:

True jmx connections via the platform server, false remote connections.

enableManagement

protected void enableManagement()
                         throws java.lang.Exception

Enables Derby's MBeans in the MBeanServer by accessing Derby's ManagementMBean. If Derby JMX management has already been enabled, no changes will be made. The test fixtures in some subclasses require that JMX Management is enabled in Derby, hence this method.

Throws:

java.lang.Exception - JMX-related exceptions if an unexpected error occurs.

getDerbyDomainMBeans

protected java.util.Set<javax.management.ObjectName> getDerbyDomainMBeans()
                                                                   throws java.lang.Exception

Get all MBeans registered in Derby's domain.

Returns:

Set of ObjectNames for all of Derby's registered MBeans.

Throws:

java.lang.Exception

getApplicationManagementMBean

protected javax.management.ObjectName getApplicationManagementMBean()
                                                             throws java.lang.Exception

Get the ObjectName for the application created ManagementMBean. The MBean will be created if it is not already registered.

Throws:

java.lang.Exception

getDerbyMBeanName

protected javax.management.ObjectName getDerbyMBeanName(java.util.Hashtable<java.lang.String,java.lang.String> keyProperties)
                                                 throws java.lang.Exception

Get the ObjectName for an MBean registered by Derby for a set of key properties. The ObjectName has the domain org.apache.derby, and the key property system will be set to the system identifier for the Derby system under test (if Derby is running).

Parameters:

keyProperties - Set of key properties, may be modified by this call.

Returns:

ObjectName to access MBean.

Throws:

java.lang.Exception

invokeOperation

protected java.lang.Object invokeOperation(javax.management.ObjectName objName,
                                           java.lang.String name)
                                    throws java.lang.Exception

Invokes an operation with no arguments.

Parameters:

objName - MBean to operate on

name - Operation name.

Returns:

the value returned by the operation being invoked, or null if there is no return value.

Throws:

java.lang.Exception

invokeOperation

protected java.lang.Object invokeOperation(javax.management.ObjectName objName,
                                           java.lang.String name,
                                           java.lang.Object[] params,
                                           java.lang.String[] sign)
                                    throws java.lang.Exception

Invokes an operation with arguments.

Parameters:

objName - MBean to operate on

name - Operation name.

params - An array containing the parameters to be set when the operation is invoked.

sign - An array containing the signature of the operation, i.e. the types of the parameters.

Returns:

the value returned by the operation being invoked, or null if there is no return value.

Throws:

java.lang.Exception

getAttribute

protected java.lang.Object getAttribute(javax.management.ObjectName objName,
                                        java.lang.String name)
                                 throws java.lang.Exception

Gets the value of a given attribute that is exposed by the MBean represented by the given object name.

Parameters:

objName - the object name defining a specific MBean instance

name - the name of the attribute

Returns:

the value of the attribute

Throws:

java.lang.Exception - if an unexpected error occurs

assertBooleanAttribute

protected void assertBooleanAttribute(boolean expected,
                                      javax.management.ObjectName objName,
                                      java.lang.String name)
                               throws java.lang.Exception

Throws:

java.lang.Exception

assertIntAttribute

protected void assertIntAttribute(int expected,
                                  javax.management.ObjectName objName,
                                  java.lang.String name)
                           throws java.lang.Exception

Throws:

java.lang.Exception

assertLongAttribute

protected void assertLongAttribute(int expected,
                                   javax.management.ObjectName objName,
                                   java.lang.String name)
                            throws java.lang.Exception

Throws:

java.lang.Exception

assertStringAttribute

protected void assertStringAttribute(java.lang.String expected,
                                     javax.management.ObjectName objName,
                                     java.lang.String name)
                              throws java.lang.Exception

Throws:

java.lang.Exception

checkBooleanAttributeValue

protected void checkBooleanAttributeValue(javax.management.ObjectName objName,
                                          java.lang.String name)
                                   throws java.lang.Exception

Checks the readability and type of an attribute value that is supposed to be a boolean.

Parameters:

objName - the object name representing the MBean instance from which the attribute value will be retreived

name - the name of the attribute

Throws:

java.lang.Exception - if an unexpected error occurs

checkIntAttributeValue

protected void checkIntAttributeValue(javax.management.ObjectName objName,
                                      java.lang.String name)
                               throws java.lang.Exception

Checks the readability and type of an attribute value that is supposed to be an int.

Parameters:

objName - the object name representing the MBean instance from which the attribute value will be retreived

name - the name of the attribute

Throws:

java.lang.Exception - if an unexpected error occurs

checkLongAttributeValue

protected void checkLongAttributeValue(javax.management.ObjectName objName,
                                       java.lang.String name)
                                throws java.lang.Exception

Checks the readability and type of an attribute value that is supposed to be a long.

Parameters:

objName - the object name representing the MBean instance from which the attribute value will be retreived

name - the name of the attribute

Throws:

java.lang.Exception - if an unexpected error occurs

checkStringAttributeValue

protected void checkStringAttributeValue(javax.management.ObjectName objName,
                                         java.lang.String name)
                                  throws java.lang.Exception

Checks the readability and type of an attribute value that is supposed to be a String.

Parameters:

objName - the object name representing the MBean instance from which the attribute value will be retreived

name - the name of the attribute

Throws:

java.lang.Exception - if an unexpected error occurs