ViewPrincipal (Atlassian Crowd 4.0.0 API)

java.lang.Object
- com.opensymphony.xwork2.ActionSupport
- - com.atlassian.crowd.console.action.BaseAction
  - - com.atlassian.crowd.console.action.principal.ViewPrincipal

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

Direct Known Subclasses:

AddPrincipal, ResetPassword, UpdateAliases, UpdateAttributes, UpdateGroups, UpdatePrincipal
```
public class ViewPrincipal
extends BaseAction
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`active`
`protected AdminGroupChecker`	`adminGroupChecker`
`protected List<String>`	`aliases`
`protected AliasManager`	`aliasManager`
`protected Map<Long,Boolean>`	`applicationInError`
`protected List<Application>`	`applications`
`protected Directory`	`directory`
`protected long`	`directoryID`
`protected String`	`directoryName`
`protected String`	`displayname`
`protected String`	`email`
`protected String`	`externalId`
`protected String`	`firstname`
`protected String`	`humanReadableFailedGroups`
`protected String`	`lastname`
`protected String`	`name`
`protected String`	`newName`
`protected String`	`password`
`protected String`	`passwordConfirm`
`protected PermissionManager`	`permissionManager`
`protected boolean`	`preventingLockout`
`protected TokenAuthenticationManager`	`tokenAuthenticationManager`
`protected String`	`unremovedGroups`
`protected User`	`user`
`protected Map<String,Set<String>>`	`userAttributes`
`protected Long`	`userID`

Fields inherited from class com.atlassian.crowd.console.action.BaseAction
actionHelper, actionMessageAlertColor, ALERT_BLUE, ALERT_GREEN, ALERT_RED, ALERT_YELLOW, applicationManager, applicationService, clientProperties, crowdLicenseManager, directoryManager, initialLoad, propertyManager, rememberMeService, SMALL_AVATAR_SIZE, smallAvatarUrl, tab

Fields inherited from class com.opensymphony.xwork2.ActionSupport
container

Fields inherited from interface com.opensymphony.xwork2.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors
Constructor and Description

ViewPrincipal()

Constructors
Constructor and Description
`ViewPrincipal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doValidation()`
`String`	`execute()`
`AdminGroupChecker`	`getAdminGroupChecker()`
`List<String>`	`getAliases()`
`Map<Long,Boolean>`	`getApplicationInError()`
`List<Application>`	`getApplications()`
`Directory`	`getDirectory()`
`long`	`getDirectoryID()`
`String`	`getDirectoryImplementationDescriptiveName()`
`String`	`getDirectoryName()`
`String`	`getDisplayname()`
`String`	`getEmail()`
`String`	`getExternalId()`
`String`	`getFirstname()`
`Set`	`getGroups()`
`String`	`getHumanReadableFailedGroups()`
`String`	`getLastname()`
`String`	`getName()`
`String`	`getNewName()`
`String`	`getPassword()`
`String`	`getPasswordConfirm()`
`String`	`getUnremovedGroups()`
`Set`	`getUnsubscribedGroups()`
`User`	`getUser()`
`Map`	`getUserAttributes()`
`boolean`	`hasUpdateGroupPermission()`
`boolean`	`isActive()`
`boolean`	`isPreventingLockout()`
`protected void`	`processDirectoryMapping()`
`protected void`	`processGeneral()`
`protected Map<String,Set<String>>`	`readAttributes(UserWithAttributes userWithAttributes)`
`void`	`setActive(boolean active)`
`void`	`setAdminGroupChecker(AdminGroupChecker adminGroupChecker)`
`void`	`setAliasManager(AliasManager aliasManager)`
`void`	`setApplicationService(ApplicationService applicationService)`
`void`	`setCachedUserGroupResolver(CachedUserGroupResolver cachedUserGroupResolver)`
`void`	`setDirectoryID(long directoryID)`
`void`	`setDirectoryInstanceLoader(DirectoryInstanceLoader directoryInstanceLoader)`
`void`	`setDirectoryName(String directoryName)`
`void`	`setDisplayname(String displayname)`
`void`	`setEmail(String email)`
`void`	`setFirstname(String firstname)`
`void`	`setHumanReadableFailedGroups(String humanReadableFailedGroups)`
`void`	`setLastname(String lastname)`
`void`	`setName(String name)`
`void`	`setNewName(String newName)`
`void`	`setPassword(String password)`
`void`	`setPasswordConfirm(String passwordConfirm)`
`void`	`setPermissionManager(PermissionManager permissionManager)`
`void`	`setPreventingLockout(boolean preventingLockout)`
`void`	`setTokenAuthenticationManager(TokenAuthenticationManager tokenAuthenticationManager)`
`void`	`setUnremovedGroups(String unremovedGroups)`
`void`	`setUserID(Long userID)`
`protected void`	`syncFieldsFromPrincipal()` Copies data from `user` to the various fields (eg `name`).
`protected void`	`syncFieldsToPrincipal()` Copies data from class fields to the `user`

Methods inherited from class com.atlassian.crowd.console.action.BaseAction
addActionError, addActionMessage, applyFieldError, applyFieldErrors, authorisedToAccessCrowdAdminConsole, authorisedToAccessCrowdConsole, containsActionMessages, containsErrorMessages, directory, findAvatarUrl, getActionMessageAlertColor, getBootstrapManager, getCrowdApplication, getCurrentLicenseResourceTotal, getDisplayableLink, getHttpRequest, getImageLocation, getImageTitle, getLabel, getLicense, getLink, getLocaleProvider, getPasswordComplexityMessage, getRemoteUser, getSession, getSitemeshPageProperties, getSmallAvatarUrl, getTab, getText, getText, getTextProvider, getUserName, getWebFragmentsContextMap, getWebInterfaceManager, getWebItemsForSection, getWebResourceManager, getWebSectionsForLocation, getXsrfToken, getXsrfTokenName, isAtResourceLimit, isAuthenticated, isEvaluation, isGroupAdmin, isInitialLoad, isLicenseExpired, isRestartRequiredToEnableClustering, isSubscription, isSysAdmin, isWithinGracePeriod, renderFreemarkerTemplate, resolveAvatarUri, setActionHelper, setApplicationManager, setClientProperties, setClusterService, setCrowdApplication, setCrowdLicenseManager, setDirectoryManager, setPropertyManager, setRememberMeService, setTab, setWebInterfaceManager, setWebResourceManager, setXsrfTokenGenerator

Methods inherited from class com.opensymphony.xwork2.ActionSupport
addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tokenAuthenticationManager

protected TokenAuthenticationManager tokenAuthenticationManager

aliasManager
```
protected AliasManager aliasManager
```

permissionManager

protected PermissionManager permissionManager

adminGroupChecker

protected AdminGroupChecker adminGroupChecker

humanReadableFailedGroups

protected String humanReadableFailedGroups

user
```
protected User user
```

userAttributes

protected Map<String,Set<String>> userAttributes

directory
```
protected Directory directory
```

directoryID
```
protected long directoryID
```

directoryName
```
protected String directoryName
```

userID
```
protected Long userID
```

name
```
protected String name
```

newName
```
protected String newName
```

password
```
protected String password
```

passwordConfirm
```
protected String passwordConfirm
```

displayname
```
protected String displayname
```

firstname
```
protected String firstname
```

lastname
```
protected String lastname
```

email
```
protected String email
```

active
```
protected boolean active
```

externalId
```
protected String externalId
```

applications

protected List<Application> applications

aliases
```
protected List<String> aliases
```

applicationInError

protected Map<Long,Boolean> applicationInError

unremovedGroups
```
protected String unremovedGroups
```

preventingLockout
```
protected boolean preventingLockout
```

Constructor Detail
- ViewPrincipal
```
public ViewPrincipal()
```

Method Detail

execute
```
public String execute()
```
Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class BaseAction

hasUpdateGroupPermission

public boolean hasUpdateGroupPermission()

processGeneral
```
protected void processGeneral()
```

readAttributes

protected Map<String,Set<String>> readAttributes(UserWithAttributes userWithAttributes)

syncFieldsToPrincipal
```
protected void syncFieldsToPrincipal()
```
Copies data from class fields to the user

syncFieldsFromPrincipal
```
protected void syncFieldsFromPrincipal()
```
Copies data from user to the various fields (eg name).

processDirectoryMapping

protected void processDirectoryMapping()

getUser
```
public User getUser()
```

getDirectory
```
public Directory getDirectory()
```

getDirectoryID
```
public long getDirectoryID()
```

setDirectoryID

public void setDirectoryID(long directoryID)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

getPasswordConfirm
```
public String getPasswordConfirm()
```

setPasswordConfirm

public void setPasswordConfirm(String passwordConfirm)

getDisplayname
```
public String getDisplayname()
```

setDisplayname

public void setDisplayname(String displayname)

getFirstname
```
public String getFirstname()
```

setFirstname

public void setFirstname(String firstname)

getLastname
```
public String getLastname()
```

setLastname

public void setLastname(String lastname)

getEmail
```
public String getEmail()
```

setEmail
```
public void setEmail(String email)
```

isActive
```
public boolean isActive()
```

getExternalId
```
public String getExternalId()
```

setActive

public void setActive(boolean active)

getGroups
```
public Set getGroups()
```

getUnsubscribedGroups
```
public Set getUnsubscribedGroups()
```

getUserAttributes
```
public Map getUserAttributes()
```

getDirectoryName
```
public String getDirectoryName()
```

getApplications

public List<Application> getApplications()

getAliases
```
public List<String> getAliases()
```

setDirectoryName

public void setDirectoryName(String directoryName)

doValidation
```
protected void doValidation()
```

setApplicationService

public void setApplicationService(ApplicationService applicationService)

Overrides:: setApplicationService in class BaseAction

setAliasManager

public void setAliasManager(AliasManager aliasManager)

getApplicationInError

public Map<Long,Boolean> getApplicationInError()

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

setTokenAuthenticationManager

public void setTokenAuthenticationManager(TokenAuthenticationManager tokenAuthenticationManager)

Overrides:: setTokenAuthenticationManager in class BaseAction

getAdminGroupChecker

public AdminGroupChecker getAdminGroupChecker()

setAdminGroupChecker

public void setAdminGroupChecker(AdminGroupChecker adminGroupChecker)

setDirectoryInstanceLoader

public void setDirectoryInstanceLoader(DirectoryInstanceLoader directoryInstanceLoader)

isPreventingLockout
```
public boolean isPreventingLockout()
```

setPreventingLockout

public void setPreventingLockout(boolean preventingLockout)

getUnremovedGroups
```
public String getUnremovedGroups()
```

setUnremovedGroups

public void setUnremovedGroups(String unremovedGroups)

getNewName
```
public String getNewName()
```

setNewName

public void setNewName(String newName)

getDirectoryImplementationDescriptiveName

public String getDirectoryImplementationDescriptiveName()

setUserID
```
public void setUserID(Long userID)
```

setCachedUserGroupResolver

public void setCachedUserGroupResolver(CachedUserGroupResolver cachedUserGroupResolver)

getHumanReadableFailedGroups

public String getHumanReadableFailedGroups()

setHumanReadableFailedGroups

public void setHumanReadableFailedGroups(String humanReadableFailedGroups)

Class ViewPrincipal

Field Summary

Fields inherited from class com.atlassian.crowd.console.action.BaseAction

Fields inherited from class com.opensymphony.xwork2.ActionSupport

Fields inherited from interface com.opensymphony.xwork2.Action

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.crowd.console.action.BaseAction

Methods inherited from class com.opensymphony.xwork2.ActionSupport

Methods inherited from class java.lang.Object

Field Detail

tokenAuthenticationManager

aliasManager

permissionManager

adminGroupChecker

humanReadableFailedGroups

user

userAttributes

directory

directoryID

directoryName

userID

name

newName

password

passwordConfirm

displayname

firstname

lastname

email

active

externalId

applications

aliases

applicationInError

unremovedGroups

preventingLockout

Constructor Detail

ViewPrincipal

Method Detail

execute

hasUpdateGroupPermission

processGeneral

readAttributes

syncFieldsToPrincipal

syncFieldsFromPrincipal

processDirectoryMapping

getUser

getDirectory

getDirectoryID

setDirectoryID

getName

setName

getPassword

setPassword

getPasswordConfirm

setPasswordConfirm

getDisplayname

setDisplayname

getFirstname

setFirstname

getLastname

setLastname

getEmail

setEmail

isActive

getExternalId

setActive

getGroups

getUnsubscribedGroups

getUserAttributes

getDirectoryName

getApplications

getAliases

setDirectoryName

doValidation

setApplicationService

setAliasManager

getApplicationInError

setPermissionManager