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

All Superinterfaces:

com.sonicsw.mx.config.IAnnotationExtension, IMgmtBase, IMgmtBeanBase

All Known Subinterfaces:

IBackupBrokerBean

public interface IAbstractBackupBrokerBean
extends IMgmtBeanBase

Configuration Bean representing a 'BackupBroker'

Nested Class Summary

static interface	IAbstractBackupBrokerBean.IAbstractBrokerReferencesType Inner class representing BrokerReferencesType This class extends IMgmtListBase
static interface	IAbstractBackupBrokerBean.IAbstractClusteringType Inner class representing ClusteringType This class extends IMgmtListBase
static interface	IAbstractBackupBrokerBean.IAbstractDatabaseParametersType Inner class representing DatabaseParametersType This class extends IMgmtListBase
static interface	IAbstractBackupBrokerBean.IAbstractDebugParametersType Inner class representing DebugParametersType This class extends IMgmtListBase
static interface	IAbstractBackupBrokerBean.IAbstractRecoveryLogType Inner class representing RecoveryLogType This class extends IMgmtListBase
static interface	IAbstractBackupBrokerBean.IAbstractReplicationParametersType Inner class representing ReplicationParametersType This class extends IMgmtListBase
static interface	IAbstractBackupBrokerBean.IAbstractSslParametersType Inner class representing SslParametersType This class extends IMgmtListBase
static interface	IAbstractBackupBrokerBean.IAbstractTunnelingParametersType Inner class representing TunnelingParametersType 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

IBackupBrokerBean.IDebugParametersType	createBrokerDebugParameters() Create an instance of an IDebugParametersType attribute.
IBackupBrokerBean.IReplicationParametersType	createBrokerReplicationParameters() Create an instance of an IReplicationParametersType attribute.
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.
IBackupBrokerBean.IClusteringType	getBrokerClusterParameters() Get the attribute for BROKER_CLUSTER_PARAMETERS.
IMgmtAttributeMetaData	getBrokerClusterParametersMetaData() Get the attribute metadata for BROKER_CLUSTER_PARAMETERS.
IBackupBrokerBean.IDatabaseParametersType	getBrokerDatabaseParameters() Get the attribute for BROKER_DATABASE_PARAMETERS.
IMgmtAttributeMetaData	getBrokerDatabaseParametersMetaData() Get the attribute metadata for BROKER_DATABASE_PARAMETERS.
IBackupBrokerBean.IDebugParametersType	getBrokerDebugParameters() Get the attribute for BROKER_DEBUG_PARAMETERS.
IMgmtAttributeMetaData	getBrokerDebugParametersMetaData() Get the attribute metadata for BROKER_DEBUG_PARAMETERS.
IBackupBrokerBean.IRecoveryLogType	getBrokerRecoveryLogParameters() Get the attribute for BROKER_RECOVERY_LOG_PARAMETERS.
IMgmtAttributeMetaData	getBrokerRecoveryLogParametersMetaData() Get the attribute metadata for BROKER_RECOVERY_LOG_PARAMETERS.
IBackupBrokerBean.IReplicationParametersType	getBrokerReplicationParameters() Get the attribute for BROKER_REPLICATION_PARAMETERS.
IMgmtAttributeMetaData	getBrokerReplicationParametersMetaData() Get the attribute metadata for BROKER_REPLICATION_PARAMETERS.
IBackupBrokerBean.ISslParametersType	getBrokerSslParameters() Get the attribute for BROKER_SSL_PARAMETERS.
IMgmtAttributeMetaData	getBrokerSslParametersMetaData() Get the attribute metadata for BROKER_SSL_PARAMETERS.
IBackupBrokerBean.ITunnelingParametersType	getBrokerTunnelingParameters() Get the attribute for BROKER_TUNNELING_PARAMETERS.
IMgmtAttributeMetaData	getBrokerTunnelingParametersMetaData() Get the attribute metadata for BROKER_TUNNELING_PARAMETERS.
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.
IBackupBrokerBean.IBrokerReferencesType	getConfigElementReferences() Get the attribute for CONFIG_ELEMENT_REFERENCES.
IMgmtAttributeMetaData	getConfigElementReferencesMetaData() Get the attribute metadata for CONFIG_ELEMENT_REFERENCES.
void	setArchiveName(java.lang.String value) Set the attribute for ARCHIVE_NAME to the specified String value.
void	setBrokerDebugParameters(IBackupBrokerBean.IDebugParametersType value) Set the attribute for BROKER_DEBUG_PARAMETERS to the specified IDebugParametersType value.
void	setBrokerReplicationParameters(IBackupBrokerBean.IReplicationParametersType value) Set the attribute for BROKER_REPLICATION_PARAMETERS to the specified IReplicationParametersType value.
void	setClasspath(java.lang.String value) Set the attribute for CLASSPATH to the specified String 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

createBrokerDebugParameters

IBackupBrokerBean.IDebugParametersType createBrokerDebugParameters()
                                                                   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 setBrokerDebugParameters method.

Returns:

The new IDebugParametersType bean

Throws:

MgmtException - Thrown if there is some problem creating this object

createBrokerReplicationParameters

IBackupBrokerBean.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

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

IBackupBrokerBean.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

getBrokerDatabaseParameters

IBackupBrokerBean.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

getBrokerDebugParameters

IBackupBrokerBean.IDebugParametersType getBrokerDebugParameters()
                                                                throws MgmtException

Get the attribute for BROKER_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

getBrokerDebugParametersMetaData

IMgmtAttributeMetaData getBrokerDebugParametersMetaData()
                                                        throws MgmtException

Get the attribute metadata for BROKER_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

getBrokerRecoveryLogParameters

IBackupBrokerBean.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

IBackupBrokerBean.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

getBrokerSslParameters

IBackupBrokerBean.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

IBackupBrokerBean.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

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

IBackupBrokerBean.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

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

setBrokerDebugParameters

void setBrokerDebugParameters(IBackupBrokerBean.IDebugParametersType value)
                              throws MgmtException

Set the attribute for BROKER_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

setBrokerReplicationParameters

void setBrokerReplicationParameters(IBackupBrokerBean.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

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