|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.userdirectory.UserDirectoryTools atg.portal.admin.userdirectory.PortalUserDirectoryTools
public class PortalUserDirectoryTools
Provides specific Portal user directory methods. These methods include adding and removing users (guests, members, leaders) to communities. removing roles from a community.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
PortalUserDirectoryTools()
Constructs an instanceof PortalUserDirectoryTools |
Method Summary | |
---|---|
void |
addUserToCommunity(java.lang.String pProfileId,
java.lang.String pCommunityId,
java.lang.String pUserType)
Adds a user to the community with the specified membership level. |
void |
createCommunityRole(Community pCommunity,
java.lang.String pRoleName)
Creates a community-relative role. |
void |
createGearRole(Gear pGear,
java.lang.String pRoleName)
Creates a gear-relative role. |
void |
createRole(java.lang.String pRolePath)
Creates a role from a fully-qualified path name. |
java.util.Collection |
getOrganizationItems()
Deprecated. |
java.util.Collection |
getOrganizations()
Returns a Collection of all Organizations from the Portal Repository. |
java.util.Collection |
getOrganizations(int pStartIndex,
int pEndIndex)
Returns a Collection of Organizations from the Portal Repository. |
java.util.Collection |
getRoles()
Returns a Collection of all Roles from the Portal Repository. |
java.util.Collection |
getRoles(int pStartIndex,
int pEndIndex)
Returns a Collection of Roles from the Portal Repository. |
void |
removeRoleFolder(java.lang.String pName)
removeRoleFolder searches the user directory repository for the role with the name passed in. |
void |
removeRoleFromCommunity(java.lang.String pCommunityId,
java.lang.String pUserType)
removeRoleFromCommunity removes the role from the community. |
void |
removeUserFromCommunity(java.lang.String pProfileId,
java.lang.String pCommunityId,
java.lang.String pUserType)
Revokes a community membership level from a user. |
void |
setRoleDescription(java.lang.String pRolePath,
java.lang.String pValue)
Sets the "description" field of a role. |
void |
updateRoleFolderName(java.lang.String pOldName,
java.lang.String pNewName)
update all the roles which have name as pOldName to have a name of pNewName |
Methods inherited from class atg.userdirectory.UserDirectoryTools |
---|
addUserToOrganization, assignRolesToUser, assignRolesToUser, doStartService, getAllRolesForUser, getUserDirectory, removeAllRolesFromUser, removeRolesFromUser, removeRolesFromUser, removeUserFromOrganization, removeUserFromParentOrganization, setUserDirectory |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
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 PortalUserDirectoryTools()
Method Detail |
---|
public java.util.Collection getOrganizations(int pStartIndex, int pEndIndex)
java.lang.IllegalArgumentException
- endpoint indices out of order
(fromIndex > toIndex)public java.util.Collection getOrganizations()
public java.util.Collection getRoles(int pStartIndex, int pEndIndex)
public java.util.Collection getRoles()
public java.util.Collection getOrganizationItems()
public void addUserToCommunity(java.lang.String pProfileId, java.lang.String pCommunityId, java.lang.String pUserType)
public void removeUserFromCommunity(java.lang.String pProfileId, java.lang.String pCommunityId, java.lang.String pUserType)
public void removeRoleFromCommunity(java.lang.String pCommunityId, java.lang.String pUserType)
pCommunityId
- the community IdpUserType
- the type of user to remove (e.g. guest, member, leader)public void removeRoleFolder(java.lang.String pName) throws DirectoryModificationException
pName
- the name of the folder to delete
DirectoryModificationException
public void createCommunityRole(Community pCommunity, java.lang.String pRoleName) throws DirectoryModificationException
DirectoryModificationException
public void createGearRole(Gear pGear, java.lang.String pRoleName) throws DirectoryModificationException
DirectoryModificationException
public void createRole(java.lang.String pRolePath) throws DirectoryModificationException
DirectoryModificationException
public void setRoleDescription(java.lang.String pRolePath, java.lang.String pValue)
public void updateRoleFolderName(java.lang.String pOldName, java.lang.String pNewName) throws RepositoryException
RepositoryException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |