SilverStream
Application Server 3.5

com.sssw.rts.adminapi
Interface AgiAdmUser

All Superinterfaces:
AgiAdmChanges, AgiAdmElement, AgiAdmElementBase, AgiAdmPropertyBag, Principal

public interface AgiAdmUser
extends AgiAdmElement, Principal

Implemented by objects that represent entities of type "user".

See Also:
AgiAdmElement, AgiAdmGroup, Principal

Field Summary
static String ANONYMOUS_USER
          The "Anonymous" user type.
static String CERTIFICATEUSER
          The Certificate user type.
static String LDAPUSER
          The LDAP user type.
static String NISPLUSUSER
          The NIS+ user type.
static String NTUSER
          The Windows NT user type.
static String SILVERUSER
          The SilverUser type.
 
Fields inherited from interface com.sssw.rts.adminapi.AgiAdmElement
ACL_KEY, APPLY_TO_DESC, APPLY_TO_DESC_SUPPORTED, DIRECTORY_LIST_SECURITY, GET_PERMS_AS_ACL, GET_PERMS_DEFAULT, PROP_CERTIFICATE, PROP_DESCRIPTION, PROP_DOMAIN, PROP_FULL_NAME, PROP_IS_LOCKSMITH, PROP_LDAP_SERVER, PROP_NAME, PROP_NISPLUS_SERVER, PROP_PARENT_URL, PROP_PASSWORD, PROP_QUAL_NAME, PROP_TYPE, PROP_URL, REQUIRE_LOGIN, REQUIRE_LOGIN_SUPPORTED
 
Method Summary
 Enumeration getGroups(boolean sort)
          Get the list of groups the user belongs to.
 
Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElement
getPermissions, getServerURL, getURL, getVariables, isAuthorized, setPermissions
 
Methods implemented from interface java.security.Principal
equals, getName, hashCode, toString
 
Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElementBase
delete, getType
 
Methods implemented from interface com.sssw.rts.adminapi.AgiAdmPropertyBag
getProperties, getProperty, setProperties, setProperty
 
Methods implemented from interface com.sssw.rts.adminapi.AgiAdmChanges
cancelChanges, saveChanges
 

Field Detail

SILVERUSER

public static final String SILVERUSER
The SilverUser type.

NTUSER

public static final String NTUSER
The Windows NT user type.

LDAPUSER

public static final String LDAPUSER
The LDAP user type.

NISPLUSUSER

public static final String NISPLUSUSER
The NIS+ user type.

ANONYMOUS_USER

public static final String ANONYMOUS_USER
The "Anonymous" user type.

CERTIFICATEUSER

public static final String CERTIFICATEUSER
The Certificate user type.
Method Detail

getGroups

public Enumeration getGroups(boolean sort)
                      throws AgoUnrecoverableSystemException,
                             AgoSecurityException
Get the list of groups the user belongs to.
Parameters:
sort - "true" means "sort" (in ascending order), "false" means "do not sort"
Example:
// Get a user.
 AgiAdmUser user = (AgiAdmUser)server.getElement(
 	"user1", AgiAdmGroup.SILVERUSER, null);
 // Get the list of groups the user belongs to.
 Enumeration e = user.getGroups(true);
 // Go through the list.
 while (e.hasMoreElements())
 {
 	// Process the group information
 	AgiAdmGroup group = (AgiAdmGroup)e.nextElement();
 	// ... any processing code
 }
 

SilverStream
Application Server 3.5