|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.archive.util.JEMBeanHelper
public class JEMBeanHelper
JEMBeanHelper is a utility class for the MBean implementation which wants to add management of a JE environment to its capabilities. MBean implementations can contain a JEMBeanHelper instance to get MBean metadata for JE and to set attributes, get attributes, and invoke operations.
com.sleepycat.je.jmx.JEMonitor and the example program jmx.JEApplicationMBean are two MBean implementations which provide support different application use cases. See those classes for examples of how to use JEMBeanHelper.
This class was copied from the bdb je 2.0 jmx examples.
Field Summary | |
---|---|
static java.lang.String |
ATT_CACHE_PERCENT
|
static java.lang.String |
ATT_CACHE_SIZE
|
static java.lang.String |
ATT_ENV_HOME
|
static java.lang.String |
ATT_IS_READ_ONLY
|
static java.lang.String |
ATT_IS_SERIALIZABLE
|
static java.lang.String |
ATT_IS_TRANSACTIONAL
|
static java.lang.String |
ATT_LOCK_TIMEOUT
|
static java.lang.String |
ATT_OPEN
|
static java.lang.String |
ATT_SET_READ_ONLY
|
static java.lang.String |
ATT_SET_SERIALIZABLE
|
static java.lang.String |
ATT_SET_TRANSACTIONAL
|
static java.lang.String |
ATT_TXN_TIMEOUT
|
(package private) static java.lang.String |
OP_CHECKPOINT
|
(package private) static java.lang.String |
OP_CLEAN
|
(package private) static java.lang.String |
OP_DB_NAMES
|
(package private) static java.lang.String |
OP_DB_STAT
|
(package private) static java.lang.String |
OP_ENV_STAT
|
(package private) static java.lang.String |
OP_ENV_STAT_STR
|
(package private) static java.lang.String |
OP_EVICT
|
(package private) static java.lang.String |
OP_LOCK_STAT
|
(package private) static java.lang.String |
OP_LOCK_STAT_STR
|
(package private) static java.lang.String |
OP_SYNC
|
(package private) static java.lang.String |
OP_TXN_STAT
|
Constructor Summary | |
---|---|
JEMBeanHelper(com.sleepycat.je.EnvironmentConfig config,
java.io.File environmentHome,
boolean canConfigure)
Instantiate a helper, specifying environment home and open capabilities. |
Method Summary | |
---|---|
java.lang.Object |
getAttribute(com.sleepycat.je.Environment targetEnv,
java.lang.String attributeName)
Get an attribute value for the given environment. |
java.util.List<javax.management.MBeanAttributeInfo> |
getAttributeList(com.sleepycat.je.Environment targetEnv)
Get MBean attribute metadata for this environment. |
java.io.File |
getEnvironmentHome()
Return the target environment directory. |
com.sleepycat.je.Environment |
getEnvironmentIfOpen()
Return an Environment only if the environment has already been opened in this process. |
com.sleepycat.je.EnvironmentConfig |
getEnvironmentOpenConfig()
If the helper was instantiated with canConfigure==true, it shows environment configuration attributes. |
boolean |
getNeedReset()
Tell the MBean if the available set of functionality has changed. |
javax.management.MBeanNotificationInfo[] |
getNotificationInfo(com.sleepycat.je.Environment targetEnv)
No notifications are supported. |
java.util.List<javax.management.MBeanOperationInfo> |
getOperationList(com.sleepycat.je.Environment targetEnv)
Get mbean operation metadata for this environment. |
java.lang.Object |
invoke(com.sleepycat.je.Environment targetEnv,
java.lang.String actionName,
java.lang.Object[] params,
java.lang.String[] signature)
Invoke an operation for the given environment. |
void |
setAttribute(com.sleepycat.je.Environment targetEnv,
javax.management.Attribute attribute)
Set an attribute value for the given environment. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATT_ENV_HOME
public static final java.lang.String ATT_OPEN
public static final java.lang.String ATT_IS_READ_ONLY
public static final java.lang.String ATT_IS_TRANSACTIONAL
public static final java.lang.String ATT_CACHE_SIZE
public static final java.lang.String ATT_CACHE_PERCENT
public static final java.lang.String ATT_LOCK_TIMEOUT
public static final java.lang.String ATT_IS_SERIALIZABLE
public static final java.lang.String ATT_TXN_TIMEOUT
public static final java.lang.String ATT_SET_READ_ONLY
public static final java.lang.String ATT_SET_TRANSACTIONAL
public static final java.lang.String ATT_SET_SERIALIZABLE
static final java.lang.String OP_CLEAN
static final java.lang.String OP_EVICT
static final java.lang.String OP_CHECKPOINT
static final java.lang.String OP_SYNC
static final java.lang.String OP_ENV_STAT
static final java.lang.String OP_ENV_STAT_STR
static final java.lang.String OP_LOCK_STAT
static final java.lang.String OP_LOCK_STAT_STR
static final java.lang.String OP_TXN_STAT
static final java.lang.String OP_DB_NAMES
static final java.lang.String OP_DB_STAT
Constructor Detail |
---|
public JEMBeanHelper(com.sleepycat.je.EnvironmentConfig config, java.io.File environmentHome, boolean canConfigure)
environmentHome
- home directory of the target JE environment.canConfigure
- If true, the helper will show environment
configuration attributes.Method Detail |
---|
public java.io.File getEnvironmentHome()
public com.sleepycat.je.EnvironmentConfig getEnvironmentOpenConfig()
public com.sleepycat.je.Environment getEnvironmentIfOpen()
public boolean getNeedReset()
public java.util.List<javax.management.MBeanAttributeInfo> getAttributeList(com.sleepycat.je.Environment targetEnv)
targetEnv
- The target JE environment. May be null if the
environment is not open.
public java.lang.Object getAttribute(com.sleepycat.je.Environment targetEnv, java.lang.String attributeName) throws javax.management.AttributeNotFoundException, javax.management.MBeanException
targetEnv
- The target JE environment. May be null if the
environment is not open.attributeName
- attribute name.
javax.management.AttributeNotFoundException
javax.management.MBeanException
public void setAttribute(com.sleepycat.je.Environment targetEnv, javax.management.Attribute attribute) throws javax.management.AttributeNotFoundException, javax.management.InvalidAttributeValueException
targetEnv
- The target JE environment. May be null if the
environment is not open.attribute
- name/value pair
javax.management.AttributeNotFoundException
javax.management.InvalidAttributeValueException
public java.util.List<javax.management.MBeanOperationInfo> getOperationList(com.sleepycat.je.Environment targetEnv)
targetEnv
- The target JE environment. May be null if the
environment is not open.
public java.lang.Object invoke(com.sleepycat.je.Environment targetEnv, java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) throws javax.management.MBeanException
targetEnv
- The target JE environment. May be null if the
environment is not open.actionName
- operation name.params
- operation parameters. May be null.signature
- operation signature. May be null.
javax.management.MBeanException
public javax.management.MBeanNotificationInfo[] getNotificationInfo(com.sleepycat.je.Environment targetEnv)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |