|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.security.GenericAccount
public class GenericAccount
A generic implementation of the Account
interface.
Account
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Fields inherited from interface atg.security.AccountTypes |
---|
ANY_ACCOUNT, GROUP_ACCOUNT, LOGIN_ACCOUNT, PRIVILEGE_ACCOUNT |
Constructor Summary | |
---|---|
GenericAccount(AccountManager pAccountManager,
java.lang.String pAccountName,
int pType)
Creates an account object for an account with the given name. |
|
GenericAccount(AccountManager pAccountManager,
java.lang.String pAccountName,
int pType,
java.util.Map pAttributes)
Creates an account object for an account with the given name and attributes. |
Method Summary | |
---|---|
void |
addGroup(java.lang.String pNewGroupName)
Makes this account a member of a new group. |
AccountManager |
getAccountManager()
Returns the account manager associated with this account. |
java.lang.String |
getAccountName()
Returns the name of the account. |
int |
getAccountType()
Returns the account type. |
java.lang.String |
getAttribute(java.lang.String pAttributeName)
Retrieves the string value of a given attribute. |
java.util.Map |
getAttributes()
Retrieves a mapping of all defined attributes and their values from the account. |
java.lang.String |
getDisplayNameForAttribute(java.lang.String pAttributeName)
Returns the display name that should be associated with an attribute. |
Persona |
getPersona()
Returns the Persona object that corresponds to this account. |
UserAuthority |
getUserAuthority()
Returns the user authority that will be used for constructing a Persona object for this account. |
java.util.Iterator |
listGroups()
Returns an iterator of the groups that this account is a member of. |
java.util.Iterator |
listMembers()
If this Account is a group, this will return the names of
the members of the group. |
void |
removeGroup(java.lang.String pGroupName)
Removes a group from the set of groups that this account is a member of. |
void |
setAttribute(java.lang.String pAttributeName,
java.lang.String pNewValue)
Changes the value of a given attribute. |
void |
setAttributes(java.util.Map pNewAttributes)
Changes the values of a set of account attributes. |
void |
setGroups(java.lang.String[] pNewGroups)
Makes this account a member of a set of groups. |
void |
setUserAuthority(UserAuthority pUserAuthority)
Changes the user authority used for creating Persona objects for this account. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public GenericAccount(AccountManager pAccountManager, java.lang.String pAccountName, int pType)
pAccountManager
- The account manager that manages this account.pAccountName
- The name of the account we are creating an object for.pType
- The type of accountpublic GenericAccount(AccountManager pAccountManager, java.lang.String pAccountName, int pType, java.util.Map pAttributes)
pAccountManager
- The account manager that manages this account.pAccountName
- The name of the account we are creating an object for.pType
- The type of accountpAttributes
- A set of attributes to assign to the account. These
attributes will be copied (if not null).Method Detail |
---|
public Persona getPersona()
public UserAuthority getUserAuthority()
public void setUserAuthority(UserAuthority pUserAuthority)
public AccountManager getAccountManager()
getAccountManager
in interface Account
public java.lang.String getAccountName()
getAccountName
in interface Account
public int getAccountType()
getAccountType
in interface Account
AccountTypes
public java.lang.String getAttribute(java.lang.String pAttributeName)
getAttribute
in interface Account
pAttributeName
- The name of the desired attribute.public java.util.Map getAttributes()
getAttributes
in interface Account
public void setAttribute(java.lang.String pAttributeName, java.lang.String pNewValue)
setAttribute
in interface Account
pAttributeName
- The name of the attribute to change.pNewValue
- The new value to give to the attribute. If this value
is null
, the attribute is removed.public void setAttributes(java.util.Map pNewAttributes)
setAttributes
in interface Account
newAttributes
- The set of attributes to change, and their
associated values.public java.util.Iterator listGroups()
listGroups
in interface Account
public void addGroup(java.lang.String pNewGroupName) throws NoSuchAccountException, PermissionDeniedException
addGroup
in interface Account
pNewGroupName
- The name of the group to add membership to.
NoSuchAccountException
- Indicates that the specified group
does not exist.
PermissionDeniedException
public void setGroups(java.lang.String[] pNewGroups) throws NoSuchAccountException, PermissionDeniedException
setGroups
in interface Account
pNewGroups
- An array of names of groups to remove membership from.
NoSuchAccountException
- Indicates that a specified group
does not exist.
PermissionDeniedException
public void removeGroup(java.lang.String pGroupName) throws NoSuchAccountException, PermissionDeniedException
removeGroup
in interface Account
pGroupName
- The name of the group to remove membership from.
NoSuchAccountException
- Indicates that the account is not
a member of the group.
PermissionDeniedException
public java.util.Iterator listMembers()
Account
is a group, this will return the names of
the members of the group. If this Account is not a group, this returns
null
.
listMembers
in interface Account
public java.lang.String getDisplayNameForAttribute(java.lang.String pAttributeName)
getDisplayNameForAttribute
in interface atg.security.I18nAccount
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |