com.atlassian.crowd.console.action
Class BaseAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.crowd.console.action.BaseAction

All Implemented Interfaces:

com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractBrowser, AccessDenied, AddApplication, AddApplicationAuthorisationDetails, AddApplicationConfirmation, AddApplicationConnectionDetails, AddApplicationDetails, AddApplicationDirectoryDetails, AddGroup, AddRole, Administer, Backup, BaseImporter, BaseSetupAction, BaseUserAction, ChangePassword, Console, CreateDirectory, DefaultStartPage, ErrorAction, ForgottenPassword, Import, ImportType, License, Login, RemoveDirectory, RemoveGroup, RemovePrincipal, RemoveRole, RemoveSession, SAMLAuthAction, SystemInfo, UpdateConnectorConfiguration, UpdateConnectorConnection, UpdateCustomAttributes, UpdateGeneral, UpdateGroupMembers, UpdateInternalConfiguration, UpdateInternalPermissions, UpdateLicensing, UpdateLoggingProfiling, UpdateMailServer, UpdateMailTemplate, UpdateSAMLConfiguration, UpdateSessionConfig, UpdateTrustedProxies, ViewApplication, ViewConnector, ViewCustom, ViewGroup, ViewGroupMembers, ViewInternal, ViewPrincipal, ViewRole, ViewRolePrincipals, ViewTrustedProxies

public class BaseAction
extends com.opensymphony.xwork.ActionSupport

See Also:

Serialized Form

Field Summary

protected java.lang.String	actionMessageAlertColor Webwork action messages color settings.
static java.lang.String	ALERT_BLUE
static java.lang.String	ALERT_GREEN
static java.lang.String	ALERT_RED
static java.lang.String	ALERT_YELLOW
protected ApplicationManager	applicationManager
protected CrowdLicenseManager	crowdLicenseManager
protected DirectoryManager	directoryManager
protected boolean	initialLoad
protected org.apache.log4j.Logger	logger
protected PropertyManager	propertyManager
protected java.lang.Integer	tab

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

BaseAction()

Method Summary

void	addActionMessage(java.lang.String color, java.lang.String message) Sets a UI message and the color type for the user.
protected void	assignDefaultApplicationPermissions(DirectoryMapping directoryMapping)
boolean	containsActionMessages()
boolean	containsErrorMessages()
Directory	directory(long directoryID)
java.lang.String	doDefault()
java.lang.String	getActionMessageAlertColor() Gets the action message color dressing to use with the decorator.
SOAPAttribute	getAttribute(java.lang.String name)
protected CrowdBootstrapManager	getBootstrapManager()
java.lang.Integer	getCurrentLicenseResourceTotal()
java.lang.String	getDisplayableLink(com.atlassian.plugin.web.model.WebLink link)
java.lang.String	getFirstAttribute(java.lang.String name)
protected javax.servlet.http.HttpServletRequest	getHttpRequest()
java.lang.String	getImageLocation(boolean active, ApplicationType applicationType)
java.lang.String	getImageTitle(boolean active, ApplicationType applicationType)
com.atlassian.extras.api.crowd.CrowdLicense	getLicense()
java.lang.String	getLink(com.atlassian.plugin.web.model.WebLink link)
java.lang.String	getPrincipalName()
SOAPPrincipal	getRemotePrincipal()
protected javax.servlet.http.HttpSession	getSession()
java.util.Map	getSitemeshPageProperties()
java.lang.String	getSitemeshPageProperty(java.lang.String propertyName)
java.lang.Integer	getTab()
java.util.Map	getWebFragmentsContextMap()
com.atlassian.plugin.web.WebInterfaceManager	getWebInterfaceManager()
java.util.List	getWebItemsForSection(java.lang.String sectionName)
java.util.List	getWebSectionsForLocation(java.lang.String location)
boolean	isAdmin()
boolean	isAtResourceLimit()
boolean	isAuthenticated()
boolean	isEvaluation()
boolean	isInitialLoad()
boolean	isLicenseExpired()
java.lang.String	renderFreemarkerTemplate(java.lang.String templateString)
void	setApplicationDirectoryPermissionDAO(ApplicationDirectoryPermissionDAO applicationDirectoryPermissionDAO)
void	setApplicationManager(ApplicationManager applicationManager)
void	setCrowdLicenseManager(CrowdLicenseManager crowdLicenseManager)
void	setCrowdUserDetailsService(CrowdUserDetailsService crowdUserDetailsService)
void	setDirectoryManager(DirectoryManager directoryManager)
void	setPropertyManager(PropertyManager propertyManager)
void	setTab(java.lang.Integer tab)
void	setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)
protected void	updateAuthenticationStatus() Retrieves the authentication token from the Spring Security context and populates the relevant BaseAction fields (authenticated, admin, remotePrincipal).

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doInput, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.log4j.Logger logger

tab

protected java.lang.Integer tab

initialLoad

protected boolean initialLoad

actionMessageAlertColor

protected java.lang.String actionMessageAlertColor

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

ALERT_GREEN

public static final java.lang.String ALERT_GREEN

See Also:

BaseAction#actionMessageAlertColor;, Constant Field Values

ALERT_YELLOW

public static final java.lang.String ALERT_YELLOW

See Also:

BaseAction#actionMessageAlertColor;, Constant Field Values

ALERT_RED

public static final java.lang.String ALERT_RED

See Also:

BaseAction#actionMessageAlertColor;, Constant Field Values

ALERT_BLUE

public static final java.lang.String ALERT_BLUE

See Also:

BaseAction#actionMessageAlertColor;, Constant Field Values

propertyManager

protected PropertyManager propertyManager

directoryManager

protected DirectoryManager directoryManager

applicationManager

protected ApplicationManager applicationManager

crowdLicenseManager

protected CrowdLicenseManager crowdLicenseManager

Constructor Detail

BaseAction

public BaseAction()

Method Detail

doDefault

public java.lang.String doDefault()
                           throws java.lang.Exception

Overrides:

doDefault in class com.opensymphony.xwork.ActionSupport

Throws:

java.lang.Exception

updateAuthenticationStatus

protected void updateAuthenticationStatus()

Retrieves the authentication token from the Spring Security context and populates the relevant BaseAction fields (authenticated, admin, remotePrincipal).

isAuthenticated

public boolean isAuthenticated()

isAdmin

public boolean isAdmin()

getSitemeshPageProperty

public java.lang.String getSitemeshPageProperty(java.lang.String propertyName)

getSitemeshPageProperties

public java.util.Map getSitemeshPageProperties()

getPrincipalName

public java.lang.String getPrincipalName()
                                  throws InvalidPrincipalException

Throws:

InvalidPrincipalException

getRemotePrincipal

public SOAPPrincipal getRemotePrincipal()

getAttribute

public SOAPAttribute getAttribute(java.lang.String name)
                           throws InvalidPrincipalException

Throws:

InvalidPrincipalException

getFirstAttribute

public java.lang.String getFirstAttribute(java.lang.String name)
                                   throws InvalidPrincipalException

Throws:

InvalidPrincipalException

getSession

protected javax.servlet.http.HttpSession getSession()

getHttpRequest

protected javax.servlet.http.HttpServletRequest getHttpRequest()

getTab

public java.lang.Integer getTab()

setTab

public void setTab(java.lang.Integer tab)

directory

public Directory directory(long directoryID)

isInitialLoad

public boolean isInitialLoad()

getLicense

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

isEvaluation

public boolean isEvaluation()

isLicenseExpired

public boolean isLicenseExpired()

getActionMessageAlertColor

public java.lang.String getActionMessageAlertColor()

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

Returns:

The window dressing color to use.

addActionMessage

public void addActionMessage(java.lang.String color,
                             java.lang.String message)

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

Parameters:

color - The color to use.

message - The message to display.

assignDefaultApplicationPermissions

protected void assignDefaultApplicationPermissions(DirectoryMapping directoryMapping)

getWebItemsForSection

public java.util.List getWebItemsForSection(java.lang.String sectionName)

getWebSectionsForLocation

public java.util.List getWebSectionsForLocation(java.lang.String location)

renderFreemarkerTemplate

public java.lang.String renderFreemarkerTemplate(java.lang.String templateString)

getWebFragmentsContextMap

public java.util.Map getWebFragmentsContextMap()

getDisplayableLink

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

getLink

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

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)

setApplicationDirectoryPermissionDAO

public void setApplicationDirectoryPermissionDAO(ApplicationDirectoryPermissionDAO applicationDirectoryPermissionDAO)

setCrowdUserDetailsService

public void setCrowdUserDetailsService(CrowdUserDetailsService crowdUserDetailsService)

setWebInterfaceManager

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

getWebInterfaceManager

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

getBootstrapManager

protected CrowdBootstrapManager getBootstrapManager()

isAtResourceLimit

public boolean isAtResourceLimit()

getCurrentLicenseResourceTotal

public java.lang.Integer getCurrentLicenseResourceTotal()

getImageTitle

public java.lang.String getImageTitle(boolean active,
                                      ApplicationType applicationType)

getImageLocation

public java.lang.String getImageLocation(boolean active,
                                         ApplicationType applicationType)