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

All Superinterfaces:

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

All Known Subinterfaces:

IDomainBean

public interface IAbstractDomainBean
extends IMgmtBeanBase

Configuration Bean representing a 'Domain'

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

boolean	getAuditConfigureEvents() Get the attribute for AUDIT_CONFIGURE_EVENTS as a boolean value.
IMgmtAttributeMetaData	getAuditConfigureEventsMetaData() Get the attribute metadata for AUDIT_CONFIGURE_EVENTS.
boolean	getAuditManageEvents() Get the attribute for AUDIT_MANAGE_EVENTS as a boolean value.
IMgmtAttributeMetaData	getAuditManageEventsMetaData() Get the attribute metadata for AUDIT_MANAGE_EVENTS.
IMgmtBeanBase	getAuthenticationDomain() Get the attribute for AUTHENTICATION_DOMAIN as a IMgmtBeanBase value.
IMgmtBeanBase	getAuthenticationDomain(IMgmtBeanBase defValue) Get the attribute for AUTHENTICATION_DOMAIN as a IMgmtBeanBase value.
IMgmtAttributeMetaData	getAuthenticationDomainMetaData() Get the attribute metadata for AUTHENTICATION_DOMAIN.
java.lang.String	getCentralizedLogFile() Get the attribute for CENTRALIZED_LOG_FILE as a String value.
java.lang.String	getCentralizedLogFile(java.lang.String defValue) Get the attribute for CENTRALIZED_LOG_FILE as a String value.
IMgmtAttributeMetaData	getCentralizedLogFileMetaData() Get the attribute metadata for CENTRALIZED_LOG_FILE.
java.lang.String	getDefaultManagementAuditConfig() Get the attribute for DEFAULT_MANAGEMENT_AUDIT_CONFIG as a String value.
IMgmtAttributeMetaData	getDefaultManagementAuditConfigMetaData() Get the attribute metadata for DEFAULT_MANAGEMENT_AUDIT_CONFIG.
boolean	getEnableCentralizedAudit() Get the attribute for ENABLE_CENTRALIZED_AUDIT as a boolean value.
IMgmtAttributeMetaData	getEnableCentralizedAuditMetaData() Get the attribute metadata for ENABLE_CENTRALIZED_AUDIT.
boolean	getForceCentralizedLogging() Get the attribute for FORCE_CENTRALIZED_LOGGING as a boolean value.
IMgmtAttributeMetaData	getForceCentralizedLoggingMetaData() Get the attribute metadata for FORCE_CENTRALIZED_LOGGING.
long	getLogFileRolloverSizeThreshold() Get the attribute for LOG_FILE_ROLLOVER_SIZE_THRESHOLD as a long value.
IMgmtAttributeMetaData	getLogFileRolloverSizeThresholdMetaData() Get the attribute metadata for LOG_FILE_ROLLOVER_SIZE_THRESHOLD.
long	getLogFileSizeThreshold() Get the attribute for LOG_FILE_SIZE_THRESHOLD as a long value.
IMgmtAttributeMetaData	getLogFileSizeThresholdMetaData() Get the attribute metadata for LOG_FILE_SIZE_THRESHOLD.
void	setAuditConfigureEvents(boolean value) Set the attribute for AUDIT_CONFIGURE_EVENTS to the specified boolean value.
void	setAuditManageEvents(boolean value) Set the attribute for AUDIT_MANAGE_EVENTS to the specified boolean value.
void	setAuthenticationDomain(IMgmtBeanBase value) Set the attribute for AUTHENTICATION_DOMAIN to the specified IMgmtBeanBase value.
void	setCentralizedLogFile(java.lang.String value) Set the attribute for CENTRALIZED_LOG_FILE to the specified String value.
void	setDefaultManagementAuditConfig(java.lang.String value) Set the attribute for DEFAULT_MANAGEMENT_AUDIT_CONFIG to the specified String value.
void	setEnableCentralizedAudit(boolean value) Set the attribute for ENABLE_CENTRALIZED_AUDIT to the specified boolean value.
void	setForceCentralizedLogging(boolean value) Set the attribute for FORCE_CENTRALIZED_LOGGING to the specified boolean value.
void	setLogFileRolloverSizeThreshold(long value) Set the attribute for LOG_FILE_ROLLOVER_SIZE_THRESHOLD to the specified long value.
void	setLogFileSizeThreshold(long value) Set the attribute for LOG_FILE_SIZE_THRESHOLD to the specified long 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

getAuditConfigureEvents

boolean getAuditConfigureEvents()
                                throws MgmtException

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

getAuditConfigureEventsMetaData

IMgmtAttributeMetaData getAuditConfigureEventsMetaData()
                                                       throws MgmtException

Get the attribute metadata for AUDIT_CONFIGURE_EVENTS.

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

getAuditManageEvents

boolean getAuditManageEvents()
                             throws MgmtException

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

getAuditManageEventsMetaData

IMgmtAttributeMetaData getAuditManageEventsMetaData()
                                                    throws MgmtException

Get the attribute metadata for AUDIT_MANAGE_EVENTS.

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

getAuthenticationDomain

IMgmtBeanBase getAuthenticationDomain()
                                      throws MgmtException

Get the attribute for AUTHENTICATION_DOMAIN as a IMgmtBeanBase value. This is an optional attribute and a MgmtException will be thrown if the attribute does not exist.

Returns:

The IMgmtBeanBase value for this attribute

Throws:

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

getAuthenticationDomain

IMgmtBeanBase getAuthenticationDomain(IMgmtBeanBase defValue)
                                      throws MgmtException

Get the attribute for AUTHENTICATION_DOMAIN as a IMgmtBeanBase 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 IMgmtBeanBase value for this attribute

Throws:

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

getAuthenticationDomainMetaData

IMgmtAttributeMetaData getAuthenticationDomainMetaData()
                                                       throws MgmtException

Get the attribute metadata for AUTHENTICATION_DOMAIN.

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

getCentralizedLogFile

java.lang.String getCentralizedLogFile()
                                       throws MgmtException

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

getCentralizedLogFile

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

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

getCentralizedLogFileMetaData

IMgmtAttributeMetaData getCentralizedLogFileMetaData()
                                                     throws MgmtException

Get the attribute metadata for CENTRALIZED_LOG_FILE.

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

getDefaultManagementAuditConfig

java.lang.String getDefaultManagementAuditConfig()
                                                 throws MgmtException

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

getDefaultManagementAuditConfigMetaData

IMgmtAttributeMetaData getDefaultManagementAuditConfigMetaData()
                                                               throws MgmtException

Get the attribute metadata for DEFAULT_MANAGEMENT_AUDIT_CONFIG.

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

getEnableCentralizedAudit

boolean getEnableCentralizedAudit()
                                  throws MgmtException

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

getEnableCentralizedAuditMetaData

IMgmtAttributeMetaData getEnableCentralizedAuditMetaData()
                                                         throws MgmtException

Get the attribute metadata for ENABLE_CENTRALIZED_AUDIT.

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

getForceCentralizedLogging

boolean getForceCentralizedLogging()
                                   throws MgmtException

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

getForceCentralizedLoggingMetaData

IMgmtAttributeMetaData getForceCentralizedLoggingMetaData()
                                                          throws MgmtException

Get the attribute metadata for FORCE_CENTRALIZED_LOGGING.

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

getLogFileRolloverSizeThreshold

long getLogFileRolloverSizeThreshold()
                                     throws MgmtException

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

getLogFileRolloverSizeThresholdMetaData

IMgmtAttributeMetaData getLogFileRolloverSizeThresholdMetaData()
                                                               throws MgmtException

Get the attribute metadata for LOG_FILE_ROLLOVER_SIZE_THRESHOLD.

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

getLogFileSizeThreshold

long getLogFileSizeThreshold()
                             throws MgmtException

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

getLogFileSizeThresholdMetaData

IMgmtAttributeMetaData getLogFileSizeThresholdMetaData()
                                                       throws MgmtException

Get the attribute metadata for LOG_FILE_SIZE_THRESHOLD.

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

setAuditConfigureEvents

void setAuditConfigureEvents(boolean value)
                             throws MgmtException

Set the attribute for AUDIT_CONFIGURE_EVENTS to the specified boolean value.

Parameters:

value - The boolean value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setAuditManageEvents

void setAuditManageEvents(boolean value)
                          throws MgmtException

Set the attribute for AUDIT_MANAGE_EVENTS to the specified boolean value.

Parameters:

value - The boolean value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setAuthenticationDomain

void setAuthenticationDomain(IMgmtBeanBase value)
                             throws MgmtException

Set the attribute for AUTHENTICATION_DOMAIN to the specified IMgmtBeanBase value.

Parameters:

value - The IMgmtBeanBase value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setCentralizedLogFile

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

Set the attribute for CENTRALIZED_LOG_FILE to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setDefaultManagementAuditConfig

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

Set the attribute for DEFAULT_MANAGEMENT_AUDIT_CONFIG to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setEnableCentralizedAudit

void setEnableCentralizedAudit(boolean value)
                               throws MgmtException

Set the attribute for ENABLE_CENTRALIZED_AUDIT to the specified boolean value.

Parameters:

value - The boolean value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setForceCentralizedLogging

void setForceCentralizedLogging(boolean value)
                                throws MgmtException

Set the attribute for FORCE_CENTRALIZED_LOGGING to the specified boolean value.

Parameters:

value - The boolean value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLogFileRolloverSizeThreshold

void setLogFileRolloverSizeThreshold(long value)
                                     throws MgmtException

Set the attribute for LOG_FILE_ROLLOVER_SIZE_THRESHOLD to the specified long value.

Parameters:

value - The long value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLogFileSizeThreshold

void setLogFileSizeThreshold(long value)
                             throws MgmtException

Set the attribute for LOG_FILE_SIZE_THRESHOLD to the specified long value.

Parameters:

value - The long value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute