Sonic Management API

com.sonicsw.mq.mgmtapi.config.gen
Interface IAbstractBrokerBean

All Superinterfaces:
com.sonicsw.mx.config.IAnnotationExtension, IMgmtBase, IMgmtBeanBase
All Known Subinterfaces:
IBrokerBean

public interface IAbstractBrokerBean
extends IMgmtBeanBase

Configuration Bean representing a 'Broker'


Nested Class Summary
static interface IAbstractBrokerBean.IAbstractActionalParametersType
          Inner class representing ActionalParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractBrokerReferencesType
          Inner class representing BrokerReferencesType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractCaListType
          Inner class representing CaListType This inner class contains inner data items that are keyed off a name.
static interface IAbstractBrokerBean.IAbstractCaType
          Inner class representing CaType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractCipherSuiteType
          Inner class representing CipherSuiteType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractClusteringType
          Inner class representing ClusteringType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractConnectionBuffersType
          Inner class representing ConnectionBuffersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractCredentialsType
          Inner class representing CredentialsType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractDatabaseParametersType
          Inner class representing DatabaseParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractDebugParametersType
          Inner class representing DebugParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractDuplicateDetectionParametersType
          Inner class representing DuplicateDetectionParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractFTParametersType
          Inner class representing FTParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractJsseParametersType
          Inner class representing JsseParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractLdapConnectionType
          Inner class representing LdapConnectionType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractMetricsCollectionType
          Inner class representing MetricsCollectionType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractNotificationParametersType
          Inner class representing NotificationParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractProductInformationType
          Inner class representing ProductInformationType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractPubSubParametersType
          Inner class representing PubSubParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractQueueParametersType
          Inner class representing QueueParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractRecoveryLogType
          Inner class representing RecoveryLogType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractReplicationParametersType
          Inner class representing ReplicationParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractRoutingParametersType
          Inner class representing RoutingParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractSecurityParametersType
          Inner class representing SecurityParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractSslParametersType
          Inner class representing SslParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractTuningParametersType
          Inner class representing TuningParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractTunnelingParametersType
          Inner class representing TunnelingParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractTxnParametersType
          Inner class representing TxnParametersType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractWsKeystoreType
          Inner class representing WsKeystoreType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractWsRmType
          Inner class representing WsRmType This class extends IMgmtListBase
static interface IAbstractBrokerBean.IAbstractWsSecurityType
          Inner class representing WsSecurityType This class extends IMgmtListBase
 
Field Summary
 
Fields inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase
C_VERSION_PROPERTY, CLASS_PROPERTY, P_VERSION_PROPERTY, TEMPLATE_PROPERTY, TYPE_PROPERTY
 
Fields inherited from interface com.sonicsw.mx.config.IAnnotationExtension
END_CDATA, START_CDATA, TOOL_ANNOTATION
 
Method Summary
 IBrokerBean.IActionalParametersType createActionalParameters()
          Create an instance of an IActionalParametersType attribute.
 IBrokerBean.IReplicationParametersType createBrokerReplicationParameters()
          Create an instance of an IReplicationParametersType attribute.
 IBrokerBean.ICipherSuiteType createCipherSuiteInfo()
          Create an instance of an ICipherSuiteType attribute.
 IBrokerBean.IDebugParametersType createDebugParameters()
          Create an instance of an IDebugParametersType attribute.
 IBrokerBean.IMetricsCollectionType createMetrics()
          Create an instance of an IMetricsCollectionType attribute.
 IBrokerBean.IWsSecurityType createWsSecurityParameters()
          Create an instance of an IWsSecurityType attribute.
 IBrokerBean.IActionalParametersType getActionalParameters()
          Get the attribute for ACTIONAL_PARAMETERS.
 IMgmtAttributeMetaData getActionalParametersMetaData()
          Get the attribute metadata for ACTIONAL_PARAMETERS.
 java.lang.String getArchiveName()
          Get the attribute for ARCHIVE_NAME as a String value.
 java.lang.String getArchiveName(java.lang.String defValue)
          Get the attribute for ARCHIVE_NAME as a String value.
 IMgmtAttributeMetaData getArchiveNameMetaData()
          Get the attribute metadata for ARCHIVE_NAME.
 IBrokerBean.IClusteringType getBrokerClusterParameters()
          Get the attribute for BROKER_CLUSTER_PARAMETERS.
 IMgmtAttributeMetaData getBrokerClusterParametersMetaData()
          Get the attribute metadata for BROKER_CLUSTER_PARAMETERS.
 IBrokerBean.IConnectionBuffersType getBrokerConnectionBuffers()
          Get the attribute for BROKER_CONNECTION_BUFFERS.
 IMgmtAttributeMetaData getBrokerConnectionBuffersMetaData()
          Get the attribute metadata for BROKER_CONNECTION_BUFFERS.
 IBrokerBean.IDatabaseParametersType getBrokerDatabaseParameters()
          Get the attribute for BROKER_DATABASE_PARAMETERS.
 IMgmtAttributeMetaData getBrokerDatabaseParametersMetaData()
          Get the attribute metadata for BROKER_DATABASE_PARAMETERS.
 IBrokerBean.IFTParametersType getBrokerFaultTolerantParameters()
          Get the attribute for BROKER_FAULT_TOLERANT_PARAMETERS.
 IMgmtAttributeMetaData getBrokerFaultTolerantParametersMetaData()
          Get the attribute metadata for BROKER_FAULT_TOLERANT_PARAMETERS.
 java.lang.String getBrokerName()
          Get the attribute for BROKER_NAME as a String value.
 IMgmtAttributeMetaData getBrokerNameMetaData()
          Get the attribute metadata for BROKER_NAME.
 IBrokerBean.INotificationParametersType getBrokerNotificationParameters()
          Get the attribute for BROKER_NOTIFICATION_PARAMETERS.
 IMgmtAttributeMetaData getBrokerNotificationParametersMetaData()
          Get the attribute metadata for BROKER_NOTIFICATION_PARAMETERS.
 java.lang.String getBrokerPassword()
          Get the attribute for BROKER_PASSWORD as a String value.
 java.lang.String getBrokerPassword(java.lang.String defValue)
          Get the attribute for BROKER_PASSWORD as a String value.
 IMgmtAttributeMetaData getBrokerPasswordMetaData()
          Get the attribute metadata for BROKER_PASSWORD.
 IBrokerBean.IPubSubParametersType getBrokerPubsubParameters()
          Get the attribute for BROKER_PUBSUB_PARAMETERS.
 IMgmtAttributeMetaData getBrokerPubsubParametersMetaData()
          Get the attribute metadata for BROKER_PUBSUB_PARAMETERS.
 IBrokerBean.IQueueParametersType getBrokerQueueParameters()
          Get the attribute for BROKER_QUEUE_PARAMETERS.
 IMgmtAttributeMetaData getBrokerQueueParametersMetaData()
          Get the attribute metadata for BROKER_QUEUE_PARAMETERS.
 IBrokerBean.IRecoveryLogType getBrokerRecoveryLogParameters()
          Get the attribute for BROKER_RECOVERY_LOG_PARAMETERS.
 IMgmtAttributeMetaData getBrokerRecoveryLogParametersMetaData()
          Get the attribute metadata for BROKER_RECOVERY_LOG_PARAMETERS.
 IBrokerBean.IReplicationParametersType getBrokerReplicationParameters()
          Get the attribute for BROKER_REPLICATION_PARAMETERS.
 IMgmtAttributeMetaData getBrokerReplicationParametersMetaData()
          Get the attribute metadata for BROKER_REPLICATION_PARAMETERS.
 IBrokerBean.IRoutingParametersType getBrokerRoutingParameters()
          Get the attribute for BROKER_ROUTING_PARAMETERS.
 IMgmtAttributeMetaData getBrokerRoutingParametersMetaData()
          Get the attribute metadata for BROKER_ROUTING_PARAMETERS.
 IBrokerBean.ISecurityParametersType getBrokerSecurityParameters()
          Get the attribute for BROKER_SECURITY_PARAMETERS.
 IMgmtAttributeMetaData getBrokerSecurityParametersMetaData()
          Get the attribute metadata for BROKER_SECURITY_PARAMETERS.
 IBrokerBean.ISslParametersType getBrokerSslParameters()
          Get the attribute for BROKER_SSL_PARAMETERS.
 IMgmtAttributeMetaData getBrokerSslParametersMetaData()
          Get the attribute metadata for BROKER_SSL_PARAMETERS.
 IBrokerBean.ITunnelingParametersType getBrokerTunnelingParameters()
          Get the attribute for BROKER_TUNNELING_PARAMETERS.
 IMgmtAttributeMetaData getBrokerTunnelingParametersMetaData()
          Get the attribute metadata for BROKER_TUNNELING_PARAMETERS.
 IBrokerBean.ITxnParametersType getBrokerTxnParameters()
          Get the attribute for BROKER_TXN_PARAMETERS.
 IMgmtAttributeMetaData getBrokerTxnParametersMetaData()
          Get the attribute metadata for BROKER_TXN_PARAMETERS.
 IBrokerBean.ICipherSuiteType getCipherSuiteInfo()
          Get the attribute for CIPHER_SUITE_INFO.
 IMgmtAttributeMetaData getCipherSuiteInfoMetaData()
          Get the attribute metadata for CIPHER_SUITE_INFO.
 java.lang.String getClassname()
          Get the attribute for CLASSNAME as a String value.
 IMgmtAttributeMetaData getClassnameMetaData()
          Get the attribute metadata for CLASSNAME.
 java.lang.String getClasspath()
          Get the attribute for CLASSPATH as a String value.
 java.lang.String getClasspath(java.lang.String defValue)
          Get the attribute for CLASSPATH as a String value.
 IMgmtAttributeMetaData getClasspathMetaData()
          Get the attribute metadata for CLASSPATH.
 IBrokerBean.IBrokerReferencesType getConfigElementReferences()
          Get the attribute for CONFIG_ELEMENT_REFERENCES.
 IMgmtAttributeMetaData getConfigElementReferencesMetaData()
          Get the attribute metadata for CONFIG_ELEMENT_REFERENCES.
 IBrokerBean.ITuningParametersType getConnectionTuningParameters()
          Get the attribute for CONNECTION_TUNING_PARAMETERS.
 IMgmtAttributeMetaData getConnectionTuningParametersMetaData()
          Get the attribute metadata for CONNECTION_TUNING_PARAMETERS.
 IBrokerBean.IDebugParametersType getDebugParameters()
          Get the attribute for DEBUG_PARAMETERS.
 IMgmtAttributeMetaData getDebugParametersMetaData()
          Get the attribute metadata for DEBUG_PARAMETERS.
 IBrokerBean.IDuplicateDetectionParametersType getDuplicateDetectionParameters()
          Get the attribute for DUPLICATE_DETECTION_PARAMETERS.
 IMgmtAttributeMetaData getDuplicateDetectionParametersMetaData()
          Get the attribute metadata for DUPLICATE_DETECTION_PARAMETERS.
 IBrokerBean.IMetricsCollectionType getMetrics()
          Get the attribute for METRICS.
 IMgmtAttributeMetaData getMetricsMetaData()
          Get the attribute metadata for METRICS.
 IBrokerBean.IProductInformationType getProductInformation()
          Get the attribute for PRODUCT_INFORMATION.
 IMgmtAttributeMetaData getProductInformationMetaData()
          Get the attribute metadata for PRODUCT_INFORMATION.
 IBrokerBean.IWsSecurityType getWsSecurityParameters()
          Get the attribute for WS_SECURITY_PARAMETERS.
 IMgmtAttributeMetaData getWsSecurityParametersMetaData()
          Get the attribute metadata for WS_SECURITY_PARAMETERS.
 void setActionalParameters(IBrokerBean.IActionalParametersType value)
          Set the attribute for ACTIONAL_PARAMETERS to the specified IActionalParametersType value.
 void setArchiveName(java.lang.String value)
          Set the attribute for ARCHIVE_NAME to the specified String value.
 void setBrokerName(java.lang.String value)
          Set the attribute for BROKER_NAME to the specified String value.
 void setBrokerPassword(java.lang.String value)
          Set the attribute for BROKER_PASSWORD to the specified String value.
 void setBrokerReplicationParameters(IBrokerBean.IReplicationParametersType value)
          Set the attribute for BROKER_REPLICATION_PARAMETERS to the specified IReplicationParametersType value.
 void setCipherSuiteInfo(IBrokerBean.ICipherSuiteType value)
          Set the attribute for CIPHER_SUITE_INFO to the specified ICipherSuiteType value.
 void setClasspath(java.lang.String value)
          Set the attribute for CLASSPATH to the specified String value.
 void setDebugParameters(IBrokerBean.IDebugParametersType value)
          Set the attribute for DEBUG_PARAMETERS to the specified IDebugParametersType value.
 void setMetrics(IBrokerBean.IMetricsCollectionType value)
          Set the attribute for METRICS to the specified IMetricsCollectionType value.
 void setWsSecurityParameters(IBrokerBean.IWsSecurityType value)
          Set the attribute for WS_SECURITY_PARAMETERS to the specified IWsSecurityType value.
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase
clone, createUniqueName, getBigDecimalAttribute, getBooleanAttribute, getByteArrayAttribute, getIntegerAttribute, getLongAttribute, getProperty, getReferenceAttribute, getStringAttribute, isNewBean, setBigDecimalAttribute, setBooleanAttribute, setByteArrayAttribute, setIntegerAttribute, setLongAttribute, setReferenceAttribute, setStringAttribute
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBase
getAttributeList, getAttributeMap, getAttributeMetaData, getConfigBean, getConfigBeanName, getConfigBeanNameTail, getConfigPath, getConfigPath, getMgmtBeanFactory, getParent, removeAttribute, setAttribute
 
Methods inherited from interface com.sonicsw.mx.config.IAnnotationExtension
getAnnotation, setAnnotation
 

Method Detail

createActionalParameters

IBrokerBean.IActionalParametersType createActionalParameters()
                                                             throws MgmtException
Create an instance of an IActionalParametersType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setActionalParameters method.

Returns:
The new IActionalParametersType bean
Throws:
MgmtException - Thrown if there is some problem creating this object

createBrokerReplicationParameters

IBrokerBean.IReplicationParametersType createBrokerReplicationParameters()
                                                                         throws MgmtException
Create an instance of an IReplicationParametersType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setBrokerReplicationParameters method.

Returns:
The new IReplicationParametersType bean
Throws:
MgmtException - Thrown if there is some problem creating this object

createCipherSuiteInfo

IBrokerBean.ICipherSuiteType createCipherSuiteInfo()
                                                   throws MgmtException
Create an instance of an ICipherSuiteType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setCipherSuiteInfo method.

Returns:
The new ICipherSuiteType bean
Throws:
MgmtException - Thrown if there is some problem creating this object

createDebugParameters

IBrokerBean.IDebugParametersType createDebugParameters()
                                                       throws MgmtException
Create an instance of an IDebugParametersType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setDebugParameters method.

Returns:
The new IDebugParametersType bean
Throws:
MgmtException - Thrown if there is some problem creating this object

createMetrics

IBrokerBean.IMetricsCollectionType createMetrics()
                                                 throws MgmtException
Create an instance of an IMetricsCollectionType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setMetrics method.

Returns:
The new IMetricsCollectionType bean
Throws:
MgmtException - Thrown if there is some problem creating this object

createWsSecurityParameters

IBrokerBean.IWsSecurityType createWsSecurityParameters()
                                                       throws MgmtException
Create an instance of an IWsSecurityType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setWsSecurityParameters method.

Returns:
The new IWsSecurityType bean
Throws:
MgmtException - Thrown if there is some problem creating this object

getActionalParameters

IBrokerBean.IActionalParametersType getActionalParameters()
                                                          throws MgmtException
Get the attribute for ACTIONAL_PARAMETERS.

Returns:
The IActionalParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getActionalParametersMetaData

IMgmtAttributeMetaData getActionalParametersMetaData()
                                                     throws MgmtException
Get the attribute metadata for ACTIONAL_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getArchiveName

java.lang.String getArchiveName()
                                throws MgmtException
Get the attribute for ARCHIVE_NAME as a String value. This is an optional attribute and a MgmtException will be thrown if the attribute does not exist.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getArchiveName

java.lang.String getArchiveName(java.lang.String defValue)
                                throws MgmtException
Get the attribute for ARCHIVE_NAME as a String value. If the attribute doesn't exist then return the specified default value.

Parameters:
defValue - The default value to return if this attribute doesn't exist
Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getArchiveNameMetaData

IMgmtAttributeMetaData getArchiveNameMetaData()
                                              throws MgmtException
Get the attribute metadata for ARCHIVE_NAME.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getBrokerClusterParameters

IBrokerBean.IClusteringType getBrokerClusterParameters()
                                                       throws MgmtException
Get the attribute for BROKER_CLUSTER_PARAMETERS.

Returns:
The IClusteringType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerClusterParametersMetaData

IMgmtAttributeMetaData getBrokerClusterParametersMetaData()
                                                          throws MgmtException
Get the attribute metadata for BROKER_CLUSTER_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerConnectionBuffers

IBrokerBean.IConnectionBuffersType getBrokerConnectionBuffers()
                                                              throws MgmtException
Get the attribute for BROKER_CONNECTION_BUFFERS.

Returns:
The IConnectionBuffersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerConnectionBuffersMetaData

IMgmtAttributeMetaData getBrokerConnectionBuffersMetaData()
                                                          throws MgmtException
Get the attribute metadata for BROKER_CONNECTION_BUFFERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerDatabaseParameters

IBrokerBean.IDatabaseParametersType getBrokerDatabaseParameters()
                                                                throws MgmtException
Get the attribute for BROKER_DATABASE_PARAMETERS.

Returns:
The IDatabaseParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerDatabaseParametersMetaData

IMgmtAttributeMetaData getBrokerDatabaseParametersMetaData()
                                                           throws MgmtException
Get the attribute metadata for BROKER_DATABASE_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerFaultTolerantParameters

IBrokerBean.IFTParametersType getBrokerFaultTolerantParameters()
                                                               throws MgmtException
Get the attribute for BROKER_FAULT_TOLERANT_PARAMETERS.

Returns:
The IFTParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerFaultTolerantParametersMetaData

IMgmtAttributeMetaData getBrokerFaultTolerantParametersMetaData()
                                                                throws MgmtException
Get the attribute metadata for BROKER_FAULT_TOLERANT_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerName

java.lang.String getBrokerName()
                               throws MgmtException
Get the attribute for BROKER_NAME as a String value.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerNameMetaData

IMgmtAttributeMetaData getBrokerNameMetaData()
                                             throws MgmtException
Get the attribute metadata for BROKER_NAME.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getBrokerNotificationParameters

IBrokerBean.INotificationParametersType getBrokerNotificationParameters()
                                                                        throws MgmtException
Get the attribute for BROKER_NOTIFICATION_PARAMETERS.

Returns:
The INotificationParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerNotificationParametersMetaData

IMgmtAttributeMetaData getBrokerNotificationParametersMetaData()
                                                               throws MgmtException
Get the attribute metadata for BROKER_NOTIFICATION_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerPassword

java.lang.String getBrokerPassword()
                                   throws MgmtException
Get the attribute for BROKER_PASSWORD as a String value. This is an optional attribute and a MgmtException will be thrown if the attribute does not exist.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerPassword

java.lang.String getBrokerPassword(java.lang.String defValue)
                                   throws MgmtException
Get the attribute for BROKER_PASSWORD as a String value. If the attribute doesn't exist then return the specified default value.

Parameters:
defValue - The default value to return if this attribute doesn't exist
Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerPasswordMetaData

IMgmtAttributeMetaData getBrokerPasswordMetaData()
                                                 throws MgmtException
Get the attribute metadata for BROKER_PASSWORD.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getBrokerPubsubParameters

IBrokerBean.IPubSubParametersType getBrokerPubsubParameters()
                                                            throws MgmtException
Get the attribute for BROKER_PUBSUB_PARAMETERS.

Returns:
The IPubSubParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerPubsubParametersMetaData

IMgmtAttributeMetaData getBrokerPubsubParametersMetaData()
                                                         throws MgmtException
Get the attribute metadata for BROKER_PUBSUB_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerQueueParameters

IBrokerBean.IQueueParametersType getBrokerQueueParameters()
                                                          throws MgmtException
Get the attribute for BROKER_QUEUE_PARAMETERS.

Returns:
The IQueueParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerQueueParametersMetaData

IMgmtAttributeMetaData getBrokerQueueParametersMetaData()
                                                        throws MgmtException
Get the attribute metadata for BROKER_QUEUE_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerRecoveryLogParameters

IBrokerBean.IRecoveryLogType getBrokerRecoveryLogParameters()
                                                            throws MgmtException
Get the attribute for BROKER_RECOVERY_LOG_PARAMETERS.

Returns:
The IRecoveryLogType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerRecoveryLogParametersMetaData

IMgmtAttributeMetaData getBrokerRecoveryLogParametersMetaData()
                                                              throws MgmtException
Get the attribute metadata for BROKER_RECOVERY_LOG_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerReplicationParameters

IBrokerBean.IReplicationParametersType getBrokerReplicationParameters()
                                                                      throws MgmtException
Get the attribute for BROKER_REPLICATION_PARAMETERS.

Returns:
The IReplicationParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerReplicationParametersMetaData

IMgmtAttributeMetaData getBrokerReplicationParametersMetaData()
                                                              throws MgmtException
Get the attribute metadata for BROKER_REPLICATION_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerRoutingParameters

IBrokerBean.IRoutingParametersType getBrokerRoutingParameters()
                                                              throws MgmtException
Get the attribute for BROKER_ROUTING_PARAMETERS.

Returns:
The IRoutingParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerRoutingParametersMetaData

IMgmtAttributeMetaData getBrokerRoutingParametersMetaData()
                                                          throws MgmtException
Get the attribute metadata for BROKER_ROUTING_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerSecurityParameters

IBrokerBean.ISecurityParametersType getBrokerSecurityParameters()
                                                                throws MgmtException
Get the attribute for BROKER_SECURITY_PARAMETERS.

Returns:
The ISecurityParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerSecurityParametersMetaData

IMgmtAttributeMetaData getBrokerSecurityParametersMetaData()
                                                           throws MgmtException
Get the attribute metadata for BROKER_SECURITY_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerSslParameters

IBrokerBean.ISslParametersType getBrokerSslParameters()
                                                      throws MgmtException
Get the attribute for BROKER_SSL_PARAMETERS.

Returns:
The ISslParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerSslParametersMetaData

IMgmtAttributeMetaData getBrokerSslParametersMetaData()
                                                      throws MgmtException
Get the attribute metadata for BROKER_SSL_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerTunnelingParameters

IBrokerBean.ITunnelingParametersType getBrokerTunnelingParameters()
                                                                  throws MgmtException
Get the attribute for BROKER_TUNNELING_PARAMETERS.

Returns:
The ITunnelingParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerTunnelingParametersMetaData

IMgmtAttributeMetaData getBrokerTunnelingParametersMetaData()
                                                            throws MgmtException
Get the attribute metadata for BROKER_TUNNELING_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getBrokerTxnParameters

IBrokerBean.ITxnParametersType getBrokerTxnParameters()
                                                      throws MgmtException
Get the attribute for BROKER_TXN_PARAMETERS.

Returns:
The ITxnParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getBrokerTxnParametersMetaData

IMgmtAttributeMetaData getBrokerTxnParametersMetaData()
                                                      throws MgmtException
Get the attribute metadata for BROKER_TXN_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getCipherSuiteInfo

IBrokerBean.ICipherSuiteType getCipherSuiteInfo()
                                                throws MgmtException
Get the attribute for CIPHER_SUITE_INFO.

Returns:
The ICipherSuiteType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getCipherSuiteInfoMetaData

IMgmtAttributeMetaData getCipherSuiteInfoMetaData()
                                                  throws MgmtException
Get the attribute metadata for CIPHER_SUITE_INFO.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getClassname

java.lang.String getClassname()
                              throws MgmtException
Get the attribute for CLASSNAME as a String value.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClassnameMetaData

IMgmtAttributeMetaData getClassnameMetaData()
                                            throws MgmtException
Get the attribute metadata for CLASSNAME.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getClasspath

java.lang.String getClasspath()
                              throws MgmtException
Get the attribute for CLASSPATH as a String value. This is an optional attribute and a MgmtException will be thrown if the attribute does not exist.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClasspath

java.lang.String getClasspath(java.lang.String defValue)
                              throws MgmtException
Get the attribute for CLASSPATH as a String value. If the attribute doesn't exist then return the specified default value.

Parameters:
defValue - The default value to return if this attribute doesn't exist
Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClasspathMetaData

IMgmtAttributeMetaData getClasspathMetaData()
                                            throws MgmtException
Get the attribute metadata for CLASSPATH.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getConfigElementReferences

IBrokerBean.IBrokerReferencesType getConfigElementReferences()
                                                             throws MgmtException
Get the attribute for CONFIG_ELEMENT_REFERENCES.

Returns:
The IBrokerReferencesType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getConfigElementReferencesMetaData

IMgmtAttributeMetaData getConfigElementReferencesMetaData()
                                                          throws MgmtException
Get the attribute metadata for CONFIG_ELEMENT_REFERENCES.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getConnectionTuningParameters

IBrokerBean.ITuningParametersType getConnectionTuningParameters()
                                                                throws MgmtException
Get the attribute for CONNECTION_TUNING_PARAMETERS.

Returns:
The ITuningParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getConnectionTuningParametersMetaData

IMgmtAttributeMetaData getConnectionTuningParametersMetaData()
                                                             throws MgmtException
Get the attribute metadata for CONNECTION_TUNING_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getDebugParameters

IBrokerBean.IDebugParametersType getDebugParameters()
                                                    throws MgmtException
Get the attribute for DEBUG_PARAMETERS.

Returns:
The IDebugParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getDebugParametersMetaData

IMgmtAttributeMetaData getDebugParametersMetaData()
                                                  throws MgmtException
Get the attribute metadata for DEBUG_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getDuplicateDetectionParameters

IBrokerBean.IDuplicateDetectionParametersType getDuplicateDetectionParameters()
                                                                              throws MgmtException
Get the attribute for DUPLICATE_DETECTION_PARAMETERS.

Returns:
The IDuplicateDetectionParametersType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getDuplicateDetectionParametersMetaData

IMgmtAttributeMetaData getDuplicateDetectionParametersMetaData()
                                                               throws MgmtException
Get the attribute metadata for DUPLICATE_DETECTION_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getMetrics

IBrokerBean.IMetricsCollectionType getMetrics()
                                              throws MgmtException
Get the attribute for METRICS.

Returns:
The IMetricsCollectionType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getMetricsMetaData

IMgmtAttributeMetaData getMetricsMetaData()
                                          throws MgmtException
Get the attribute metadata for METRICS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getProductInformation

IBrokerBean.IProductInformationType getProductInformation()
                                                          throws MgmtException
Get the attribute for PRODUCT_INFORMATION.

Returns:
The IProductInformationType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getProductInformationMetaData

IMgmtAttributeMetaData getProductInformationMetaData()
                                                     throws MgmtException
Get the attribute metadata for PRODUCT_INFORMATION.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getWsSecurityParameters

IBrokerBean.IWsSecurityType getWsSecurityParameters()
                                                    throws MgmtException
Get the attribute for WS_SECURITY_PARAMETERS.

Returns:
The IWsSecurityType value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getWsSecurityParametersMetaData

IMgmtAttributeMetaData getWsSecurityParametersMetaData()
                                                       throws MgmtException
Get the attribute metadata for WS_SECURITY_PARAMETERS.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

setActionalParameters

void setActionalParameters(IBrokerBean.IActionalParametersType value)
                           throws MgmtException
Set the attribute for ACTIONAL_PARAMETERS to the specified IActionalParametersType value.

Parameters:
value - The IActionalParametersType value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setArchiveName

void setArchiveName(java.lang.String value)
                    throws MgmtException
Set the attribute for ARCHIVE_NAME to the specified String value.

Parameters:
value - The String value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setBrokerName

void setBrokerName(java.lang.String value)
                   throws MgmtException
Set the attribute for BROKER_NAME to the specified String value.

Parameters:
value - The String value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setBrokerPassword

void setBrokerPassword(java.lang.String value)
                       throws MgmtException
Set the attribute for BROKER_PASSWORD to the specified String value.

Parameters:
value - The String value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setBrokerReplicationParameters

void setBrokerReplicationParameters(IBrokerBean.IReplicationParametersType value)
                                    throws MgmtException
Set the attribute for BROKER_REPLICATION_PARAMETERS to the specified IReplicationParametersType value.

Parameters:
value - The IReplicationParametersType value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setCipherSuiteInfo

void setCipherSuiteInfo(IBrokerBean.ICipherSuiteType value)
                        throws MgmtException
Set the attribute for CIPHER_SUITE_INFO to the specified ICipherSuiteType value.

Parameters:
value - The ICipherSuiteType value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setClasspath

void setClasspath(java.lang.String value)
                  throws MgmtException
Set the attribute for CLASSPATH to the specified String value.

Parameters:
value - The String value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setDebugParameters

void setDebugParameters(IBrokerBean.IDebugParametersType value)
                        throws MgmtException
Set the attribute for DEBUG_PARAMETERS to the specified IDebugParametersType value.

Parameters:
value - The IDebugParametersType value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setMetrics

void setMetrics(IBrokerBean.IMetricsCollectionType value)
                throws MgmtException
Set the attribute for METRICS to the specified IMetricsCollectionType value.

Parameters:
value - The IMetricsCollectionType value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setWsSecurityParameters

void setWsSecurityParameters(IBrokerBean.IWsSecurityType value)
                             throws MgmtException
Set the attribute for WS_SECURITY_PARAMETERS to the specified IWsSecurityType value.

Parameters:
value - The IWsSecurityType value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

Sonic Management API

Copyright © 2001-2011 Progress Software Corporation. All Rights Reserved.
HTML formatted on 12-Aug-2011.