Skip navigation links

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

E17274-03


oracle.stellent.ridc.convenience.adf.mbeans
Class IdcConnectionMXBeanImpl

java.lang.Object
  extended by javax.management.StandardMBean
      extended by javax.management.StandardEmitterMBean
          extended by oracle.stellent.ridc.convenience.adf.mbeans.IdcConnectionMXBeanImpl

All Implemented Interfaces:
javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, IdcConnectionMXBean

public class IdcConnectionMXBeanImpl
extends javax.management.StandardEmitterMBean
implements IdcConnectionMXBean

IdcConnectionMXBeanImpl is a JMX implementation of IdcConnectionMXBean interface. It utilizes the IdcConnection bean to facilitate changing of Content Server connection properties at runtime. WARNING: This class is for use by SSXA and SSXA applications only, for RIDC applications use

See Also:
instead

Field Summary
static java.lang.String NOTIF_TYPE_UPDATED
          Notification types definitions.

 

Constructor Summary
IdcConnectionMXBeanImpl(java.lang.String connectionName, javax.naming.Reference reference)
          Create an IdcConnectionMXBean using the given connection name and JNDI reference object.

 

Method Summary
 java.lang.String getClientSecurityPolicy()
          Get the connection JaxWS ClientSecurityPolicy.
 IdcConnection getConnection()
          Get the name of this IdcConnection.
 java.lang.String getConnectionName()
          Get the name of this IdcConnection.
 java.lang.String getConnectionType()
           
 java.lang.String getConnectionUrl()
           
 java.lang.String getCsfKey()
          Get the connection WSM csf-key
protected  java.lang.String getDescription(javax.management.MBeanInfo info)
          Get the description text for this MBean.
protected  java.lang.String getDescription(javax.management.MBeanOperationInfo info)
          Get the MBean operation descriptions.
protected  java.lang.String getDescription(javax.management.MBeanOperationInfo op, javax.management.MBeanParameterInfo param, int sequence)
          Get the description text for the parameter variable names the MBean operations.
 java.lang.String getDesigntimeURL()
          Get the designtime URL.
 java.lang.String getKeystoreAlias()
          Gets the RIDC client private key alias in the keystore.
 java.lang.String getKeystoreFile()
          Gets the RIDC client side keystore file location.
 javax.management.MBeanInfo getMBeanInfo()
           
 javax.management.MBeanNotificationInfo[] getNotificationInfo()
           
protected  java.lang.String getParameterName(javax.management.MBeanOperationInfo op, javax.management.MBeanParameterInfo param, int sequence)
          Get the parameter variable names for the operations the MBean supports.
 java.lang.String getProperty(java.lang.String key)
          Get an arbitrary connection property.
 javax.naming.Reference getReference()
           
 java.lang.String getRuntimeURL()
          Get the runtime URL.
 int getTimeout()
          Get the connection timeout period.
 java.lang.String getTrustManagerFile()
          Gets the RIDC client side trust manager file location.
 void setClientSecurityPolicy(java.lang.String policy)
          Set the JaxWS ClientSecurityPolicy.
 void setCsfKey(java.lang.String csfKey)
          Set the connection WSM csf-key
 void setKeystoreAlias(java.lang.String keystoreAlias)
          Sets the RIDC client keystore alias in the keystore.
 void setKeystoreAliasPassword(java.lang.String keystoreAliasPassword)
          Sets the RIDC client keystore alias password required to retrieve the alias key from the keystore.
 void setKeystoreFile(java.lang.String keystoreFile)
          Sets the RIDC client side keystore file location.
 void setKeystorePassword(java.lang.String keystorePassword)
          Sets the RIDC client side keystore password.
 void setProperty(java.lang.String key, java.lang.String value)
          Set an arbitrary connection property.
 void setTimeout(int timeoutValue)
          Set the connection timeout period.
 void setTrustManagerFile(java.lang.String trustManagerFile)
          Sets the RIDC client side trust manager file location.
 void setTrustManagerPassword(java.lang.String trustManagerPassword)
          Sets the RIDC client trust manager password.
 void updateRuntimeURL(java.lang.String runtimeURL)
          Update the runtime IDC 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

NOTIF_TYPE_UPDATED

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

Constructor Detail

IdcConnectionMXBeanImpl

public IdcConnectionMXBeanImpl(java.lang.String connectionName,
                               javax.naming.Reference reference)
                        throws javax.management.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:
javax.management.NotCompliantMBeanException

Method Detail

getMBeanInfo

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

getReference

public javax.naming.Reference getReference()
                                    throws java.lang.Exception
Throws:
java.lang.Exception

getTimeout

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

setTimeout

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

getKeystoreFile

public java.lang.String getKeystoreFile()
Gets the RIDC client side keystore file location.
Specified by:
getKeystoreFile in interface IdcConnectionMXBean
Returns:
the RIDC client side keystore file location

setKeystoreFile

public void setKeystoreFile(java.lang.String keystoreFile)
Sets the RIDC client side keystore file location.
Specified by:
setKeystoreFile in interface IdcConnectionMXBean
Parameters:
keystoreFile - the RIDC client side keystore file location

setKeystorePassword

public void setKeystorePassword(java.lang.String keystorePassword)
Sets the RIDC client side keystore password.
Specified by:
setKeystorePassword in interface IdcConnectionMXBean
Parameters:
keystorePassword - the password to access the RIDC client side keystore

getKeystoreAlias

public java.lang.String getKeystoreAlias()
Gets the RIDC client private key alias in the keystore.
Specified by:
getKeystoreAlias in interface IdcConnectionMXBean
Returns:
the RIDC client private key alias in the keystore

setKeystoreAlias

public void setKeystoreAlias(java.lang.String keystoreAlias)
Sets the RIDC client keystore alias in the keystore.
Specified by:
setKeystoreAlias in interface IdcConnectionMXBean
Parameters:
keystoreAlias - the RIDC client private key alias in the keystore

setKeystoreAliasPassword

public void setKeystoreAliasPassword(java.lang.String keystoreAliasPassword)
Sets the RIDC client keystore alias password required to retrieve the alias key from the keystore.
Specified by:
setKeystoreAliasPassword in interface IdcConnectionMXBean
Parameters:
keystoreAliasPassword - the RIDC client keystore alias key password

getDesigntimeURL

public java.lang.String getDesigntimeURL()
Get the designtime URL.
Specified by:
getDesigntimeURL in interface IdcConnectionMXBean
Returns:
designtime URL as a string.

getRuntimeURL

public java.lang.String getRuntimeURL()
Get the runtime URL.
Specified by:
getRuntimeURL in interface IdcConnectionMXBean
Returns:
runtime URL as a string.

getConnectionUrl

public java.lang.String getConnectionUrl()
Specified by:
getConnectionUrl in interface IdcConnectionMXBean

getTrustManagerFile

public java.lang.String getTrustManagerFile()
Gets the RIDC client side trust manager file location.
Specified by:
getTrustManagerFile in interface IdcConnectionMXBean
Returns:
the RIDC client side trust manager file location

setTrustManagerFile

public void setTrustManagerFile(java.lang.String trustManagerFile)
Sets the RIDC client side trust manager file location.
Specified by:
setTrustManagerFile in interface IdcConnectionMXBean
Parameters:
trustManagerFile - the RIDC client side trust manager file location

setTrustManagerPassword

public void setTrustManagerPassword(java.lang.String trustManagerPassword)
Sets the RIDC client trust manager password.
Specified by:
setTrustManagerPassword in interface IdcConnectionMXBean
Parameters:
trustManagerPassword - the RIDC client trust manager password

getClientSecurityPolicy

public java.lang.String getClientSecurityPolicy()
Get the connection JaxWS ClientSecurityPolicy.
Specified by:
getClientSecurityPolicy in interface IdcConnectionMXBean
Returns:
JaxWS ClientSecurityPolicy

setClientSecurityPolicy

public void setClientSecurityPolicy(java.lang.String policy)
Set the JaxWS ClientSecurityPolicy.
Specified by:
setClientSecurityPolicy in interface IdcConnectionMXBean
Parameters:
policy - JaxWS ClientSecurityPolicy.

getCsfKey

public java.lang.String getCsfKey()
Get the connection WSM csf-key
Specified by:
getCsfKey in interface IdcConnectionMXBean
Returns:
csf-key value

setCsfKey

public void setCsfKey(java.lang.String csfKey)
Set the connection WSM csf-key
Specified by:
setCsfKey in interface IdcConnectionMXBean
Parameters:
csfKey -

getConnectionType

public java.lang.String getConnectionType()

getConnectionName

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

setProperty

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

getProperty

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

getConnection

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

updateRuntimeURL

public void updateRuntimeURL(java.lang.String runtimeURL)
Update the runtime IDC Connection URL.
Specified by:
updateRuntimeURL in interface IdcConnectionMXBean
Parameters:
runtimeURL - the IDC connection URL (i.e. "idc://csserver:4444").

getNotificationInfo

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

getDescription

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

getParameterName

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

getDescription

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

getDescription

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

Skip navigation links

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

E17274-03


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