com.atlassian.crowd.console.action

Class BaseAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.crowd.console.action.BaseAction

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:

AbstractBrowser, AbstractViewDirectory, AddGroup, Administer, ApplicationBaseAction, BaseProgressStepAction, BaseSetupAction, BaseUserAction, BrowseAuditLog, BrowseDirectories, BrowseWithDirectoryId, ChangeExpiredPassword, Console, CreateDirectory, DefaultStartPage, EnableClustering, ErrorAction, GroupAction, GroupLevelAdminGroupsAction, License, Panel, RemoveDirectory, RemoveGroup, RemovePrincipal, Restore, SAMLAuthAction, SystemInfo, TestkitStrutsInfoAction, UpdateConnectionPool, UpdateConnectorConfiguration, UpdateCustomAttributes, UpdateGeneral, UpdateInternalConfiguration, UpdateLicensing, UpdateLoggingProfiling, UpdateMailServer, UpdateMailTemplate, UpdateOptions, UpdatePermissions, UpdateRemoteCrowdConnection, UpdateSAMLConfiguration, UpdateSessionConfig, UpdateTrustedProxies, ViewPicker, ViewPrincipal, ViewTrustedProxies

public class BaseAction
extends com.opensymphony.xwork2.ActionSupport

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionHelper	actionHelper
protected String	actionMessageAlertColor Webwork action messages color settings.
static String	ALERT_BLUE
static String	ALERT_GREEN
static String	ALERT_RED
static String	ALERT_YELLOW
protected ApplicationManager	applicationManager
protected ApplicationService	applicationService
protected ClientProperties	clientProperties
protected ClusterService	clusterService
protected CrowdLicenseManager	crowdLicenseManager
protected DirectoryManager	directoryManager
protected boolean	initialLoad
protected static org.slf4j.Logger	logger
protected PropertyManager	propertyManager
protected CrowdRememberMeService	rememberMeService
protected static int	SMALL_AVATAR_SIZE
protected Optional<String>	smallAvatarUrl
protected Integer	tab
protected TokenAuthenticationManager	tokenAuthenticationManager

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
BaseAction()

Method Summary

Modifier and Type	Method and Description
protected void	addActionError(Throwable t)
void	addActionMessage(String color, String message) Sets a UI message and the color type for the user.
void	applyFieldError(ValidationError error)
void	applyFieldErrors(Collection<FieldError> errors)
boolean	authorisedToAccessCrowdAdminConsole(DirectoryMapping directoryMapping, Long directoryId, String username)
protected boolean	authorisedToAccessCrowdConsole(Long directoryId, String name)
protected void	bindInformationAboutLicense()
boolean	containsActionMessages()
boolean	containsErrorMessages()
Directory	directory(long directoryID)
String	execute()
protected Optional<String>	findAvatarUrl(User user, int sizeHint)
String	getActionMessageAlertColor() Gets the action message color dressing to use with the decorator.
protected CrowdBootstrapManager	getBootstrapManager()
protected Application	getCrowdApplication()
Integer	getCurrentLicenseResourceTotal()
String	getDisplayableLink(com.atlassian.plugin.web.model.WebLink link)
protected javax.servlet.http.HttpServletRequest	getHttpRequest()
String	getImageLocation(boolean active, ApplicationType applicationType)
String	getImageTitle(boolean active, ApplicationType applicationType)
String	getLabel(com.atlassian.plugin.web.model.WebLabel label)
com.atlassian.extras.api.crowd.CrowdLicense	getLicense()
String	getLink(com.atlassian.plugin.web.model.WebLink link)
protected com.opensymphony.xwork2.LocaleProvider	getLocaleProvider()
protected String	getPasswordComplexityMessage(long directoryId)
User	getRemoteUser()
protected javax.servlet.http.HttpSession	getSession()
Map<String,String>	getSitemeshPageProperties()
String	getSmallAvatarUrl()
Integer	getTab()
String	getText(String i18nKey, List args)
String	getText(String i18nKey, List args, boolean encode)
protected com.opensymphony.xwork2.TextProvider	getTextProvider()
String	getUserName()
Map<String,Object>	getWebFragmentsContextMap()
com.atlassian.plugin.web.WebInterfaceManager	getWebInterfaceManager()
List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getWebItemsForSection(String sectionName)
com.atlassian.plugin.webresource.WebResourceManager	getWebResourceManager()
List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getWebSectionsForLocation(String location)
String	getXsrfToken()
String	getXsrfTokenName()
boolean	isAtResourceLimit()
boolean	isAuthenticated()
boolean	isEvaluation()
boolean	isGroupAdmin()
boolean	isInitialLoad()
boolean	isLicenseExpired()
boolean	isLicenseForged()
boolean	isRestartRequiredToEnableClustering()
boolean	isSubscription()
boolean	isSysAdmin()
boolean	isWithinGracePeriod()
String	renderFreemarkerTemplate(String templateString)
protected String	resolveAvatarUri(URI uri) Resolve a URI against a base of Crowd's context path to get a suitable URI for placing into a page.
void	setActionHelper(ActionHelper actionHelper)
void	setApplicationManager(ApplicationManager applicationManager)
void	setApplicationService(ApplicationService applicationService)
void	setClientProperties(ClientProperties clientProperties)
void	setClusterService(ClusterService clusterService)
void	setCrowdApplication(Application crowdApplication)
void	setCrowdLicenseManager(CrowdLicenseManager crowdLicenseManager)
void	setDirectoryManager(DirectoryManager directoryManager)
void	setPropertyManager(PropertyManager propertyManager)
void	setRememberMeService(CrowdRememberMeService rememberMeService)
void	setTab(Integer tab)
void	setTokenAuthenticationManager(TokenAuthenticationManager tokenAuthenticationManager)
void	setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)
void	setWebResourceManager(com.atlassian.plugin.webresource.WebResourceManager webResourceManager)
void	setXsrfTokenGenerator(XsrfTokenGenerator xsrfTokenGenerator)

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

logger

protected static final org.slf4j.Logger logger

tab

protected Integer tab

initialLoad

protected boolean initialLoad

actionMessageAlertColor

protected String actionMessageAlertColor

Webwork action messages color settings. Displays the type of message dressing to use.

ALERT_GREEN

public static final String ALERT_GREEN

See Also:

actionMessageAlertColor, Constant Field Values

ALERT_YELLOW

public static final String ALERT_YELLOW

See Also:

actionMessageAlertColor, Constant Field Values

ALERT_RED

public static final String ALERT_RED

See Also:

actionMessageAlertColor, Constant Field Values

ALERT_BLUE

public static final String ALERT_BLUE

See Also:

actionMessageAlertColor, Constant Field Values

SMALL_AVATAR_SIZE

protected static final int SMALL_AVATAR_SIZE

See Also:

Constant Field Values

propertyManager

protected PropertyManager propertyManager

directoryManager

protected DirectoryManager directoryManager

applicationManager

protected ApplicationManager applicationManager

crowdLicenseManager

protected CrowdLicenseManager crowdLicenseManager

applicationService

protected ApplicationService applicationService

tokenAuthenticationManager

protected TokenAuthenticationManager tokenAuthenticationManager

rememberMeService

protected CrowdRememberMeService rememberMeService

clientProperties

protected ClientProperties clientProperties

actionHelper

protected ActionHelper actionHelper

clusterService

protected ClusterService clusterService

smallAvatarUrl

protected Optional<String> smallAvatarUrl

Constructor Detail

BaseAction

public BaseAction()

Method Detail

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

applyFieldError

public void applyFieldError(ValidationError error)

isAuthenticated

public boolean isAuthenticated()

isSysAdmin

public boolean isSysAdmin()

isGroupAdmin

public boolean isGroupAdmin()

getSitemeshPageProperties

public Map<String,String> getSitemeshPageProperties()

getUserName

public String getUserName()
                   throws InvalidUserException

Returns:

username of the current logged in user, or null if the user is not authenticated

Throws:

InvalidUserException

getRemoteUser

public User getRemoteUser()

getSession

protected javax.servlet.http.HttpSession getSession()

getHttpRequest

protected javax.servlet.http.HttpServletRequest getHttpRequest()

getTab

public Integer getTab()

setTab

public void setTab(Integer tab)

isInitialLoad

public boolean isInitialLoad()

getLicense

public com.atlassian.extras.api.crowd.CrowdLicense getLicense()

isEvaluation

public boolean isEvaluation()

isLicenseForged

public boolean isLicenseForged()

isRestartRequiredToEnableClustering

public boolean isRestartRequiredToEnableClustering()

isSubscription

public boolean isSubscription()

Returns:

true if the license is a subscription license, false otherwise.

isWithinGracePeriod

public boolean isWithinGracePeriod()

Returns:

true if the license

isLicenseExpired

public boolean isLicenseExpired()

getActionMessageAlertColor

public String getActionMessageAlertColor()

Gets the action message color dressing to use with the decorator.

Returns:

The window dressing color to use.

addActionMessage

public void addActionMessage(String color,
                             String message)

Sets a UI message and the color type for the user.

Parameters:

color - The color to use.

message - The message to display.

getWebItemsForSection

public List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getWebItemsForSection(String sectionName)

getWebSectionsForLocation

public List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getWebSectionsForLocation(String location)

renderFreemarkerTemplate

public String renderFreemarkerTemplate(String templateString)

getWebFragmentsContextMap

public Map<String,Object> getWebFragmentsContextMap()

getDisplayableLink

public String getDisplayableLink(com.atlassian.plugin.web.model.WebLink link)

getLink

public String getLink(com.atlassian.plugin.web.model.WebLink link)

getLabel

public String getLabel(com.atlassian.plugin.web.model.WebLabel label)

directory

public Directory directory(long directoryID)

addActionError

protected void addActionError(Throwable t)

containsErrorMessages

public boolean containsErrorMessages()

containsActionMessages

public boolean containsActionMessages()

setPropertyManager

public void setPropertyManager(PropertyManager propertyManager)

setDirectoryManager

public void setDirectoryManager(DirectoryManager directoryManager)

setCrowdLicenseManager

public void setCrowdLicenseManager(CrowdLicenseManager crowdLicenseManager)

setApplicationManager

public void setApplicationManager(ApplicationManager applicationManager)

setWebInterfaceManager

public void setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)

getWebInterfaceManager

public com.atlassian.plugin.web.WebInterfaceManager getWebInterfaceManager()

getWebResourceManager

public com.atlassian.plugin.webresource.WebResourceManager getWebResourceManager()

setWebResourceManager

public void setWebResourceManager(com.atlassian.plugin.webresource.WebResourceManager webResourceManager)

getBootstrapManager

protected CrowdBootstrapManager getBootstrapManager()

isAtResourceLimit

public boolean isAtResourceLimit()

getCurrentLicenseResourceTotal

public Integer getCurrentLicenseResourceTotal()

getImageTitle

public String getImageTitle(boolean active,
                            ApplicationType applicationType)

getImageLocation

public String getImageLocation(boolean active,
                               ApplicationType applicationType)

authorisedToAccessCrowdConsole

protected boolean authorisedToAccessCrowdConsole(Long directoryId,
                                                 String name)
                                          throws DirectoryNotFoundException,
                                                 UserNotFoundException

Throws:

DirectoryNotFoundException

UserNotFoundException

authorisedToAccessCrowdAdminConsole

public boolean authorisedToAccessCrowdAdminConsole(DirectoryMapping directoryMapping,
                                                   Long directoryId,
                                                   String username)
                                            throws DirectoryNotFoundException,
                                                   UserNotFoundException

Throws:

DirectoryNotFoundException

UserNotFoundException

getText

public String getText(String i18nKey,
                      List args,
                      boolean encode)

getXsrfTokenName

public String getXsrfTokenName()

getXsrfToken

public String getXsrfToken()

getText

public String getText(String i18nKey,
                      List args)

Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

setApplicationService

public void setApplicationService(ApplicationService applicationService)

setTokenAuthenticationManager

public void setTokenAuthenticationManager(TokenAuthenticationManager tokenAuthenticationManager)

setRememberMeService

public void setRememberMeService(CrowdRememberMeService rememberMeService)

setClientProperties

public void setClientProperties(ClientProperties clientProperties)

setXsrfTokenGenerator

public void setXsrfTokenGenerator(XsrfTokenGenerator xsrfTokenGenerator)

getPasswordComplexityMessage

@Nullable
protected String getPasswordComplexityMessage(long directoryId)

Returns:

the password complexity message for the specified directory, or null if there is none

getCrowdApplication

protected Application getCrowdApplication()
                                   throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

setCrowdApplication

public void setCrowdApplication(Application crowdApplication)

setActionHelper

public void setActionHelper(ActionHelper actionHelper)

resolveAvatarUri

protected String resolveAvatarUri(URI uri)

Resolve a URI against a base of Crowd's context path to get a suitable URI for placing into a page. For example, "path/avatar" would become "/crowd/path/avatar", and any absolute URL would be returned as-is.

findAvatarUrl

@Nonnull
protected Optional<String> findAvatarUrl(User user,
                                                  int sizeHint)

getSmallAvatarUrl

public String getSmallAvatarUrl()

applyFieldErrors

public void applyFieldErrors(Collection<FieldError> errors)

setClusterService

public void setClusterService(ClusterService clusterService)

getTextProvider

protected com.opensymphony.xwork2.TextProvider getTextProvider()

Overrides:

getTextProvider in class com.opensymphony.xwork2.ActionSupport

getLocaleProvider

protected com.opensymphony.xwork2.LocaleProvider getLocaleProvider()

Overrides:

getLocaleProvider in class com.opensymphony.xwork2.ActionSupport

bindInformationAboutLicense

protected void bindInformationAboutLicense()