com.sssw.rts.adminapi
Interface AgiAdmContainer

All Superinterfaces:

AgiAdmChanges, AgiAdmContainerBase, AgiAdmElement, AgiAdmElementBase, AgiAdmPropertyBag

All Known Subinterfaces:

AgiAdmClusterServer, AgiAdmDatabase, AgiAdmDirectory, AgiAdmGroup, AgiAdmServer, AgiDatabase, AgiServer

public interface AgiAdmContainer

extends AgiAdmElement, AgiAdmContainerBase

Implemented by objects that represent containers such as servers, databases, directories, and groups -- that is, entities that contain other entities.

Field Summary

static int	GET_CHILDREN_EX A flag value to be used in the getChildren method.
static int	GET_CHILDREN_NTDOMAINS_PRIMARY_ONLY A flag value to be used in the getChildren method.
static int	GET_CHILDREN_NTDOMAINS_TRUSTED_ONLY A flag value to be used in the getChildren method.
static int	GET_CHILDREN_SORTED A flag value to be used in the getChildren method.
static int	GET_CHILDREN_WITH_INFO A flag value to be used in the getChildren method.

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

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmContainerBase

GET_CHILDREN_DFLT

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElement

getPermissions, getServerURL, getURL, getVariables, isAuthorized, setPermissions

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmContainerBase

addChild, getChild, getChildren

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElementBase

delete, getName, 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

GET_CHILDREN_SORTED

public static final int GET_CHILDREN_SORTED

A flag value to be used in the getChildren method. Tells the method to return its results sorted. The sorting is done in the ascending order. This flag value is common for the getChildren method on all the container objects.

See Also:

AgiAdmContainerBase.getChildren(int options)

Example:

		AgiAdmGroup group = ... // get to a group
		Enumeration groupMembers = group.getChildren(AgiAdmContainer.GET_CHILDREN_SORTED);
		while(users.hasMoreElements()) {
			AgiAdmUserReference userref = (AgiAdmUserReference)groupMembers.nextElement();
			// do something with the user reference
		}
 

GET_CHILDREN_NTDOMAINS_PRIMARY_ONLY

public static final int GET_CHILDREN_NTDOMAINS_PRIMARY_ONLY

A flag value to be used in the getChildren method. Tells the method to enumerate primary NT domains only.

See Also:

AgiAdmContainerBase.getChildren(int options)

Usage:

Should only be used when calling getChildren off AgiAdmDirectory whose type is AgiAdmDirectory.NT_SECURITY.

Example:

		AgiAdmDirectory ntSecurityDir = ... // get to NT Security
		Enumeration primaryDomains = ntSecurityDir.getChildren(
		AgiAdmContainer.GET_CHILDREN_NTDOMAINS_PRIMARY_ONLY);
		while(primaryDomains.hasMoreElements()) {
			AgiAdmDirectory dom = (AgiAdmDirectory)primaryDomains.nextElement();
			........
		}
 

GET_CHILDREN_NTDOMAINS_TRUSTED_ONLY

public static final int GET_CHILDREN_NTDOMAINS_TRUSTED_ONLY

A flag value to be used in the getChildren method. Tells the method to enumerate trusted NT domains only.

See Also:

AgiAdmContainerBase.getChildren(int options)

Usage:

Should only be used when calling getChildren off AgiAdmDirectory whose type is AgiAdmDirectory.NT_SECURITY.

Example:

		AgiAdmDirectory ntSecurityDir = ... // get to NT Security
		Enumeration primaryDomains = ntSecurityDir.getChildren(
		AgiAdmContainer.GET_CHILDREN_NTDOMAINS_TRUSTED_ONLY);
		while(primaryDomains.hasMoreElements()) {
			AgiAdmDirectory dom = (AgiAdmDirectory)primaryDomains.nextElement();
			........
		}
 

GET_CHILDREN_WITH_INFO

public static final int GET_CHILDREN_WITH_INFO

A flag value to be used in the getChildren method. Tells the method to enumerate users or groups with additional fields of information.

See Also:

AgiAdmContainerBase.getChildren(int options)

Usage:

Should only be used when calling getChildren off AgiAdmDirectory whose type is AgiAdmDirectory.SILVERUSERS, SILVERGROUPS, NTUSERS, or NTGROUPS.

Using this option may be slow, especially when enumerating large numbers of users or groups, especially within NT domains.

Example:

		AgiAdmDirectory silverUsersDir = ... // get to Silver Users
		Enumeration silverUsers = silverUsersDir.getChildren(AgiAdmContainer.GET_CHILDREN_WITH_INFO);
		while(silverUsers.hasMoreElements()) {
			AgiAdmUser silverUser = (AgiAdmUser)silverUsers.nextElement();
			// Get the user's description
			String description = silverUser.getProperty(AgiAdmElement.PROP_DESCRIPTION);
			// Get the user's full name
			String fullName = silverUser.getProperty(AgiAdmElement.PROP_FULL_NAME);
			// Determine whether the user is a locksmith
			Boolean isLocksmith = silverUser.getProperty(AgiAdmElement.PROP_IS_LOCKSMITH);
			// Get the user's fully qualified name
			String qualName = silverUser.getProperty(AgiAdmElement.PROP_QUAL_NAME);
			// do something with the retrieved information
		}

		AgiAdmDirectory ntGroupsDir = ... // get to NT groups in a domain
		Enumeration ntGroups = ntGroupsDir.getChildren(AgiAdmContainer.GET_CHILDREN_WITH_INFO);
		while(ntGroups.hasMoreElements()) {
			AgiAdmGroup ntGroup = (AgiAdmGroup)ntGroups.nextElement();
			// Get the group's description
			String description = ntGroup.getProperty(AgiAdmElement.PROP_DESCRIPTION);
			// Determine whether the group has the locksmith privilege
			Boolean isLocksmith = ntGroup.getProperty(AgiAdmElement.PROP_IS_LOCKSMITH);
			// Get the group's fully qualified name
			String qualName = ntGroup.getProperty(AgiAdmElement.PROP_QUAL_NAME);
			// do something with the retrieved information
		}
 

GET_CHILDREN_EX

public static final int GET_CHILDREN_EX

A flag value to be used in the getChildren method. Tells the method to return an extended (more full) list of child objects.

See Also:

AgiAdmContainerBase.getChildren(int options)

Usage:

This can only be used when calling getChildren off AgiAdmDatabase. When this flag is supplied, the getChildren method will add the list of servlet directories to the list of other children of AgiAdmDatabase.

Calling getChildren without this flag will return the list of the "well-known" directories only.