com.sonicsw.mf.mgmtapi.config
Interface IAuthenticationDomainBean

All Superinterfaces:

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

public interface IAuthenticationDomainBean
extends IAbstractAuthenticationDomainBean

Configuration Bean representing a AuthenticationDomain

Nested Class Summary

static interface	IAuthenticationDomainBean.IConnectionParamMap Inner class representing ConnectionParamMap This inner class contains inner data items that are keyed off a name.
static interface	IAuthenticationDomainBean.IGroupMapType Inner class representing GroupMapType This inner class contains inner data items that are keyed off a name.

Nested classes/interfaces inherited from interface com.sonicsw.mf.mgmtapi.config.gen.IAbstractAuthenticationDomainBean

IAbstractAuthenticationDomainBean.IAbstractConnectionParamMap, IAbstractAuthenticationDomainBean.IAbstractGroupMapType

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

IAuthenticationGroupBean	createGroupBean() Return a new group bean, with no attribute settings.
IAuthenticationUserBean	createUserBean() Return a new user bean, with no attribute settings.
IAuthenticationUserBean	createUserBean(java.lang.String userName, byte[] password)
IAuthenticationUserBean	createUserBean(java.lang.String userName, java.lang.String password)
void	deleteGroupBean(IAuthenticationGroupBean bean) Delete the group bean.
void	deleteUserBean(IAuthenticationUserBean bean) Delete the user bean.
IAuthenticationGroupBean	getGroupBean(java.lang.String name) Return the group bean in this domain where the GROUP_NAME attribute is equal to name
java.util.List	getGroupBeans() Return a List of the group beans defined in this authentication domain
IAuthenticationUserBean	getUserBean(java.lang.String name) Return the user bean in this domain where the USER_NAME attribute is equal to name
java.util.List	getUserBeans() Return a list of user beans defined in this domain.
boolean	isExternal() Returns true if this domain has been defined as external.

Methods inherited from interface com.sonicsw.mf.mgmtapi.config.gen.IAbstractAuthenticationDomainBean

createAuthSpiConnectionParameters, createGroupMap, createMgmtSpiConnectionParameters, getAuthSpi, getAuthSpi, getAuthSpiConnectionParameters, getAuthSpiConnectionParametersMetaData, getAuthSpiMetaData, getDomainName, getDomainNameMetaData, getExternal, getExternal, getExternalMetaData, getGroupMap, getGroupMapMetaData, getMgmtSpi, getMgmtSpi, getMgmtSpiConnectionParameters, getMgmtSpiConnectionParametersMetaData, getMgmtSpiMetaData, setAuthSpi, setAuthSpiConnectionParameters, setDomainName, setExternal, setGroupMap, setMgmtSpi, setMgmtSpiConnectionParameters

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

createGroupBean

IAuthenticationGroupBean createGroupBean()
                                         throws MgmtException

Return a new group bean, with no attribute settings.

Returns:

A new IAuthenticationGroupBean

Throws:

MgmtException - Thrown if there is some problem creating the group bean

createUserBean

IAuthenticationUserBean createUserBean()
                                       throws MgmtException

Return a new user bean, with no attribute settings.

Returns:

A new IAuthenticationUserBean

Throws:

MgmtException - Thrown if there is some problem creating the user bean

createUserBean

IAuthenticationUserBean createUserBean(java.lang.String userName,
                                       byte[] password)
                                       throws MgmtException

Throws:

MgmtException

createUserBean

IAuthenticationUserBean createUserBean(java.lang.String userName,
                                       java.lang.String password)
                                       throws MgmtException

Throws:

MgmtException

deleteGroupBean

void deleteGroupBean(IAuthenticationGroupBean bean)
                     throws MgmtException

Delete the group bean.

Parameters:

bean - The bean to be deleted.

Throws:

MgmtException - Thrown if there is some problem deleting the bean.

deleteUserBean

void deleteUserBean(IAuthenticationUserBean bean)
                    throws MgmtException

Delete the user bean. The user will be deleted from the groups it belonged to.

Parameters:

bean - The bean to be deleted.

Throws:

MgmtException - Thrown if there is some problem deleting the bean.

getGroupBean

IAuthenticationGroupBean getGroupBean(java.lang.String name)
                                      throws MgmtException

Return the group bean in this domain where the GROUP_NAME attribute is equal to name

Parameters:

name - The desired GROUP_NAME

Throws:

MgmtException - Thrown if there is some problem retrieving the bean or the bean does not exist.

getGroupBeans

java.util.List getGroupBeans()
                             throws MgmtException

Return a List of the group beans defined in this authentication domain

Returns:

A List of IAuthenticationGroupBean objects

Throws:

MgmtException - Thrown if there is some problem retrieving this data

getUserBean

IAuthenticationUserBean getUserBean(java.lang.String name)
                                    throws MgmtException

Return the user bean in this domain where the USER_NAME attribute is equal to name

Parameters:

name - The desired USER_NAME

Throws:

MgmtException - Thrown if there is some problem retrieving the bean or the bean does not exist.

getUserBeans

java.util.List getUserBeans()
                            throws MgmtException

Return a list of user beans defined in this domain.

Returns:

List of IAuthenticationUserBean objects

Throws:

MgmtException - Thrown if there is some problem retrieving the beans

isExternal

boolean isExternal()

Returns true if this domain has been defined as external.

Returns:

true if the domain is external, false otherwise