atg.userprofiling
Class MultiUserAddFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.repository.servlet.RepositoryFormHandler
                      atg.userprofiling.MultiProfileForm
                          atg.userprofiling.MultiProfileAddFormHandler
                              atg.userprofiling.MultiUserAddFormHandler

All Implemented Interfaces:

DropletFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, RepositoryFormConstants, RepositoryFormData, java.util.EventListener

public class MultiUserAddFormHandler
extends MultiProfileAddFormHandler

This FormHandler will take care of setting user directory properties for new users. It does so via the roleIds and organizationId form properties. These properties are strongly typed, as opposed to the use of the value dictionary.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.userprofiling.MultiProfileForm

CONFIRMPASSWORD_PARAM, OLDPASSWORD_PARAM

Fields inherited from class atg.repository.servlet.RepositoryFormHandler

STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.repository.servlet.RepositoryFormConstants

NULL_SENTINEL, REPOSITORY_ID_PROPERTY_NAME, UPDATE_APPEND, UPDATE_PREPEND, UPDATE_REMOVE, UPDATE_REPLACE

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

MultiUserAddFormHandler()

Method Summary

void	createUser(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) After creating the user, assign the roles and organizations set in this form handler.
java.lang.String	getOrganizationId() Gets the organizationId property
java.lang.String[]	getRoleIds() Gets the roleIds property
UserDirectoryTools	getUserDirectoryTools()
boolean	handleClear(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Clears the values of roleIds and organizationId
void	setOrganizationId(java.lang.String pOrganizationId) Sets the organizationId property
void	setRoleIds(java.lang.String[] pRoleIds) Sets the roleIds property
void	setUserDirectoryTools(UserDirectoryTools pUserDirectoryTools)

Methods inherited from class atg.userprofiling.MultiProfileAddFormHandler

addFormException, beforeSet, createUserListItemObject, getClearValuesOnCreate, getCommonFormError, getCommonFormExceptions, getCount, getCurrentUser, getDefaultPassword, getItemDescriptorName, getMaxCount, getMinCount, getUserListItemClass, getUsers, handleCancel, handleCreate, initUsers, isGeneratePassword, isGenerateRegisterEvents, mergeValueDictionaries, postCreate, postCreateUser, preCreate, preCreateUser, resetFormExceptions, setClearValuesOnCreate, setCount, setCurrentUser, setDefaultPassword, setGeneratePassword, setGenerateRegisterEvents, setItemDescriptorName, setMaxCount, setMinCount, setUserListItemClass, setUsers, userAlreadyExists

Methods inherited from class atg.userprofiling.MultiProfileForm

afterSet, confirmPasswordValue, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, getProfile, getProfileTools, getTransactionManager, getUserLocale, getValueProperty, isConfirmOldPassword, isConfirmPassword, setConfirmOldPassword, setConfirmPassword, setProfile, setProfileTools, setTransactionManager, updatePasswordValue

Methods inherited from class atg.repository.servlet.RepositoryFormHandler

checkFormError, checkFormSuccess, checkForRequiredProperties, deleteItem, getCheckForReadOnlyProperties, getCheckForRequiredProperties, getContentItemDescriptor, getContentNameProperty, getContentPathProperty, getCreateErrorURL, getCreateSuccessURL, getDeleteErrorURL, getDeleteSuccessURL, getEditMapsAsLists, getErrorHandler, getExtractDefaultValuesFromItem, getFolderIdProperty, getItemDescriptor, getItemProperty, getLogger, getMapKeyValueSeparator, getRemoveReferencesToDeletedItems, getRepository, getRepositoryId, getRepositoryItem, getRepositoryItemEditor, getRepositoryPathName, getRequireIdOnCreate, getSpecifiedIdPropertyValue, getTransactionDemarcation, getTrimProperties, getUpdateErrorURL, getUpdateSuccessURL, getValue, getValueProperty, handleDelete, handleUpdate, 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, setMapKeyValueSeparator, setRemoveReferencesToDeletedItems, setRepository, setRepositoryId, setRepositoryItemEditor, setRepositoryPathName, setRequireIdOnCreate, setRequireMapKeys, setSortRepositoryItemSets, setTrimProperties, setUpdateErrorURL, setUpdateItemsInCollection, setUpdateSuccessURL, setValueProperty, testPropertyAttribute, updateChildItemProperty, updateContentItemValues, updateItem, updateItemProperties, updateListProperty, updateMapProperty

Methods inherited from class atg.droplet.GenericFormHandler

addUncheckedFormException, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

MultiUserAddFormHandler

public MultiUserAddFormHandler()

Method Detail

setRoleIds

public void setRoleIds(java.lang.String[] pRoleIds)

Sets the roleIds property

Parameters:

pRoleIds - a list of role ids the user should be assigned to

getRoleIds

public java.lang.String[] getRoleIds()

Gets the roleIds property

Returns:

a list of role ids the user should be assigned to

setOrganizationId

public void setOrganizationId(java.lang.String pOrganizationId)

Sets the organizationId property

Parameters:

pOrganizationId - the id of the organization that the user should be assigned to

getOrganizationId

public java.lang.String getOrganizationId()

Gets the organizationId property

Returns:

the id of the organization that the user should be assigned to

setUserDirectoryTools

public void setUserDirectoryTools(UserDirectoryTools pUserDirectoryTools)

getUserDirectoryTools

public UserDirectoryTools getUserDirectoryTools()

createUser

public void createUser(DynamoHttpServletRequest pRequest,
                       DynamoHttpServletResponse pResponse)
                throws javax.servlet.ServletException,
                       java.io.IOException

After creating the user, assign the roles and organizations set in this form handler. For organizations, we set the user-defined org instead of the common org if one is defined For roles, we assign both common ids and user-defined ids

Overrides:

createUser in class MultiProfileAddFormHandler

Parameters:

pRequest - the request of the submitted form

pResponse - the response associated with the request

Throws:

javax.servlet.ServletException - if a servlet error occurs

java.io.IOException - if an io problem occurs

handleClear

public boolean handleClear(DynamoHttpServletRequest pRequest,
                           DynamoHttpServletResponse pResponse)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Clears the values of roleIds and organizationId

Overrides:

handleClear in class MultiProfileAddFormHandler

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if a servlet error occurs

java.io.IOException - if a servlet io error occurs