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

All Superinterfaces:

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

All Known Subinterfaces:

ICollectionsMonitorBean

public interface IAbstractCollectionsMonitorBean
extends IMgmtBeanBase

Configuration Bean representing a 'CollectionsMonitor'

Nested Class Summary

static interface	IAbstractCollectionsMonitorBean.IAbstractCollectionList Inner class representing CollectionList This inner class contains inner data items that have a zero based index.
static interface	IAbstractCollectionsMonitorBean.IAbstractFsStorageType Inner class representing FsStorageType This class extends IMgmtListBase
static interface	IAbstractCollectionsMonitorBean.IAbstractJdbcStorageType Inner class representing JdbcStorageType This class extends IMgmtListBase
static interface	IAbstractCollectionsMonitorBean.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

ICollectionsMonitorBean.IJdbcStorageType	createJdbcHistoryStorage() Create an instance of an IJdbcStorageType attribute.
ICollectionsMonitorBean.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.
ICollectionsMonitorBean.ICollectionList	getCollections() Get the attribute for COLLECTIONS.
IMgmtAttributeMetaData	getCollectionsMetaData() Get the attribute metadata for COLLECTIONS.
ICollectionsMonitorBean.IFsStorageType	getFsHistoryStorage() Get the attribute for FS_HISTORY_STORAGE.
IMgmtAttributeMetaData	getFsHistoryStorageMetaData() Get the attribute metadata for FS_HISTORY_STORAGE.
int	getHistoryDurationHours() Get the attribute for HISTORY_DURATION_HOURS as a int value.
IMgmtAttributeMetaData	getHistoryDurationHoursMetaData() Get the attribute metadata for HISTORY_DURATION_HOURS.
ICollectionsMonitorBean.IJdbcStorageType	getJdbcHistoryStorage() Get the attribute for JDBC_HISTORY_STORAGE.
IMgmtAttributeMetaData	getJdbcHistoryStorageMetaData() Get the attribute metadata for JDBC_HISTORY_STORAGE.
long	getMaxStorageSize() Get the attribute for MAX_STORAGE_SIZE as a long value.
IMgmtAttributeMetaData	getMaxStorageSizeMetaData() Get the attribute metadata for MAX_STORAGE_SIZE.
ICollectionsMonitorBean.IMetricsCollectionType	getMetrics() Get the attribute for METRICS.
IMgmtAttributeMetaData	getMetricsMetaData() Get the attribute metadata for METRICS.
int	getNotificationSubscriptionTimeout() Get the attribute for NOTIFICATION_SUBSCRIPTION_TIMEOUT as a int value.
IMgmtAttributeMetaData	getNotificationSubscriptionTimeoutMetaData() Get the attribute metadata for NOTIFICATION_SUBSCRIPTION_TIMEOUT.
boolean	getSaveMonitoredNotifications() Get the attribute for SAVE_MONITORED_NOTIFICATIONS as a boolean value.
IMgmtAttributeMetaData	getSaveMonitoredNotificationsMetaData() Get the attribute metadata for SAVE_MONITORED_NOTIFICATIONS.
boolean	getSaveThresholdNotifications() Get the attribute for SAVE_THRESHOLD_NOTIFICATIONS as a boolean value.
IMgmtAttributeMetaData	getSaveThresholdNotificationsMetaData() Get the attribute metadata for SAVE_THRESHOLD_NOTIFICATIONS.
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	setHistoryDurationHours(int value) Set the attribute for HISTORY_DURATION_HOURS to the specified int value.
void	setJdbcHistoryStorage(ICollectionsMonitorBean.IJdbcStorageType value) Set the attribute for JDBC_HISTORY_STORAGE to the specified IJdbcStorageType value.
void	setMaxStorageSize(long value) Set the attribute for MAX_STORAGE_SIZE to the specified long value.
void	setMetrics(ICollectionsMonitorBean.IMetricsCollectionType value) Set the attribute for METRICS to the specified IMetricsCollectionType value.
void	setNotificationSubscriptionTimeout(int value) Set the attribute for NOTIFICATION_SUBSCRIPTION_TIMEOUT to the specified int value.
void	setSaveMonitoredNotifications(boolean value) Set the attribute for SAVE_MONITORED_NOTIFICATIONS to the specified boolean value.
void	setSaveThresholdNotifications(boolean value) Set the attribute for SAVE_THRESHOLD_NOTIFICATIONS to the specified boolean 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

createJdbcHistoryStorage

ICollectionsMonitorBean.IJdbcStorageType createJdbcHistoryStorage()
                                                                  throws MgmtException

Create an instance of an IJdbcStorageType 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 setJdbcHistoryStorage method.

Returns:

The new IJdbcStorageType bean

Throws:

MgmtException - Thrown if there is some problem creating this object

createMetrics

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

getCollections

ICollectionsMonitorBean.ICollectionList getCollections()
                                                       throws MgmtException

Get the attribute for COLLECTIONS.

Returns:

The ICollectionList value for this attribute

Throws:

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

getCollectionsMetaData

IMgmtAttributeMetaData getCollectionsMetaData()
                                              throws MgmtException

Get the attribute metadata for COLLECTIONS.

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

getFsHistoryStorage

ICollectionsMonitorBean.IFsStorageType getFsHistoryStorage()
                                                           throws MgmtException

Get the attribute for FS_HISTORY_STORAGE.

Returns:

The IFsStorageType value for this attribute

Throws:

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

getFsHistoryStorageMetaData

IMgmtAttributeMetaData getFsHistoryStorageMetaData()
                                                   throws MgmtException

Get the attribute metadata for FS_HISTORY_STORAGE.

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

getHistoryDurationHours

int getHistoryDurationHours()
                            throws MgmtException

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

getHistoryDurationHoursMetaData

IMgmtAttributeMetaData getHistoryDurationHoursMetaData()
                                                       throws MgmtException

Get the attribute metadata for HISTORY_DURATION_HOURS.

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

getJdbcHistoryStorage

ICollectionsMonitorBean.IJdbcStorageType getJdbcHistoryStorage()
                                                               throws MgmtException

Get the attribute for JDBC_HISTORY_STORAGE.

Returns:

The IJdbcStorageType value for this attribute

Throws:

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

getJdbcHistoryStorageMetaData

IMgmtAttributeMetaData getJdbcHistoryStorageMetaData()
                                                     throws MgmtException

Get the attribute metadata for JDBC_HISTORY_STORAGE.

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

getMaxStorageSize

long getMaxStorageSize()
                       throws MgmtException

Get the attribute for MAX_STORAGE_SIZE as a long value.

Returns:

The long value for this attribute

Throws:

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

getMaxStorageSizeMetaData

IMgmtAttributeMetaData getMaxStorageSizeMetaData()
                                                 throws MgmtException

Get the attribute metadata for MAX_STORAGE_SIZE.

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

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

getNotificationSubscriptionTimeout

int getNotificationSubscriptionTimeout()
                                       throws MgmtException

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

getNotificationSubscriptionTimeoutMetaData

IMgmtAttributeMetaData getNotificationSubscriptionTimeoutMetaData()
                                                                  throws MgmtException

Get the attribute metadata for NOTIFICATION_SUBSCRIPTION_TIMEOUT.

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

getSaveMonitoredNotifications

boolean getSaveMonitoredNotifications()
                                      throws MgmtException

Get the attribute for SAVE_MONITORED_NOTIFICATIONS as a boolean value.

Returns:

The boolean value for this attribute

Throws:

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

getSaveMonitoredNotificationsMetaData

IMgmtAttributeMetaData getSaveMonitoredNotificationsMetaData()
                                                             throws MgmtException

Get the attribute metadata for SAVE_MONITORED_NOTIFICATIONS.

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

getSaveThresholdNotifications

boolean getSaveThresholdNotifications()
                                      throws MgmtException

Get the attribute for SAVE_THRESHOLD_NOTIFICATIONS as a boolean value.

Returns:

The boolean value for this attribute

Throws:

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

getSaveThresholdNotificationsMetaData

IMgmtAttributeMetaData getSaveThresholdNotificationsMetaData()
                                                             throws MgmtException

Get the attribute metadata for SAVE_THRESHOLD_NOTIFICATIONS.

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

setHistoryDurationHours

void setHistoryDurationHours(int value)
                             throws MgmtException

Set the attribute for HISTORY_DURATION_HOURS to the specified int value.

Parameters:

value - The int value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setJdbcHistoryStorage

void setJdbcHistoryStorage(ICollectionsMonitorBean.IJdbcStorageType value)
                           throws MgmtException

Set the attribute for JDBC_HISTORY_STORAGE to the specified IJdbcStorageType value.

Parameters:

value - The IJdbcStorageType value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setMaxStorageSize

void setMaxStorageSize(long value)
                       throws MgmtException

Set the attribute for MAX_STORAGE_SIZE to the specified long value.

Parameters:

value - The long value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setMetrics

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

setNotificationSubscriptionTimeout

void setNotificationSubscriptionTimeout(int value)
                                        throws MgmtException

Set the attribute for NOTIFICATION_SUBSCRIPTION_TIMEOUT to the specified int value.

Parameters:

value - The int value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setSaveMonitoredNotifications

void setSaveMonitoredNotifications(boolean value)
                                   throws MgmtException

Set the attribute for SAVE_MONITORED_NOTIFICATIONS to the specified boolean value.

Parameters:

value - The boolean value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setSaveThresholdNotifications

void setSaveThresholdNotifications(boolean value)
                                   throws MgmtException

Set the attribute for SAVE_THRESHOLD_NOTIFICATIONS to the specified boolean value.

Parameters:

value - The boolean value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute