com.sonicsw.mf.mgmtapi.config.gen
Interface IAbstractAgentManagerBean

All Superinterfaces:

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

All Known Subinterfaces:

IAgentManagerBean

public interface IAbstractAgentManagerBean
extends IMgmtBeanBase

Configuration Bean representing a 'AgentManager'

Nested Class Summary

static interface	IAbstractAgentManagerBean.IAbstractAMReferences Inner class representing AMReferences This class extends IMgmtListBase
static interface	IAbstractAgentManagerBean.IAbstractMetricsCollectionType Inner class representing MetricsCollectionType 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

IAgentManagerBean.IMetricsCollectionType	createMetrics() Create an instance of an IMetricsCollectionType attribute.
java.lang.String	getArchiveName() Get the attribute for ARCHIVE_NAME as a String value.
IMgmtAttributeMetaData	getArchiveNameMetaData() Get the attribute metadata for ARCHIVE_NAME.
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.
IAgentManagerBean.IAMReferences	getConfigElementReferences() Get the attribute for CONFIG_ELEMENT_REFERENCES.
IMgmtAttributeMetaData	getConfigElementReferencesMetaData() Get the attribute metadata for CONFIG_ELEMENT_REFERENCES.
int	getFaultDetectionInterval() Get the attribute for FAULT_DETECTION_INTERVAL as a int value.
IMgmtAttributeMetaData	getFaultDetectionIntervalMetaData() Get the attribute metadata for FAULT_DETECTION_INTERVAL.
int	getMaxPollThreads() Get the attribute for MAX_POLL_THREADS as a int value.
IMgmtAttributeMetaData	getMaxPollThreadsMetaData() Get the attribute metadata for MAX_POLL_THREADS.
IAgentManagerBean.IMetricsCollectionType	getMetrics() Get the attribute for METRICS.
IMgmtAttributeMetaData	getMetricsMetaData() Get the attribute metadata for METRICS.
int	getMinPollThreads() Get the attribute for MIN_POLL_THREADS as a int value.
IMgmtAttributeMetaData	getMinPollThreadsMetaData() Get the attribute metadata for MIN_POLL_THREADS.
void	setArchiveName(java.lang.String value) Set the attribute for ARCHIVE_NAME to the specified String value.
void	setClasspath(java.lang.String value) Set the attribute for CLASSPATH to the specified String value.
void	setFaultDetectionInterval(int value) Set the attribute for FAULT_DETECTION_INTERVAL to the specified int value.
void	setMaxPollThreads(int value) Set the attribute for MAX_POLL_THREADS to the specified int value.
void	setMetrics(IAgentManagerBean.IMetricsCollectionType value) Set the attribute for METRICS to the specified IMetricsCollectionType value.
void	setMinPollThreads(int value) Set the attribute for MIN_POLL_THREADS to the specified int 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

createMetrics

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

getArchiveName

java.lang.String getArchiveName()
                                throws MgmtException

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

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

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

IAgentManagerBean.IAMReferences getConfigElementReferences()
                                                           throws MgmtException

Get the attribute for CONFIG_ELEMENT_REFERENCES.

Returns:

The IAMReferences 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

getFaultDetectionInterval

int getFaultDetectionInterval()
                              throws MgmtException

Get the attribute for FAULT_DETECTION_INTERVAL as a int value.

Returns:

The int value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getFaultDetectionIntervalMetaData

IMgmtAttributeMetaData getFaultDetectionIntervalMetaData()
                                                         throws MgmtException

Get the attribute metadata for FAULT_DETECTION_INTERVAL.

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

getMaxPollThreads

int getMaxPollThreads()
                      throws MgmtException

Get the attribute for MAX_POLL_THREADS as a int value.

Returns:

The int value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getMaxPollThreadsMetaData

IMgmtAttributeMetaData getMaxPollThreadsMetaData()
                                                 throws MgmtException

Get the attribute metadata for MAX_POLL_THREADS.

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

getMetrics

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

getMinPollThreads

int getMinPollThreads()
                      throws MgmtException

Get the attribute for MIN_POLL_THREADS as a int value.

Returns:

The int value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getMinPollThreadsMetaData

IMgmtAttributeMetaData getMinPollThreadsMetaData()
                                                 throws MgmtException

Get the attribute metadata for MIN_POLL_THREADS.

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

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

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

setFaultDetectionInterval

void setFaultDetectionInterval(int value)
                               throws MgmtException

Set the attribute for FAULT_DETECTION_INTERVAL to the specified int value.

Parameters:

value - The int value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setMaxPollThreads

void setMaxPollThreads(int value)
                       throws MgmtException

Set the attribute for MAX_POLL_THREADS to the specified int value.

Parameters:

value - The int value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setMetrics

void setMetrics(IAgentManagerBean.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

setMinPollThreads

void setMinPollThreads(int value)
                       throws MgmtException

Set the attribute for MIN_POLL_THREADS to the specified int value.

Parameters:

value - The int value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute