Skip navigation links

Oracle® Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC)
11g Release 1 (11.1)

E17274-04


oracle.stellent.ridc.convenience.adf.connection.mxbean
Class RidcConnectionMxBeanImpl

java.lang.Object
  extended by javax.management.StandardMBean
      extended by javax.management.StandardEmitterMBean
          extended by oracle.stellent.ridc.convenience.adf.connection.mxbean.RidcConnectionMxBeanImpl

All Implemented Interfaces:
DynamicMBean, MBeanRegistration, NotificationBroadcaster, NotificationEmitter, RidcConnectionMxBean

public class RidcConnectionMxBeanImpl
extends StandardEmitterMBean
implements RidcConnectionMxBean

RidcConnectionMxBeanImpl is a JMX implementation of RidcConnectionMxBean interface. It utilizes the RidcConnection bean to facilitate changing of Content Server connection properties at runtime.


Field Summary
static String NOTIFY_TYPE_UPDATED
          Notification types definitions.

 

Constructor Summary
RidcConnectionMxBeanImpl(String connectionName, Reference reference)
          Create an IdcConnectionMXBean using the given connection name and JNDI reference object.

 

Method Summary
 RidcConnection getConnection()
          Get the IdcConnection.
 String getConnectionName()
          Get the name of this IdcConnection.
 String getConnectionType()
           
 String getConnectionURL()
          Get the connection URL.
protected  String getDescription(MBeanInfo info)
          Get the description text for this MBean.
protected  String getDescription(MBeanOperationInfo info)
          Get the MBean operation descriptions.
protected  String getDescription(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)
          Get the description text for the parameter variable names the MBean operations.
 MBeanInfo getMBeanInfo()
           
 MBeanNotificationInfo[] getNotificationInfo()
           
protected  String getParameterName(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)
          Get the parameter variable names for the operations the MBean supports.
 String getProperty(String key)
          Get an arbitrary connection property.
 Reference getReference()
           
 int getTimeout()
          Get the connection timeout period.
 void setConnectionURL(String connectionURL)
          Update the connection URL.
 void setProperty(String key, String value)
          Set an arbitrary connection property.
 void setTimeout(int timeoutValue)
          Set the connection timeout period.
 void updateConnectionURL(String connectionURL)
          Update the connection URL.

 

Methods inherited from class javax.management.StandardEmitterMBean
addNotificationListener, removeNotificationListener, removeNotificationListener, sendNotification

 

Methods inherited from class javax.management.StandardMBean
cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

NOTIFY_TYPE_UPDATED

public static final String NOTIFY_TYPE_UPDATED
Notification types definitions. To use when creating JMX Notifications.
See Also:
Constant Field Values

Constructor Detail

RidcConnectionMxBeanImpl

public RidcConnectionMxBeanImpl(String connectionName,
                                Reference reference)
                         throws NotCompliantMBeanException
Create an IdcConnectionMXBean using the given connection name and JNDI reference object.
Parameters:
connectionName - connection name
reference - JNDI reference object that contains the connection information.
Throws:
NotCompliantMBeanException

Method Detail

getMBeanInfo

public MBeanInfo getMBeanInfo()
Specified by:
getMBeanInfo in interface DynamicMBean
Overrides:
getMBeanInfo in class StandardMBean

getReference

public Reference getReference()
                       throws Exception
Throws:
Exception

getTimeout

public int getTimeout()
Get the connection timeout period.
Specified by:
getTimeout in interface RidcConnectionMxBean
Returns:
connection timeout period as an integer.

setTimeout

public void setTimeout(int timeoutValue)
Set the connection timeout period.
Specified by:
setTimeout in interface RidcConnectionMxBean
Parameters:
timeoutValue - connection timeout period.

getConnectionURL

public String getConnectionURL()
Get the connection URL.
Specified by:
getConnectionURL in interface RidcConnectionMxBean
Returns:
connection URL as a string.

setConnectionURL

public void setConnectionURL(String connectionURL)
Update the connection URL.
Specified by:
setConnectionURL in interface RidcConnectionMxBean
Parameters:
connectionURL - the IDC connection URL

getConnectionType

public String getConnectionType()

getConnectionName

public String getConnectionName()
Get the name of this IdcConnection.
Specified by:
getConnectionName in interface RidcConnectionMxBean
Returns:
IDC Connection name.

setProperty

public void setProperty(String key,
                        String value)
Set an arbitrary connection property.
Specified by:
setProperty in interface RidcConnectionMxBean
Parameters:
key - property key.
value - property value.

getProperty

public String getProperty(String key)
Get an arbitrary connection property.
Specified by:
getProperty in interface RidcConnectionMxBean
Parameters:
key - property key.
Returns:
property value

getConnection

public RidcConnection getConnection()
Get the IdcConnection.
Returns:
IDC Connection name.

updateConnectionURL

public void updateConnectionURL(String connectionURL)
Update the connection URL.
Parameters:
connectionURL - the connection URL (i.e. "idc://csserver:4444").

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()
Specified by:
getNotificationInfo in interface NotificationBroadcaster
Overrides:
getNotificationInfo in class StandardEmitterMBean

getDescription

protected String getDescription(MBeanInfo info)
Get the description text for this MBean.
Overrides:
getDescription in class StandardMBean
Returns:
MBean description text.

getParameterName

protected String getParameterName(MBeanOperationInfo op,
                                  MBeanParameterInfo param,
                                  int sequence)
Get the parameter variable names for the operations the MBean supports.
Overrides:
getParameterName in class StandardMBean
Returns:
parameter variable name.

getDescription

protected String getDescription(MBeanOperationInfo op,
                                MBeanParameterInfo param,
                                int sequence)
Get the description text for the parameter variable names the MBean operations.
Overrides:
getDescription in class StandardMBean
Returns:
operation parameter description.

getDescription

protected String getDescription(MBeanOperationInfo info)
Get the MBean operation descriptions.
Overrides:
getDescription in class StandardMBean
Returns:
operation description text.

Skip navigation links

Oracle® Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC)
11g Release 1 (11.1)

E17274-04


Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved.