org.alfresco.web.bean.users

Class CreateUserWizard

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.wizard.BaseWizardBean

org.alfresco.web.bean.users.CreateUserWizard

All Implemented Interfaces:

Serializable, IDialogBean, IWizardBean

Direct Known Subclasses:

EditUserWizard

public class CreateUserWizard
extends BaseWizardBean

Author:

Kevin Roast

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	companyId
protected String	confirm
protected String	email
protected static String	ERROR
protected static String	ERROR_DOMAIN_MISMATCH
protected String	firstName form variables
protected org.alfresco.service.cmr.repository.NodeRef	homeSpaceLocation
protected String	homeSpaceName
protected String	jobtitle
protected String	lastName
protected String	location
protected String	organisation
protected String	password
protected String	presenceProvider
protected String	presenceUsername
protected static String	QUOTA_UNITS_GB
protected static String	QUOTA_UNITS_KB
protected static String	QUOTA_UNITS_MB
protected Long	sizeQuota
protected String	sizeQuotaUnits
protected String	userName

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
CreateUserWizard()

Method Summary

Modifier and Type	Method and Description
boolean	checkTenantUserName()
protected org.alfresco.util.Pair<Long,String>	convertFromBytes(long size)
protected long	convertToBytes(long size, String units)
protected org.alfresco.service.cmr.repository.NodeRef	createHomeSpace(String locationId, String spaceName, org.alfresco.service.cmr.repository.NodeRef oldHomeFolderRef, boolean error) Create the specified home space if it does not exist, and return the ID
protected String	finishImpl(FacesContext context, String outcome) Performs the actual processing for the wizard.
protected org.alfresco.service.cmr.repository.NodeRef	getCompanyHomeSpace() Helper to return the company home space
String	getCompanyId()
String	getConfirm()
protected org.alfresco.service.cmr.repository.NodeRef	getDefaultHomeSpace()
String	getEmail()
boolean	getFinishButtonDisabled() Determines whether the finish button on the dialog should be disabled
String	getFirstName()
org.alfresco.service.cmr.repository.NodeRef	getHomeSpaceLocation()
String	getHomeSpaceName()
String	getJobtitle()
String	getLastName()
String	getLocation()
String	getOrganization()
String	getPassword()
Map	getPersonPropertiesImmutability()
String	getPresenceProvider()
String	getPresenceUsername()
Long	getSizeQuota()
String	getSizeQuotaUnits()
String	getSummary()
String	getUserName()
void	init(Map<String,String> params) Initialises the wizard
protected void	putSizeQuotaProperty(String userName, Long quota, String quotaUnits)
void	setAuthenticationService(MutableAuthenticationService authenticationService)
void	setCompanyId(String companyId)
void	setConfirm(String confirm)
void	setContentUsageService(ContentUsageService contentUsageService)
void	setEmail(String email)
void	setFirstName(String firstName)
void	setHomeSpaceLocation(org.alfresco.service.cmr.repository.NodeRef homeSpaceLocation)
void	setHomeSpaceName(String homeSpaceName)
void	setJobtitle(String jobtitle)
void	setLastName(String lastName)
void	setLocation(String location)
void	setOrganization(String organisation)
void	setOwnableService(OwnableService ownableService)
void	setPassword(String password)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
protected void	setPersonPropertiesAndCreateHomeSpaceIfNeeded(Map<org.alfresco.service.namespace.QName,Serializable> props, org.alfresco.service.cmr.repository.NodeRef oldHomeFolderRef, FacesContext context)
void	setPersonService(PersonService personService)
void	setPresenceProvider(String presenceProvider)
void	setPresenceUsername(String presenceUsername)
void	setSizeQuota(Long sizeQuota)
void	setSizeQuotaUnits(String sizeQuotaUnits)
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
void	setupUsers(ActionEvent event) Init the users screen
void	setUserName(String userName)
void	validateEmail(FacesContext context, UIComponent component, Object value) Validate Email field data is acceptable
void	validatePassword(FacesContext context, UIComponent component, Object value) Deprecated. Method is never used
void	validateUsername(FacesContext context, UIComponent component, Object value) Validate Username field data is acceptable

Methods inherited from class org.alfresco.web.bean.wizard.BaseWizardBean

back, buildSummary, getBackButtonLabel, getDefaultCancelOutcome, getDefaultFinishOutcome, getFinishButtonLabel, getNextButtonDisabled, getNextButtonLabel, getStepDescription, getStepTitle, next

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

cancel, doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getContainerTitle, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, isFinished, restored, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.alfresco.web.bean.dialog.IDialogBean

cancel, finish, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getContainerDescription, getContainerSubTitle, getContainerTitle, getMoreActionsConfigId, isFinished, restored

Field Detail

ERROR

protected static final String ERROR

See Also:

Constant Field Values

ERROR_DOMAIN_MISMATCH

protected static final String ERROR_DOMAIN_MISMATCH

See Also:

Constant Field Values

QUOTA_UNITS_KB

protected static final String QUOTA_UNITS_KB

See Also:

Constant Field Values

QUOTA_UNITS_MB

protected static final String QUOTA_UNITS_MB

See Also:

Constant Field Values

QUOTA_UNITS_GB

protected static final String QUOTA_UNITS_GB

See Also:

Constant Field Values

firstName

protected String firstName

form variables

lastName

protected String lastName

userName

protected String userName

password

protected String password

confirm

protected String confirm

email

protected String email

companyId

protected String companyId

homeSpaceName

protected String homeSpaceName

homeSpaceLocation

protected org.alfresco.service.cmr.repository.NodeRef homeSpaceLocation

presenceProvider

protected String presenceProvider

presenceUsername

protected String presenceUsername

organisation

protected String organisation

jobtitle

protected String jobtitle

location

protected String location

sizeQuota

protected Long sizeQuota

sizeQuotaUnits

protected String sizeQuotaUnits

Constructor Detail

CreateUserWizard

public CreateUserWizard()

Method Detail

setAuthenticationService

public void setAuthenticationService(MutableAuthenticationService authenticationService)

Parameters:

authenticationService - The AuthenticationService to set.

setPersonService

public void setPersonService(PersonService personService)

Parameters:

personService - The person service.

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

Parameters:

tenantService - The tenantService to set.

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

Parameters:

permissionService - The PermissionService to set.

setOwnableService

public void setOwnableService(OwnableService ownableService)

Parameters:

ownableService - The ownableService to set.

setContentUsageService

public void setContentUsageService(ContentUsageService contentUsageService)

Parameters:

contentUsageService - The contentUsageService to set.

init

public void init(Map<String,String> params)

Initialises the wizard

Specified by:

init in interface IDialogBean

Overrides:

init in class BaseDialogBean

Parameters:

params - Map of parameters for the dialog

getSummary

public String getSummary()

Returns:

Returns the summary data for the wizard.

setupUsers

public void setupUsers(ActionEvent event)

Init the users screen

getCompanyId

public String getCompanyId()

Returns:

Returns the companyId.

setCompanyId

public void setCompanyId(String companyId)

Parameters:

companyId - The companyId to set.

getPresenceProvider

public String getPresenceProvider()

Returns:

Returns the presenceProvider.

setPresenceProvider

public void setPresenceProvider(String presenceProvider)

Parameters:

presenceProvider - The presenceProvider to set.

getPresenceUsername

public String getPresenceUsername()

Returns:

Returns the presenceUsername.

setPresenceUsername

public void setPresenceUsername(String presenceUsername)

Parameters:

presenceUsername - The presenceUsername to set.

getEmail

public String getEmail()

Returns:

Returns the email.

setEmail

public void setEmail(String email)

Parameters:

email - The email to set.

getFirstName

public String getFirstName()

Returns:

Returns the firstName.

setFirstName

public void setFirstName(String firstName)

Parameters:

firstName - The firstName to set.

getHomeSpaceLocation

public org.alfresco.service.cmr.repository.NodeRef getHomeSpaceLocation()

Returns:

Returns the homeSpaceLocation.

setHomeSpaceLocation

public void setHomeSpaceLocation(org.alfresco.service.cmr.repository.NodeRef homeSpaceLocation)

Parameters:

homeSpaceLocation - The homeSpaceLocation to set.

getHomeSpaceName

public String getHomeSpaceName()

Returns:

Returns the homeSpaceName.

setHomeSpaceName

public void setHomeSpaceName(String homeSpaceName)

Parameters:

homeSpaceName - The homeSpaceName to set.

getLastName

public String getLastName()

Returns:

Returns the lastName.

setLastName

public void setLastName(String lastName)

Parameters:

lastName - The lastName to set.

getUserName

public String getUserName()

Returns:

Returns the userName.

setUserName

public void setUserName(String userName)

Parameters:

userName - The userName to set.

getPassword

public String getPassword()

Returns:

Returns the password.

setPassword

public void setPassword(String password)

Parameters:

password - The password to set.

getConfirm

public String getConfirm()

Returns:

Returns the confirm password.

setConfirm

public void setConfirm(String confirm)

Parameters:

confirm - The confirm password to set.

getJobtitle

public String getJobtitle()

Returns:

the jobtitle

setJobtitle

public void setJobtitle(String jobtitle)

Parameters:

jobtitle - the jobtitle to set

getLocation

public String getLocation()

Returns:

the location

setLocation

public void setLocation(String location)

Parameters:

location - the location to set

getOrganization

public String getOrganization()

Returns:

the organisation

setOrganization

public void setOrganization(String organisation)

Parameters:

organisation - the organisation to set

getSizeQuota

public Long getSizeQuota()

setSizeQuota

public void setSizeQuota(Long sizeQuota)

getSizeQuotaUnits

public String getSizeQuotaUnits()

setSizeQuotaUnits

public void setSizeQuotaUnits(String sizeQuotaUnits)

validatePassword

public void validatePassword(FacesContext context,
                             UIComponent component,
                             Object value)
                      throws ValidatorException

Deprecated. Method is never used

Validate password field data is acceptable

Throws:

ValidatorException

validateUsername

public void validateUsername(FacesContext context,
                             UIComponent component,
                             Object value)
                      throws ValidatorException

Validate Username field data is acceptable

Throws:

ValidatorException

validateEmail

public void validateEmail(FacesContext context,
                          UIComponent component,
                          Object value)
                   throws ValidatorException

Validate Email field data is acceptable

Parameters:

context - FacesContext

component - UIComponent

value - Object

Throws:

ValidatorException

getCompanyHomeSpace

protected org.alfresco.service.cmr.repository.NodeRef getCompanyHomeSpace()

Helper to return the company home space

Returns:

company home space NodeRef

getDefaultHomeSpace

protected org.alfresco.service.cmr.repository.NodeRef getDefaultHomeSpace()

createHomeSpace

protected org.alfresco.service.cmr.repository.NodeRef createHomeSpace(String locationId,
                                                                      String spaceName,
                                                                      org.alfresco.service.cmr.repository.NodeRef oldHomeFolderRef,
                                                                      boolean error)

Create the specified home space if it does not exist, and return the ID

Parameters:

locationId - Parent location

spaceName - Home space to create, can be null to simply return the parent

oldHomeFolderRef - the previous home space, for the case where the the user is being updated. It may not have changed.

error - True to throw an error if the space already exists, else ignore and return

Returns:

ID of the home space

finishImpl

protected String finishImpl(FacesContext context,
                            String outcome)
                     throws Throwable

Description copied from class: BaseDialogBean

Performs the actual processing for the wizard. NOTE: This method is called within the context of a transaction so no transaction handling is required

Specified by:

finishImpl in class BaseDialogBean

Parameters:

context - FacesContext

outcome - The default outcome

Returns:

The outcome

Throws:

Throwable

setPersonPropertiesAndCreateHomeSpaceIfNeeded

protected void setPersonPropertiesAndCreateHomeSpaceIfNeeded(Map<org.alfresco.service.namespace.QName,Serializable> props,
                                                             org.alfresco.service.cmr.repository.NodeRef oldHomeFolderRef,
                                                             FacesContext context)

getFinishButtonDisabled

public boolean getFinishButtonDisabled()

Description copied from interface: IDialogBean

Determines whether the finish button on the dialog should be disabled

Specified by:

getFinishButtonDisabled in interface IDialogBean

Overrides:

getFinishButtonDisabled in class BaseDialogBean

Returns:

true if the button should be disabled

putSizeQuotaProperty

protected void putSizeQuotaProperty(String userName,
                                    Long quota,
                                    String quotaUnits)

convertToBytes

protected long convertToBytes(long size,
                              String units)

convertFromBytes

protected org.alfresco.util.Pair<Long,String> convertFromBytes(long size)

checkTenantUserName

public boolean checkTenantUserName()

getPersonPropertiesImmutability

public Map getPersonPropertiesImmutability()