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

All Superinterfaces:

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

All Known Subinterfaces:

IAuthenticationDomainBean

public interface IAbstractAuthenticationDomainBean
extends IMgmtBeanBase

Configuration Bean representing a 'AuthenticationDomain'

Nested Class Summary

static interface	IAbstractAuthenticationDomainBean.IAbstractConnectionParamMap Inner class representing ConnectionParamMap This inner class contains inner data items that are keyed off a name.
static interface	IAbstractAuthenticationDomainBean.IAbstractGroupMapType Inner class representing GroupMapType This inner class contains inner data items that are keyed off a name.

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

IAuthenticationDomainBean.IConnectionParamMap	createAuthSpiConnectionParameters() Create an instance of an IConnectionParamMap attribute.
IAuthenticationDomainBean.IGroupMapType	createGroupMap() Create an instance of an IGroupMapType attribute.
IAuthenticationDomainBean.IConnectionParamMap	createMgmtSpiConnectionParameters() Create an instance of an IConnectionParamMap attribute.
IMgmtBeanBase	getAuthSpi() Get the attribute for AUTH_SPI as a IMgmtBeanBase value.
IMgmtBeanBase	getAuthSpi(IMgmtBeanBase defValue) Get the attribute for AUTH_SPI as a IMgmtBeanBase value.
IAuthenticationDomainBean.IConnectionParamMap	getAuthSpiConnectionParameters() Get the attribute for AUTH_SPI_CONNECTION_PARAMETERS.
IMgmtAttributeMetaData	getAuthSpiConnectionParametersMetaData() Get the attribute metadata for AUTH_SPI_CONNECTION_PARAMETERS.
IMgmtAttributeMetaData	getAuthSpiMetaData() Get the attribute metadata for AUTH_SPI.
java.lang.String	getDomainName() Get the attribute for DOMAIN_NAME as a String value.
IMgmtAttributeMetaData	getDomainNameMetaData() Get the attribute metadata for DOMAIN_NAME.
boolean	getExternal() Get the attribute for EXTERNAL as a boolean value.
boolean	getExternal(boolean defValue) Get the attribute for EXTERNAL as a boolean value.
IMgmtAttributeMetaData	getExternalMetaData() Get the attribute metadata for EXTERNAL.
IAuthenticationDomainBean.IGroupMapType	getGroupMap() Get the attribute for GROUP_MAP.
IMgmtAttributeMetaData	getGroupMapMetaData() Get the attribute metadata for GROUP_MAP.
IMgmtBeanBase	getMgmtSpi() Get the attribute for MGMT_SPI as a IMgmtBeanBase value.
IMgmtBeanBase	getMgmtSpi(IMgmtBeanBase defValue) Get the attribute for MGMT_SPI as a IMgmtBeanBase value.
IAuthenticationDomainBean.IConnectionParamMap	getMgmtSpiConnectionParameters() Get the attribute for MGMT_SPI_CONNECTION_PARAMETERS.
IMgmtAttributeMetaData	getMgmtSpiConnectionParametersMetaData() Get the attribute metadata for MGMT_SPI_CONNECTION_PARAMETERS.
IMgmtAttributeMetaData	getMgmtSpiMetaData() Get the attribute metadata for MGMT_SPI.
void	setAuthSpi(IMgmtBeanBase value) Set the attribute for AUTH_SPI to the specified IMgmtBeanBase value.
void	setAuthSpiConnectionParameters(IAuthenticationDomainBean.IConnectionParamMap value) Set the attribute for AUTH_SPI_CONNECTION_PARAMETERS to the specified IConnectionParamMap value.
void	setDomainName(java.lang.String value) Set the attribute for DOMAIN_NAME to the specified String value.
void	setExternal(boolean value) Set the attribute for EXTERNAL to the specified boolean value.
void	setGroupMap(IAuthenticationDomainBean.IGroupMapType value) Set the attribute for GROUP_MAP to the specified IGroupMapType value.
void	setMgmtSpi(IMgmtBeanBase value) Set the attribute for MGMT_SPI to the specified IMgmtBeanBase value.
void	setMgmtSpiConnectionParameters(IAuthenticationDomainBean.IConnectionParamMap value) Set the attribute for MGMT_SPI_CONNECTION_PARAMETERS to the specified IConnectionParamMap 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

createAuthSpiConnectionParameters

IAuthenticationDomainBean.IConnectionParamMap createAuthSpiConnectionParameters()
                                                                                throws MgmtException

Create an instance of an IConnectionParamMap 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 setAuthSpiConnectionParameters method.

Returns:

The new IConnectionParamMap bean

Throws:

MgmtException - Thrown if there is some problem creating this object

createGroupMap

IAuthenticationDomainBean.IGroupMapType createGroupMap()
                                                       throws MgmtException

Create an instance of an IGroupMapType 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 setGroupMap method.

Returns:

The new IGroupMapType bean

Throws:

MgmtException - Thrown if there is some problem creating this object

createMgmtSpiConnectionParameters

IAuthenticationDomainBean.IConnectionParamMap createMgmtSpiConnectionParameters()
                                                                                throws MgmtException

Create an instance of an IConnectionParamMap 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 setMgmtSpiConnectionParameters method.

Returns:

The new IConnectionParamMap bean

Throws:

MgmtException - Thrown if there is some problem creating this object

getAuthSpi

IMgmtBeanBase getAuthSpi()
                         throws MgmtException

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

getAuthSpi

IMgmtBeanBase getAuthSpi(IMgmtBeanBase defValue)
                         throws MgmtException

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

getAuthSpiConnectionParameters

IAuthenticationDomainBean.IConnectionParamMap getAuthSpiConnectionParameters()
                                                                             throws MgmtException

Get the attribute for AUTH_SPI_CONNECTION_PARAMETERS.

Returns:

The IConnectionParamMap value for this attribute

Throws:

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

getAuthSpiConnectionParametersMetaData

IMgmtAttributeMetaData getAuthSpiConnectionParametersMetaData()
                                                              throws MgmtException

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

getAuthSpiMetaData

IMgmtAttributeMetaData getAuthSpiMetaData()
                                          throws MgmtException

Get the attribute metadata for AUTH_SPI.

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

getDomainName

java.lang.String getDomainName()
                               throws MgmtException

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

getDomainNameMetaData

IMgmtAttributeMetaData getDomainNameMetaData()
                                             throws MgmtException

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

getExternal

boolean getExternal()
                    throws MgmtException

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

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

getExternal

boolean getExternal(boolean defValue)
                    throws MgmtException

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

Throws:

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

getExternalMetaData

IMgmtAttributeMetaData getExternalMetaData()
                                           throws MgmtException

Get the attribute metadata for EXTERNAL.

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

getGroupMap

IAuthenticationDomainBean.IGroupMapType getGroupMap()
                                                    throws MgmtException

Get the attribute for GROUP_MAP.

Returns:

The IGroupMapType value for this attribute

Throws:

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

getGroupMapMetaData

IMgmtAttributeMetaData getGroupMapMetaData()
                                           throws MgmtException

Get the attribute metadata for GROUP_MAP.

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

getMgmtSpi

IMgmtBeanBase getMgmtSpi()
                         throws MgmtException

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

getMgmtSpi

IMgmtBeanBase getMgmtSpi(IMgmtBeanBase defValue)
                         throws MgmtException

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

getMgmtSpiConnectionParameters

IAuthenticationDomainBean.IConnectionParamMap getMgmtSpiConnectionParameters()
                                                                             throws MgmtException

Get the attribute for MGMT_SPI_CONNECTION_PARAMETERS.

Returns:

The IConnectionParamMap value for this attribute

Throws:

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

getMgmtSpiConnectionParametersMetaData

IMgmtAttributeMetaData getMgmtSpiConnectionParametersMetaData()
                                                              throws MgmtException

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

getMgmtSpiMetaData

IMgmtAttributeMetaData getMgmtSpiMetaData()
                                          throws MgmtException

Get the attribute metadata for MGMT_SPI.

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

setAuthSpi

void setAuthSpi(IMgmtBeanBase value)
                throws MgmtException

Set the attribute for AUTH_SPI to the specified IMgmtBeanBase value.

Parameters:

value - The IMgmtBeanBase value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setAuthSpiConnectionParameters

void setAuthSpiConnectionParameters(IAuthenticationDomainBean.IConnectionParamMap value)
                                    throws MgmtException

Set the attribute for AUTH_SPI_CONNECTION_PARAMETERS to the specified IConnectionParamMap value.

Parameters:

value - The IConnectionParamMap value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setDomainName

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

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

setExternal

void setExternal(boolean value)
                 throws MgmtException

Set the attribute for EXTERNAL to the specified boolean value.

Parameters:

value - The boolean value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setGroupMap

void setGroupMap(IAuthenticationDomainBean.IGroupMapType value)
                 throws MgmtException

Set the attribute for GROUP_MAP to the specified IGroupMapType value.

Parameters:

value - The IGroupMapType value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setMgmtSpi

void setMgmtSpi(IMgmtBeanBase value)
                throws MgmtException

Set the attribute for MGMT_SPI to the specified IMgmtBeanBase value.

Parameters:

value - The IMgmtBeanBase value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setMgmtSpiConnectionParameters

void setMgmtSpiConnectionParameters(IAuthenticationDomainBean.IConnectionParamMap value)
                                    throws MgmtException

Set the attribute for MGMT_SPI_CONNECTION_PARAMETERS to the specified IConnectionParamMap value.

Parameters:

value - The IConnectionParamMap value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute