public class MultiUserUpdateFormHandler extends MultiProfileUpdateFormHandler
updateUser
and updates the users roles
and organizations using the values for the
roleIds
and organizationId
properties.
This is done directly using the UserDirectory API and not the
repository API, since there are differing cache mechanisms in
each instance.
This form handler also supports the setting of the
secondaryOrganizations property of an existing user.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
ROLE_UPDATE_APPEND |
static java.lang.String |
ROLE_UPDATE_REMOVE |
static java.lang.String |
ROLE_UPDATE_REPLACE |
static java.lang.String |
SECONDARY_ORGANIZATIONS_UPDATE_APPEND |
static java.lang.String |
SECONDARY_ORGANIZATIONS_UPDATE_REMOVE |
static java.lang.String |
SECONDARY_ORGANIZATIONS_UPDATE_REPLACE |
OLDPASSWORD_PARAM
CONFIRMPASSWORD_PARAM
STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
SERVICE_INFO_KEY
NULL_SENTINEL, REPOSITORY_ID_PROPERTY_NAME, UPDATE_APPEND, UPDATE_PREPEND, UPDATE_REMOVE, UPDATE_REPLACE
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
MultiUserUpdateFormHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getOrganizationId()
Gets the organizationId property
|
java.lang.String[] |
getRoleIds()
Gets the roleIds property
|
java.lang.String |
getRoleUpdateMethod()
Gets the roleUpdateMethod property
|
java.lang.String[] |
getSecondaryOrganizationIds()
Gets the SecondaryOrganizationIds property
|
java.lang.String |
getSecondaryOrganizationsUpdateMethod()
Gets the secondaryOrganizationsUpdateMethod property
|
UserDirectoryTools |
getUserDirectoryTools()
Gets the userDirectoryTools property
|
boolean |
handleClear(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Clears the
roleIds , organizationId
properties and roleUpdateMethod |
protected void |
preDeleteUser(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Removes the user from his/her organization in addition to
deleting them
|
void |
setOrganizationId(java.lang.String pOrganizationId)
Sets the organizationId property
|
void |
setRoleIds(java.lang.String[] pRoleIds)
Sets the roleIds property
|
void |
setRoleUpdateMethod(java.lang.String pRoleUpdateMethod)
Sets the roleUpdateMethod property
|
void |
setSecondaryOrganizationIds(java.lang.String[] pSecondaryOrganizationIds)
Sets the SecondaryOrganizationIds property
|
void |
setSecondaryOrganizationsUpdateMethod(java.lang.String pSecondaryOrganizationsUpdateMethod)
Sets the secondaryOrganizationsUpdateMethod property
|
void |
setUserDirectoryTools(UserDirectoryTools pUserDirectoryTools)
Sets the userDirectoryTools property
|
protected void |
updateUser(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Overrides updateUser to assign a user roles and/or add
a user to an organization based on the values of the
roleIds and organizationId
properties |
addProfileUpdateListener, getClearValuesOnDelete, getClearValuesOnUpdate, getProfileUpdateEvent, getProfileUpdateTrigger, getRepositoryIds, handleCancel, handleDelete, handleUpdate, isGenerateProfileUpdateEvents, postCancel, postClear, postDelete, postDeleteUser, postUpdate, postUpdateUser, preCancel, preClear, preDelete, preUpdate, preUpdateUser, removeProfileUpdateListener, sendProfileUpdateEvent, setClearValuesOnDelete, setClearValuesOnUpdate, setGenerateProfileUpdateEvents, setProfileUpdateEvent, setProfileUpdateTrigger, setRepositoryIds, validateOrganizationAccess
afterSet, beforeSet, confirmPasswordValue, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, getProfile, getProfileTools, getTransactionManager, getUserLocale, getValueProperty, isConfirmOldPassword, isConfirmPassword, setConfirmOldPassword, setConfirmPassword, setProfile, setProfileTools, setTransactionManager, updatePasswordValue
checkFormError, checkFormSuccess, checkForRequiredProperties, deleteItem, getCheckForReadOnlyProperties, getCheckForRequiredProperties, getContentItemDescriptor, getContentNameProperty, getContentPathProperty, getCreateErrorURL, getCreateSuccessURL, getDeleteErrorURL, getDeleteSuccessURL, getEditMapsAsLists, getErrorHandler, getExtractDefaultValuesFromItem, getFolderIdProperty, getItemDescriptor, getItemDescriptorName, getItemProperty, getLogger, getMapKeyValueSeparator, getRemoveReferencesToDeletedItems, getRepository, getRepositoryId, getRepositoryItem, getRepositoryItemEditor, getRepositoryPathName, getRequireIdOnCreate, getSpecifiedIdPropertyValue, getTransactionDemarcation, getTrimProperties, getUpdateErrorURL, getUpdateSuccessURL, getValue, getValueProperty, handleCreate, isClearValueOnSet, isCreateTransientItems, isRequireMapKeys, isSortRepositoryItemSets, isTrimProperty, isUpdateItemsInCollection, postCreateItem, postDeleteItem, postUpdateItem, postUpdateItemProperties, preCreateItem, preDeleteItem, preUpdateItem, setCheckForReadOnlyProperties, setCheckForRequiredProperties, setClearValueOnSet, setContentNameProperty, setContentPathProperty, setCreateErrorURL, setCreateSuccessURL, setCreateTransientItems, setDeleteErrorURL, setDeleteSuccessURL, setEditMapsAsLists, setExtractDefaultValuesFromItem, setFolderIdProperty, setItemDescriptorName, setMapKeyValueSeparator, setRemoveReferencesToDeletedItems, setRepository, setRepositoryId, setRepositoryItemEditor, setRepositoryPathName, setRequireIdOnCreate, setRequireMapKeys, setSortRepositoryItemSets, setTrimProperties, setUpdateErrorURL, setUpdateItemsInCollection, setUpdateSuccessURL, setValueProperty, testPropertyAttribute, updateChildItemProperty, updateContentItemValues, updateItem, updateItemProperties, updateListProperty, updateMapProperty
addFormException, addUncheckedFormException, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards
afterGet, beforeGet
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String ROLE_UPDATE_REPLACE
public static final java.lang.String ROLE_UPDATE_REMOVE
public static final java.lang.String ROLE_UPDATE_APPEND
public static final java.lang.String SECONDARY_ORGANIZATIONS_UPDATE_REPLACE
public static final java.lang.String SECONDARY_ORGANIZATIONS_UPDATE_REMOVE
public static final java.lang.String SECONDARY_ORGANIZATIONS_UPDATE_APPEND
public void setRoleIds(java.lang.String[] pRoleIds)
pRoleIds
- the ids of the roles to assign
each userpublic java.lang.String[] getRoleIds()
public void setOrganizationId(java.lang.String pOrganizationId)
pOrganizationId
- the id of the organization
to add the user topublic java.lang.String getOrganizationId()
public void setRoleUpdateMethod(java.lang.String pRoleUpdateMethod)
pRoleUpdateMethod
- the method used to update
the roles for each user. Possible values include:
roleIds
to the user's existing roles
roleIds
from the user's existing roles
roleIds
property
to the userpublic java.lang.String getRoleUpdateMethod()
roleIds
to the user's existing roles
roleIds
from the user's existing roles
roleIds
property
to the userpublic void setUserDirectoryTools(UserDirectoryTools pUserDirectoryTools)
pUserDirectoryTools
- a collection of tools that work
on userdirectory itemspublic UserDirectoryTools getUserDirectoryTools()
public void setSecondaryOrganizationIds(java.lang.String[] pSecondaryOrganizationIds)
pSecondaryOrganizationIds
- an array of Secondary Organization Ids that are to be assigned to userpublic java.lang.String[] getSecondaryOrganizationIds()
public void setSecondaryOrganizationsUpdateMethod(java.lang.String pSecondaryOrganizationsUpdateMethod)
pSecondaryOrganizationsUpdateMethod
- the method used to update the secondary organizations for each
user. Possible values include:
secondaryOrganizationIds
to the user's existing
secondary organizations
secondaryOrganizationIds
from the user's existing
secondary organizations
secondaryOrganizationIds
property to the userpublic java.lang.String getSecondaryOrganizationsUpdateMethod()
secondaryOrganizationIds
to the user's existing secondary organizations
secondaryOrganizationIds
from the user's existing secondary organizations
secondaryOrganizationIds
property to the userprotected void updateUser(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
roleIds
and organizationId
propertiesupdateUser
in class MultiProfileUpdateFormHandler
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if a servlet error occursjava.io.IOException
- if a servlet IO problem occursprotected void preDeleteUser(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
preDeleteUser
in class MultiProfileUpdateFormHandler
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if a servlet error occursjava.io.IOException
- if an io problem occurspublic boolean handleClear(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
roleIds
, organizationId
properties and roleUpdateMethod
handleClear
in class MultiProfileUpdateFormHandler
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if a servlet error occursjava.io.IOException
- if a servlet io exception occurs