org.glassfish.admin.amx.impl.ext
Class ConnectorRuntimeAPIProviderImpl

java.lang.Object
  org.glassfish.admin.amx.impl.mbean.MBeanImplBase
      org.glassfish.admin.amx.impl.mbean.AMXImplBase
          org.glassfish.admin.amx.impl.ext.ConnectorRuntimeAPIProviderImpl

All Implemented Interfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, AMX_SPI, NotificationSender

public final class ConnectorRuntimeAPIProviderImpl
extends AMXImplBase

ConnectorRuntime exposed APIs via AMX

Field Summary

Fields inherited from class org.glassfish.admin.amx.impl.mbean.AMXImplBase

EMPTY_OBJECT_NAMES, GET, GET_PREFIX, mMBeanInfo, OBJECT_NAME_SUFFIX, SET

Fields inherited from class org.glassfish.admin.amx.impl.mbean.MBeanImplBase

EMPTY_STRING_ARRAY, mSelfObjectName, mServer

Constructor Summary

ConnectorRuntimeAPIProviderImpl(javax.management.ObjectName parent, org.jvnet.hk2.component.Habitat habitat)

Method Summary

java.util.Map<java.lang.String,java.lang.Object>	flushConnectionPool(java.lang.String poolName) Flush Connection pool.
java.util.Map<java.lang.String,java.lang.Object>	getActivationSpecClass(java.lang.String rarName, java.lang.String messageListenerType)
java.util.Map<java.lang.String,java.lang.Object>	getAdminObjectClassNames(java.lang.String rarName, java.lang.String intfName)
java.util.Map<java.lang.String,java.lang.Object>	getAdminObjectConfigProps(java.lang.String rarName, java.lang.String adminObjectIntf)
java.util.Map<java.lang.String,java.lang.Object>	getAdminObjectConfigProps(java.lang.String rarName, java.lang.String adminObjectIntf, java.lang.String adminObjectClass)
java.util.Map<java.lang.String,java.lang.Object>	getAdminObjectInterfaceNames(java.lang.String rarName)
java.util.Map<java.lang.String,java.lang.Object>	getBuiltInCustomResources()
java.util.Map<java.lang.String,java.lang.Object>	getConnectionDefinitionNames(java.lang.String rarName)
java.util.Map<java.lang.String,java.lang.Object>	getConnectionDefinitionPropertiesAndDefaults(java.lang.String datasourceClassName, java.lang.String resType) Obtain properties of the JDBC DataSource/Driver.
java.util.Map<java.lang.String,java.lang.Object>	getConnectorConfigJavaBeans(java.lang.String rarName, java.lang.String connectionDefName, java.lang.String type)
java.util.Map<java.lang.String,java.lang.Object>	getDatabaseVendorNames() Obtain a set of database vendor names.
java.util.Map<java.lang.String,java.lang.Object>	getJdbcDriverClassNames(java.lang.String dbVendor, java.lang.String resType) Obtain Jdbc driver implementation class names for a particular dbVendor and resource type.
java.util.Map<java.lang.String,java.lang.Object>	getJdbcDriverClassNames(java.lang.String dbVendor, java.lang.String resType, boolean introspect) Obtain Jdbc driver implementation class names for a particular dbVendor and resource type.
java.util.Map<java.lang.String,java.lang.Object>	getMCFConfigProps(java.lang.String rarName, java.lang.String connectionDefName)
java.util.Map<java.lang.String,java.lang.Object>	getMessageListenerConfigProps(java.lang.String rarName, java.lang.String messageListenerType)
java.util.Map<java.lang.String,java.lang.Object>	getMessageListenerConfigPropTypes(java.lang.String rarName, java.lang.String messageListenerType)
java.util.Map<java.lang.String,java.lang.Object>	getMessageListenerTypes(java.lang.String rarName)
java.util.Map<java.lang.String,java.lang.Object>	getResourceAdapterConfigProps(java.lang.String rarName)
java.util.Map<java.lang.String,java.lang.Object>	getSystemConnectorsAllowingPoolCreation()
java.util.Map<java.lang.String,java.lang.Object>	getValidationClassNames(java.lang.String className) Obtain a set of connection validation class names for the datasource/driver class name that the jdbc connection pool refers to.
java.util.Map<java.lang.String,java.lang.Object>	getValidationTableNames(java.lang.String poolName) Obtain connection validation table names for the database that the jdbc connection pool refers to.
java.util.Map<java.lang.String,java.lang.Object>	pingJDBCConnectionPool(java.lang.String poolName) Ping JDBC Connection Pool and return status.

Methods inherited from class org.glassfish.admin.amx.impl.mbean.AMXImplBase

attributeNameToType, attributeTypeMatches, cdebug, child, child, child, findGetter, findMethod, findSetter, getAncestorByType, getAttribute, getAttributeByMethod, getAttributeInfo, getAttributeInfos, getAttributeInternal, getAttributeManually, getAttributeNames, getAttributeNoThrow, getAttributes, getAttributeType, getChildren, getChildren, getChildren, getChildren, getChildrenMap, getDomainRoot, getDomainRootProxy, getLogger, getMBeanInfo, getMBeanTracker, getName, getNotificationInfo, getObjectNameAttribute, getObjectNames, getObjectNamesForAttribute, getParent, getParentProxy, getProxy, getProxyFactory, getSelf, getSelf, getterNameMatches, handleException, handleGetAttributeException, handleInvokeThrowable, impossible, invoke, invokeManually, isReadOnlyAttribute, isUtilityMBean, java, operationNameMatches, postRegisterHook, postRegisterModifyMBeanInfo, preDeregisterHook, preRegister, preRegisterDone, preRegisterHook, preRegisterModifyName, registerChild, registerChildren, sendAttributeChangeNotification, setAttribute, setAttributeByMethod, setAttributeInternal, setAttributeManually, setAttributes, shouldEmitNotifications, stringify, supportsChildren, toString, unimplementedAttribute, unimplementedOperation, unregisterChildren

Methods inherited from class org.glassfish.admin.amx.impl.mbean.MBeanImplBase

_getMBeanLogLevel, addNotificationListener, addNotificationListener, createNotificationBuilder, debug, debug, debugMethod, debugMethod, enableAMXDebug, getAMXDebug, getDebugID, getDebugOutput, getJMXDomain, getListenerCount, getMBeanLogger, getMBeanLoggerName, getMBeanLogLevel, getMBeanLogLevelInt, getMBeanServer, getNotificationBuilder, getNotificationEmitter, getNotificationTypeListenerCount, getObjectName, logFine, logFiner, logFinest, logInfo, logSevere, logWarning, postDeregister, postDeregisterHook, postRegister, preDeregister, quote, removeNotificationListener, removeNotificationListener, sendNotification, sendNotification, sendNotification, sendNotification, setAMXDebug, setMBeanLogLevel, shouldOmitObjectNameForDebug, sleepMillis, toString, trace

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, removeNotificationListener

Constructor Detail

ConnectorRuntimeAPIProviderImpl

public ConnectorRuntimeAPIProviderImpl(javax.management.ObjectName parent,
                                       org.jvnet.hk2.component.Habitat habitat)

Method Detail

getConnectionDefinitionPropertiesAndDefaults

public java.util.Map<java.lang.String,java.lang.Object> getConnectionDefinitionPropertiesAndDefaults(java.lang.String datasourceClassName,
                                                                                                     java.lang.String resType)

Obtain properties of the JDBC DataSource/Driver. This is used by the administration console to list all the additional properties for the particular resource type.

Parameters:

datasourceClassName -

resType - one of javax.sql.DataSource, javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, java.sql.Driver.

Returns:

a map containing a CONN_DEFINITION_PROPS_KEY with a map of connection definition properties with the default values. If CONN_DEFINITION_PROPS_KEY is null, an exception has occured and REASON_FAILED_KEY would give the reason why getting connection definition properties and its defaults failed.

getSystemConnectorsAllowingPoolCreation

public java.util.Map<java.lang.String,java.lang.Object> getSystemConnectorsAllowingPoolCreation()

getBuiltInCustomResources

public java.util.Map<java.lang.String,java.lang.Object> getBuiltInCustomResources()

getConnectionDefinitionNames

public java.util.Map<java.lang.String,java.lang.Object> getConnectionDefinitionNames(java.lang.String rarName)

getMCFConfigProps

public java.util.Map<java.lang.String,java.lang.Object> getMCFConfigProps(java.lang.String rarName,
                                                                          java.lang.String connectionDefName)

getAdminObjectInterfaceNames

public java.util.Map<java.lang.String,java.lang.Object> getAdminObjectInterfaceNames(java.lang.String rarName)

getAdminObjectClassNames

public java.util.Map<java.lang.String,java.lang.Object> getAdminObjectClassNames(java.lang.String rarName,
                                                                                 java.lang.String intfName)

getResourceAdapterConfigProps

public java.util.Map<java.lang.String,java.lang.Object> getResourceAdapterConfigProps(java.lang.String rarName)

getAdminObjectConfigProps

public java.util.Map<java.lang.String,java.lang.Object> getAdminObjectConfigProps(java.lang.String rarName,
                                                                                  java.lang.String adminObjectIntf,
                                                                                  java.lang.String adminObjectClass)

getAdminObjectConfigProps

public java.util.Map<java.lang.String,java.lang.Object> getAdminObjectConfigProps(java.lang.String rarName,
                                                                                  java.lang.String adminObjectIntf)

getConnectorConfigJavaBeans

public java.util.Map<java.lang.String,java.lang.Object> getConnectorConfigJavaBeans(java.lang.String rarName,
                                                                                    java.lang.String connectionDefName,
                                                                                    java.lang.String type)

getActivationSpecClass

public java.util.Map<java.lang.String,java.lang.Object> getActivationSpecClass(java.lang.String rarName,
                                                                               java.lang.String messageListenerType)

getMessageListenerTypes

public java.util.Map<java.lang.String,java.lang.Object> getMessageListenerTypes(java.lang.String rarName)

getMessageListenerConfigProps

public java.util.Map<java.lang.String,java.lang.Object> getMessageListenerConfigProps(java.lang.String rarName,
                                                                                      java.lang.String messageListenerType)

getMessageListenerConfigPropTypes

public java.util.Map<java.lang.String,java.lang.Object> getMessageListenerConfigPropTypes(java.lang.String rarName,
                                                                                          java.lang.String messageListenerType)

flushConnectionPool

public java.util.Map<java.lang.String,java.lang.Object> flushConnectionPool(java.lang.String poolName)

Flush Connection pool. This API is used by administration console for the Flush button the admin GUI. The connections in connection pool are re-initialized when flush is executed.

Parameters:

poolName -

Returns:

a map containing a FLUSH_CONNECTION_POOL_KEY with a boolean value indicating pass/fail. If FLUSH_CONNECTION_POOL_KEY is false, an exception has occured and REASON_FAILED_KEY would give the reason why getting flush connection pool failed.

getValidationTableNames

public java.util.Map<java.lang.String,java.lang.Object> getValidationTableNames(java.lang.String poolName)

Obtain connection validation table names for the database that the jdbc connection pool refers to. This is used by administration console to list the validation table names when connection validation is enabled and/or table is chosen for validation method.

Parameters:

poolName -

Returns:

a map containing a VALIDATION_TABLE_NAMES_KEY with a set of validation table names. If VALIDATION_TABLE_NAMES_KEY is null, an exception has occured and REASON_FAILED_KEY would give the reason why getting connection validation table names failed.

getJdbcDriverClassNames

public java.util.Map<java.lang.String,java.lang.Object> getJdbcDriverClassNames(java.lang.String dbVendor,
                                                                                java.lang.String resType)

Obtain Jdbc driver implementation class names for a particular dbVendor and resource type. This is used by the administration console to list the driver-classname or datasource-classname fields based on the resType provided.

Parameters:

dbVendor -

resType - one of javax.sql.DataSource, javax.sql.ConnectionPoolDataSource, javax.sql.XADataSource, java.sql.Driver.

Returns:

a map containing a JDBC_DRIVER_CLASS_NAMES_KEY with a set of datasource/driver class names. If JDBC_DRIVER_CLASS_NAMES_KEY is null, an exception has occured and REASON_FAILED_KEY would give the reason why getting datasource/driver classnames failed.

getJdbcDriverClassNames

public java.util.Map<java.lang.String,java.lang.Object> getJdbcDriverClassNames(java.lang.String dbVendor,
                                                                                java.lang.String resType,
                                                                                boolean introspect)

Obtain Jdbc driver implementation class names for a particular dbVendor and resource type. This is used by the administration console to list the driver-classname or datasource-classname fields based on the resType provided. The classnames retrieved are introspected from jdbc driver jar or got from the pre-defined list based on the introspect flag.

Parameters:

dbVendor -

resType - one of javax.sql.DataSource, javax.sql.ConnectionPoolDataSource, javax.sql.XADataSource, java.sql.Driver.

introspect - introspect or quick select from list

Returns:

a map containing a JDBC_DRIVER_CLASS_NAMES_KEY with a set of datasource/driver class names. If JDBC_DRIVER_CLASS_NAMES_KEY is null, an exception has occured and REASON_FAILED_KEY would give the reason why getting datasource/driver classnames failed.

pingJDBCConnectionPool

public java.util.Map<java.lang.String,java.lang.Object> pingJDBCConnectionPool(java.lang.String poolName)

Ping JDBC Connection Pool and return status. This API is used for the Ping button in the administration console. Ping could be executed for a connection pool after its creation to verify if the connection pool is usable.

Parameters:

poolName -

Returns:

a map containing a PING_CONNECTION_POOL_KEY with a boolean value indicating a pass/fail. If PING_CONNECTION_POOL_KEY is false, an exception has occured and REASON_FAILED_KEY would give the reason why ping connection pool failed.

getValidationClassNames

public java.util.Map<java.lang.String,java.lang.Object> getValidationClassNames(java.lang.String className)

Obtain a set of connection validation class names for the datasource/driver class name that the jdbc connection pool refers to. This API is used when custom-validation is chosen as the connection validation method, to list the various custom validation implementations available.

Parameters:

className -

Returns:

a map containing a VALIDATION_CLASS_NAMES_KEY with a set of validation class names. If VALIDATION_CLASS_NAMES_KEY is null, an exception has occured and REASON_FAILED_KEY would give the reason why getting connection validation classnames failed.

getDatabaseVendorNames

public java.util.Map<java.lang.String,java.lang.Object> getDatabaseVendorNames()

Obtain a set of database vendor names. This API is used to list the various common database vendor names.

Returns:

a map containing a DATABASE_VENDOR_NAMES_KEY with a set of database vendor names. If DATABASE_VENDOR_NAMES_KEY is null, an exception has occured and REASON_FAILED_KEY would give the reason why getting database vendor names failed.