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

All Superinterfaces:

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

All Known Subinterfaces:

ILoggerBean

public interface IAbstractLoggerBean
extends IMgmtBeanBase

Configuration Bean representing a 'Logger'

Nested Class Summary

static interface	IAbstractLoggerBean.IAbstractComponentCollectionsType Inner class representing ComponentCollectionsType This inner class contains inner data items that are keyed off a name.
static interface	IAbstractLoggerBean.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

ILoggerBean.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.
int	getCollectionsMonitorPollInterval() Get the attribute for COLLECTIONS_MONITOR_POLL_INTERVAL as a int value.
IMgmtAttributeMetaData	getCollectionsMonitorPollIntervalMetaData() Get the attribute metadata for COLLECTIONS_MONITOR_POLL_INTERVAL.
java.lang.String	getCollectionsMonitorRuntimeId() Get the attribute for COLLECTIONS_MONITOR_RUNTIME_ID as a String value.
IMgmtAttributeMetaData	getCollectionsMonitorRuntimeIdMetaData() Get the attribute metadata for COLLECTIONS_MONITOR_RUNTIME_ID.
ILoggerBean.IComponentCollectionsType	getComponentCollections() Get the attribute for COMPONENT_COLLECTIONS.
IMgmtAttributeMetaData	getComponentCollectionsMetaData() Get the attribute metadata for COMPONENT_COLLECTIONS.
java.lang.String	getL0gTextDelimiter() Get the attribute for L0G_TEXT_DELIMITER as a String value.
java.lang.String	getL0gTextDelimiter(java.lang.String defValue) Get the attribute for L0G_TEXT_DELIMITER as a String value.
IMgmtAttributeMetaData	getL0gTextDelimiterMetaData() Get the attribute metadata for L0G_TEXT_DELIMITER.
java.lang.String	getLog4jConfigurationFilePath() Get the attribute for LOG4J_CONFIGURATION_FILE_PATH as a String value.
IMgmtAttributeMetaData	getLog4jConfigurationFilePathMetaData() Get the attribute metadata for LOG4J_CONFIGURATION_FILE_PATH.
java.lang.String	getLogFormat() Get the attribute for LOG_FORMAT as a String value.
IMgmtAttributeMetaData	getLogFormatMetaData() Get the attribute metadata for LOG_FORMAT.
int	getMaxLookbackPeriod() Get the attribute for MAX_LOOKBACK_PERIOD as a int value.
IMgmtAttributeMetaData	getMaxLookbackPeriodMetaData() Get the attribute metadata for MAX_LOOKBACK_PERIOD.
ILoggerBean.IMetricsCollectionType	getMetrics() Get the attribute for METRICS.
IMgmtAttributeMetaData	getMetricsMetaData() Get the attribute metadata for METRICS.
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	setCollectionsMonitorPollInterval(int value) Set the attribute for COLLECTIONS_MONITOR_POLL_INTERVAL to the specified int value.
void	setCollectionsMonitorRuntimeId(java.lang.String value) Set the attribute for COLLECTIONS_MONITOR_RUNTIME_ID to the specified String value.
void	setL0gTextDelimiter(java.lang.String value) Set the attribute for L0G_TEXT_DELIMITER to the specified String value.
void	setLog4jConfigurationFilePath(java.lang.String value) Set the attribute for LOG4J_CONFIGURATION_FILE_PATH to the specified String value.
void	setLogFormat(java.lang.String value) Set the attribute for LOG_FORMAT to the specified String value.
void	setMaxLookbackPeriod(int value) Set the attribute for MAX_LOOKBACK_PERIOD to the specified int value.
void	setMetrics(ILoggerBean.IMetricsCollectionType value) Set the attribute for METRICS to the specified IMetricsCollectionType 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

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

getCollectionsMonitorPollInterval

int getCollectionsMonitorPollInterval()
                                      throws MgmtException

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

getCollectionsMonitorPollIntervalMetaData

IMgmtAttributeMetaData getCollectionsMonitorPollIntervalMetaData()
                                                                 throws MgmtException

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

getCollectionsMonitorRuntimeId

java.lang.String getCollectionsMonitorRuntimeId()
                                                throws MgmtException

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

getCollectionsMonitorRuntimeIdMetaData

IMgmtAttributeMetaData getCollectionsMonitorRuntimeIdMetaData()
                                                              throws MgmtException

Get the attribute metadata for COLLECTIONS_MONITOR_RUNTIME_ID.

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

getComponentCollections

ILoggerBean.IComponentCollectionsType getComponentCollections()
                                                              throws MgmtException

Get the attribute for COMPONENT_COLLECTIONS.

Returns:

The IComponentCollectionsType value for this attribute

Throws:

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

getComponentCollectionsMetaData

IMgmtAttributeMetaData getComponentCollectionsMetaData()
                                                       throws MgmtException

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

getL0gTextDelimiter

java.lang.String getL0gTextDelimiter()
                                     throws MgmtException

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

getL0gTextDelimiter

java.lang.String getL0gTextDelimiter(java.lang.String defValue)
                                     throws MgmtException

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

getL0gTextDelimiterMetaData

IMgmtAttributeMetaData getL0gTextDelimiterMetaData()
                                                   throws MgmtException

Get the attribute metadata for L0G_TEXT_DELIMITER.

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

getLog4jConfigurationFilePath

java.lang.String getLog4jConfigurationFilePath()
                                               throws MgmtException

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

getLog4jConfigurationFilePathMetaData

IMgmtAttributeMetaData getLog4jConfigurationFilePathMetaData()
                                                             throws MgmtException

Get the attribute metadata for LOG4J_CONFIGURATION_FILE_PATH.

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

getLogFormat

java.lang.String getLogFormat()
                              throws MgmtException

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

getLogFormatMetaData

IMgmtAttributeMetaData getLogFormatMetaData()
                                            throws MgmtException

Get the attribute metadata for LOG_FORMAT.

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

getMaxLookbackPeriod

int getMaxLookbackPeriod()
                         throws MgmtException

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

getMaxLookbackPeriodMetaData

IMgmtAttributeMetaData getMaxLookbackPeriodMetaData()
                                                    throws MgmtException

Get the attribute metadata for MAX_LOOKBACK_PERIOD.

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

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

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

setCollectionsMonitorPollInterval

void setCollectionsMonitorPollInterval(int value)
                                       throws MgmtException

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

setCollectionsMonitorRuntimeId

void setCollectionsMonitorRuntimeId(java.lang.String value)
                                    throws MgmtException

Set the attribute for COLLECTIONS_MONITOR_RUNTIME_ID to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setL0gTextDelimiter

void setL0gTextDelimiter(java.lang.String value)
                         throws MgmtException

Set the attribute for L0G_TEXT_DELIMITER to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLog4jConfigurationFilePath

void setLog4jConfigurationFilePath(java.lang.String value)
                                   throws MgmtException

Set the attribute for LOG4J_CONFIGURATION_FILE_PATH to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLogFormat

void setLogFormat(java.lang.String value)
                  throws MgmtException

Set the attribute for LOG_FORMAT to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setMaxLookbackPeriod

void setMaxLookbackPeriod(int value)
                          throws MgmtException

Set the attribute for MAX_LOOKBACK_PERIOD 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(ILoggerBean.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