com.atlassian.jira.web.action
Class JiraWebActionSupport

java.lang.Object
  webwork.action.ActionSupport
      com.atlassian.jira.action.JiraActionSupport
          com.atlassian.jira.web.action.JiraWebActionSupport

All Implemented Interfaces:

ErrorCollection, I18nHelper, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

Direct Known Subclasses:

AbstractConfigureFieldLayout, AbstractConstantAction, AbstractConvertIssue, AbstractDashboardAdministration, AbstractEditConfigurationItemAction, AbstractEditFieldLayoutItem, AbstractEditFieldLayoutSchemeAction, AbstractFieldLayoutAction, AbstractFieldScreenAction, AbstractFieldScreenSchemeAction, AbstractManageIssueTypeOptionsAction, AbstractProjectImportProgress, AbstractProjectImportUsersMissing, AbstractProjectRole, AbstractRoleActorAction, AbstractRoleActors, AbstractSchemeAware, AbstractSchemeAwareAction, AbstractSchemeToolAction, AbstractSetupAction, AbstractTrustedApplicationAction, AbstractViewWorkflowMetaAttributes, AbstractWorkflowStep, AbstractWorkflowTransition, AbstractWorkflowTransitionAction, AcknowledgeTask, AddPortalPage, AddUser, AdjustFavourite, AdminSummary, AdvancedApplicationProperties, AllUsersRememberMeCookies, AssociateFieldToScreens, BrowseComponent, BrowseProjects, BrowseVersion, BulkEditUserGroups, CantBrowseCreatedIssue, ChangePassword, CleanData, ClearRememberMeCookies, CloneWorkflow, ConfigureCrowdServer, ConfigureCustomField, ConfigureFieldLayoutScheme, ConfigureFieldScreen, ConfigureIssueTypeScreenScheme, ConfigurePortalPages, ConfigureWhitelist, ConfirmInstallationWithLicense, ConfirmNewInstallationWithOldLicense, ContactAdministrators, CreateDraftWorkflow, CurrentUsersList, Dashboard, DateRangePicker, DeleteCustomField, DeleteLinkType, DeletePortalPage, DeleteWorkflowTransitions, DisableSubTasks, EditAnnouncementBanner, EditCrowdApplication, EditCustomField, EditDarkFeatures, EditDefaultDashboard, EditFieldLayoutItemRendererConfirmation, EditIssueTypeScreenScheme, EditLinkType, EditListener, EditNestedGroups, EditPortalPage, EditProfile, EditService, EditSubTaskIssueTypes, EditWorkflow, FavouriteFilters, FilterPickerPopup, ForgotLoginDetails, FuncTestWriter, IconPicker, ImportResult, ImportWorkflow, IndexOptimize, IntegrityChecker, IssuePicker, JellyRunner, JiraCreditsPage, JiraSupportRequest, JiraWizardActionSupport, LeaveAdmin, ListEventTypes, ListWorkflows, Logout, MailQueueAdmin, MailServerActionSupport, MailWebActionSupport, ManageConfigurationScheme, ManageSubTasks, MyJiraHome, PreparedReferenceAction, ProjectActionSupport, ProjectEmail, ProjectImportResultsAction, ProjectImportSelectBackup, ProjectImportSelectProject, ProjectImportSummary, PublishDraftWorkflow, RecentIssueHistory, ReferenceAction, ReferenceComponentAction, ReferenceComponentImportAction, ReferenceModuleTypeAction, ReferenceResourceAction, ReleaseNote, RepositoryActionSupport, ResetFailedLoginCount, ResetPassword, RestoreDefaultDashboard, SchedulerAdmin, SchemeToolsAction, SelectFieldLayoutScheme, SelectIssueTypeScreenScheme, SelectProjectCategory, SelectProjectRepository, SendBulkMail, SendTestMail, ServiceExecutor, SessionTimeoutMessage, SetSelectedIssue, SetupBonfire, SetupGreenHopper, ShowConstantsHelp, ShowTimeTrackingHelp, Signup, TaskAdmin, TimeTrackingAdmin, UpdateUserPreferences, ViewCustomFields, ViewGroup, ViewInstrumentation, ViewIssueTypeScreenSchemes, ViewKeyboardShortcuts, ViewLicense, ViewLinkTypes, ViewListeners, ViewLogging, ViewProjects, ViewSchemes, ViewServices, ViewSystemInfo, ViewTrustedApplications, ViewUserHover, ViewUserProjectRoles, ViewWorkflowXml, WebSudoAuthenticate, WikiRendererHelpAction, XsrfErrorAction

@NotThreadSafe
public class JiraWebActionSupport
extends JiraActionSupport
implements ErrorCollection, AuthorizationSupport

All web actions should extend this class - it provides basic common functionality for all web actions.

When adding to this class, be sure that what you are adding is used by a large number of actions - otherwise add it to a sub class of this.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

static String	ISSUE_NOT_FOUND_RESULT
static String	PERMISSION_VIOLATION_RESULT
protected javax.servlet.http.HttpServletRequest	request
static String	RETURN_URL_PARAMETER
protected Collection	savedFilters

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

JiraWebActionSupport()

Method Summary

void	addError(String field, String message, ErrorCollection.Reason reason) Add a field-specific error message.
void	addErrorCollection(ErrorCollection errors) Populate this ErrorCollection with general and field-specific errors.
void	addErrorMessage(String message, ErrorCollection.Reason reason) Add error message relating to system state (not field-specific), and a reason.
protected void	addErrorMessageByKeyIfAbsent(String errorMsgKey)
protected void	addErrorMessageIfAbsent(String errorMsg)
void	addReason(ErrorCollection.Reason reason) Add a reason why the function has not been performed.
void	addReasons(Set<ErrorCollection.Reason> reasons) Add reasons why the function has not been performed.
protected String	forceRedirect(String redirect) This method will force a server redirect.
String	getAdministratorContactLink() Get the link, with Internationalised text for contacting the administrators of JIRA.
ApplicationProperties	getApplicationProperties()
String	getConglomerateCookieValue(String cookieName, String key) Retrieve the value from a conglomerate Cookie from the request.
ConstantsManager	getConstantsManager()
String	getDateFormat()
String	getDateTimeFormat()
DateTimeFormatter	getDateTimeFormatter() Returns a DateTimeFormatter that can be used to format times and dates in the user's time zone using DateTimeStyle.RELATIVE.
String	getDescTranslation(org.ofbiz.core.entity.GenericValue issueConstantGV)
DateTimeFormatter	getDmyDateFormatter() Returns a DateTimeFormatter that can be used to format dates in the user's time zone using DateTimeStyle.DATE.
Field	getField(String id)
Collection<String>	getFlushedErrorMessages() Get error messages, then get rid of them.
protected GlobalPermissionManager	getGlobalPermissionManager()
Hint	getHint(String context)
protected HintManager	getHintManager()
JiraContactHelper	getJiraContactHelper()
JiraServiceContext	getJiraServiceContext() Provides a service context with the current user which contains this action as its ErrorCollection.
String	getLanguage()
com.atlassian.crowd.embedded.api.User	getLoggedInUser()
String	getNameTranslation(org.ofbiz.core.entity.GenericValue issueConstantGV)
OutlookDate	getOutlookDate() Deprecated. Use getDateTimeFormatter() instead. Since v5.0.
protected PermissionManager	getPermissionManager()
ProjectManager	getProjectManager()
Hint	getRandomHint()
Set<ErrorCollection.Reason>	getReasons() A set of well known reasons why the function has not been performed.
String	getRedirect(String defaultUrl) Get a definitive result with a redirect upon success.
protected SafeRedirectChecker	getRedirectChecker()
String	getReturnUrl()
String	getReturnUrlForCancelLink() The cancel links should not included the selectedIssueId, otherwise when returning to the issue navigator an issue updated notification will be shown.
List<String>	getSearchSortDescriptions(SearchRequest searchRequest)
org.ofbiz.core.entity.GenericValue	getSelectedProject() Deprecated. Use getSelectedProjectObject() instead. Since v5.0.
Project	getSelectedProjectObject() Gets the last viewed project that the user visited and still has permission to see.
String	getServerId()
String	getTimeFormat()
UriValidator	getUriValidator()
String	getUserFullName(String username)
UserManager	getUserManager()
protected UserProjectHistoryManager	getUserProjectHistoryManager()
VersionManager	getVersionManager()
String	getWebworkStack() For debugging JSPs; prints the webwork stack.
String	getWebworkStack(String selected) For debugging JSPs; prints the webwork stack, highlighting the specified node.
String	getXsrfToken()
protected boolean	hasErrorMessage(String errorMsg)
protected boolean	hasErrorMessageByKey(String errorMsgKey)
String	htmlEncode(String encodeMe) Convenience instance method to call static utility from webwork EL.
protected String	insertContextPath(String url) Prepends the context path to the URL if it begins with a forward slash (this is commonly used for redirects within a JIRA instance).
boolean	isHasIssuePermission(int permissionsId, org.ofbiz.core.entity.GenericValue issue)
boolean	isHasIssuePermission(String permName, org.ofbiz.core.entity.GenericValue issue)
boolean	isHasPermission(int permissionsId)
boolean	isHasPermission(String permName)
boolean	isHasPermission(String permName, org.ofbiz.core.entity.GenericValue entity) Deprecated.
boolean	isHasProjectPermission(int permissionsId, org.ofbiz.core.entity.GenericValue project)
boolean	isHasProjectPermission(String permName, org.ofbiz.core.entity.GenericValue project)
boolean	isInlineDialogMode() This returns true if the action has been invoked as an inline dialog.
boolean	isSystemAdministrator()
boolean	isUserExists(String username)
String	returnComplete()
String	returnComplete(String url)
protected String	returnCompleteWithInlineRedirect(String url) This will return success response with body containing url to redirect.
protected String	returnCompleteWithInlineRedirectAndMsg(String url, String msg, String type, boolean closeable, String target) This will redirect like returnCompleteWithInlineRedirect(String), and will also populate the response with the details of a pop-up message to be displayed on the redirected page.
protected String	returnMsgToUser(String url, String msg, String type, boolean closeable, String target) This will redirect like returnComplete(), and will also populate the response with the details of a pop-up message to be displayed on the redirected page.
void	setConglomerateCookieValue(String cookieName, String key, String value) Set the value key/value pair in a conglomerate Cookie.
void	setInline(boolean inline) This is the web parameter setter for invoking an action as an inline dialog
void	setReasons(Set<ErrorCollection.Reason> reasons) Set reasons why the function has not been performed.
void	setReturnUrl(String returnUrl)
void	setSelectedProjectId(Long id)

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getRemoteUser, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, doExecute, doValidation, getCommandName, getErrorMessages, getErrors, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Field Detail

RETURN_URL_PARAMETER

public static final String RETURN_URL_PARAMETER

See Also:

Constant Field Values

PERMISSION_VIOLATION_RESULT

public static final String PERMISSION_VIOLATION_RESULT

See Also:

Constant Field Values

ISSUE_NOT_FOUND_RESULT

public static final String ISSUE_NOT_FOUND_RESULT

See Also:

Constant Field Values

request

protected javax.servlet.http.HttpServletRequest request

savedFilters

protected Collection savedFilters

Constructor Detail

JiraWebActionSupport

public JiraWebActionSupport()

Method Detail

getLoggedInUser

public com.atlassian.crowd.embedded.api.User getLoggedInUser()

Specified by:

getLoggedInUser in class JiraActionSupport

Returns:

The logged in user.

getXsrfToken

public String getXsrfToken()

getApplicationProperties

public ApplicationProperties getApplicationProperties()

Overrides:

getApplicationProperties in class JiraActionSupport

getUriValidator

public UriValidator getUriValidator()

getRedirectChecker

protected SafeRedirectChecker getRedirectChecker()

getGlobalPermissionManager

protected GlobalPermissionManager getGlobalPermissionManager()

getPermissionManager

protected PermissionManager getPermissionManager()

getUserProjectHistoryManager

protected UserProjectHistoryManager getUserProjectHistoryManager()

getConstantsManager

public ConstantsManager getConstantsManager()

getProjectManager

public ProjectManager getProjectManager()

getVersionManager

public VersionManager getVersionManager()

getOutlookDate

@Deprecated
public OutlookDate getOutlookDate()

Deprecated. Use getDateTimeFormatter() instead. Since v5.0.

getDateTimeFormatter

public DateTimeFormatter getDateTimeFormatter()

Returns a DateTimeFormatter that can be used to format times and dates in the user's time zone using DateTimeStyle.RELATIVE.

Returns:

a DateTimeFormatter

getDmyDateFormatter

public DateTimeFormatter getDmyDateFormatter()

Returns a DateTimeFormatter that can be used to format dates in the user's time zone using DateTimeStyle.DATE.

Returns:

a DateTimeFormatter

getJiraContactHelper

public JiraContactHelper getJiraContactHelper()

getUserManager

public UserManager getUserManager()

getAdministratorContactLink

public String getAdministratorContactLink()

Get the link, with Internationalised text for contacting the administrators of JIRA. This link is present on many pages across the bredth of JIRA and so centralised here.

Returns:

html String of the contact administrators link.

See Also:

JiraContactHelper#getAdministratorContactLinkHtml(String, com.atlassian.jira.util.I18nHelper)}

getHintManager

protected final HintManager getHintManager()

getRedirect

public String getRedirect(String defaultUrl)

Get a definitive result with a redirect upon success.

Returns Action.ERROR if there are error messages, otherwise redirects to another URL if successful. If URL starts with '/', interpreted as context-relative

Since 3.1 now redirects to a the "returnUrl" if one exists. Will clear this value once this occurs

Parameters:

defaultUrl - default URL to redirect to

Returns:

URL to redirect to

forceRedirect

protected String forceRedirect(String redirect)

This method will force a server redirect. It doesn't clear the return URL and will always go to the redirect URL

Parameters:

redirect - redirect URL

Returns:

Action.NONE. It'll just redirect to where you've specified

isHasPermission

public boolean isHasPermission(String permName)

Specified by:

isHasPermission in interface AuthorizationSupport

isHasPermission

public boolean isHasPermission(int permissionsId)

Specified by:

isHasPermission in interface AuthorizationSupport

isHasIssuePermission

public boolean isHasIssuePermission(String permName,
                                    org.ofbiz.core.entity.GenericValue issue)

Specified by:

isHasIssuePermission in interface AuthorizationSupport

isHasIssuePermission

public boolean isHasIssuePermission(int permissionsId,
                                    org.ofbiz.core.entity.GenericValue issue)

Specified by:

isHasIssuePermission in interface AuthorizationSupport

isHasProjectPermission

public boolean isHasProjectPermission(String permName,
                                      org.ofbiz.core.entity.GenericValue project)

Specified by:

isHasProjectPermission in interface AuthorizationSupport

isHasProjectPermission

public boolean isHasProjectPermission(int permissionsId,
                                      org.ofbiz.core.entity.GenericValue project)

Specified by:

isHasProjectPermission in interface AuthorizationSupport

isHasPermission

@Deprecated
public boolean isHasPermission(String permName,
                                          org.ofbiz.core.entity.GenericValue entity)

Deprecated.

Description copied from interface: AuthorizationSupport

Returns true if remote user has permission over given entity, false otherwise.

Specified by:

isHasPermission in interface AuthorizationSupport

Parameters:

permName - permission type

entity - entity to check the permission for, e.g. project, issue

Returns:

true if remote user has permission over given entity, false otherwise

isSystemAdministrator

public boolean isSystemAdministrator()

isUserExists

public boolean isUserExists(String username)

getUserFullName

public String getUserFullName(String username)

addErrorCollection

public void addErrorCollection(ErrorCollection errors)

Description copied from interface: ErrorCollection

Populate this ErrorCollection with general and field-specific errors.

Specified by:

addErrorCollection in interface ErrorCollection

Parameters:

errors - ErrorCollection whose errors/messages we obtain.

addError

public void addError(String field,
                     String message,
                     ErrorCollection.Reason reason)

Description copied from interface: ErrorCollection

Add a field-specific error message.

Specified by:

addError in interface ErrorCollection

Parameters:

field - Field name, eg. "assignee"

message - Error message.

reason - Reason for the error.

addErrorMessage

public void addErrorMessage(String message,
                            ErrorCollection.Reason reason)

Description copied from interface: ErrorCollection

Add error message relating to system state (not field-specific), and a reason.

Specified by:

addErrorMessage in interface ErrorCollection

Parameters:

message - Error message.

reason - Reason for the error.

addReason

public void addReason(ErrorCollection.Reason reason)

Description copied from interface: ErrorCollection

Add a reason why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

addReason in interface ErrorCollection

Parameters:

reason - a well known reasons why the function has not been performed.

addReasons

public void addReasons(Set<ErrorCollection.Reason> reasons)

Description copied from interface: ErrorCollection

Add reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

addReasons in interface ErrorCollection

Parameters:

reasons - a set of well known reasons why the function has not been performed.

setReasons

public void setReasons(Set<ErrorCollection.Reason> reasons)

Description copied from interface: ErrorCollection

Set reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

setReasons in interface ErrorCollection

Parameters:

reasons - a set of well known reasons why the function has not been performed.

getReasons

public Set<ErrorCollection.Reason> getReasons()

Description copied from interface: ErrorCollection

A set of well known reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

getReasons in interface ErrorCollection

Returns:

a set of well known reasons why the function has not been performed.

getField

public Field getField(String id)

getSearchSortDescriptions

public List<String> getSearchSortDescriptions(SearchRequest searchRequest)

getNameTranslation

public String getNameTranslation(org.ofbiz.core.entity.GenericValue issueConstantGV)

getDescTranslation

public String getDescTranslation(org.ofbiz.core.entity.GenericValue issueConstantGV)

getReturnUrl

public String getReturnUrl()

getReturnUrlForCancelLink

public String getReturnUrlForCancelLink()

The cancel links should not included the selectedIssueId, otherwise when returning to the issue navigator an issue updated notification will be shown.

Returns:

the returnUrl with selectedIssueId parameter stripped out.

setReturnUrl

public void setReturnUrl(String returnUrl)

getFlushedErrorMessages

public Collection<String> getFlushedErrorMessages()

Description copied from interface: ErrorCollection

Get error messages, then get rid of them.

Specified by:

getFlushedErrorMessages in interface ErrorCollection

Returns:

The (now cleared) error messages.

getLanguage

public String getLanguage()
                   throws IOException

Throws:

IOException

getSelectedProjectObject

public Project getSelectedProjectObject()

Gets the last viewed project that the user visited and still has permission to see.

Returns:

the last project the user visited.

See Also:

UserProjectHistoryManager.getCurrentProject(int, User)

getSelectedProject

public org.ofbiz.core.entity.GenericValue getSelectedProject()

Deprecated. Use getSelectedProjectObject() instead. Since v5.0.

Gets the "active" project.

Projects become active when your browse, search for a single project or create an issue.

Returns:

the "active" project.

setSelectedProjectId

public void setSelectedProjectId(Long id)

getDateFormat

public String getDateFormat()

getDateTimeFormat

public String getDateTimeFormat()

getTimeFormat

public String getTimeFormat()

getWebworkStack

public String getWebworkStack(String selected)

For debugging JSPs; prints the webwork stack, highlighting the specified node. Eg. called with:

Parameters:

selected - selected value in the webwork stack

Returns:

HTML string of the webwork stack

getWebworkStack

public String getWebworkStack()

For debugging JSPs; prints the webwork stack. Eg. called with:

Returns:

HTML string of the webwork stack

getServerId

public String getServerId()

getJiraServiceContext

public JiraServiceContext getJiraServiceContext()

Provides a service context with the current user which contains this action as its ErrorCollection.

Returns:

the JiraServiceContext.

htmlEncode

public String htmlEncode(String encodeMe)

Convenience instance method to call static utility from webwork EL.

Parameters:

encodeMe - a String to be HTML encoded.

Returns:

the HTML encoded string.

isInlineDialogMode

public boolean isInlineDialogMode()

This returns true if the action has been invoked as an inline dialog. This changes the way that the action sends back its responses, namely when the action is submitted and completed

Returns:

true if the action was invoked as an inline dialog

setInline

public void setInline(boolean inline)

This is the web parameter setter for invoking an action as an inline dialog

Parameters:

inline - true if the action should act as an inline dialog

returnComplete

public String returnComplete()

returnComplete

public String returnComplete(String url)

returnCompleteWithInlineRedirect

protected final String returnCompleteWithInlineRedirect(String url)

This will return success response with body containing url to redirect. An appropriately configured client side control should perform redirect to the desired url.

Parameters:

url - URL to redirect to

Returns:

action mapping string

returnCompleteWithInlineRedirectAndMsg

protected String returnCompleteWithInlineRedirectAndMsg(String url,
                                                        String msg,
                                                        String type,
                                                        boolean closeable,
                                                        @Nullable
                                                        String target)

This will redirect like returnCompleteWithInlineRedirect(String), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. An appropriately configured client side control should perform the displaying of the message.

Parameters:

url - URL to redirect to

msg - message HTML

type - type of message, see JIRA.Messages.Types

closeable - if true, message pop-up has an 'X' button, otherwise pop-up fades away automatically

target - the target to prepend the message pop-up to. If null, the message is shown in a global spot

Returns:

action mapping string

returnMsgToUser

protected String returnMsgToUser(String url,
                                 String msg,
                                 String type,
                                 boolean closeable,
                                 @Nullable
                                 String target)

This will redirect like returnComplete(), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. An appropriately configured client side control should perform the displaying of the message.

Parameters:

url - URL to redirect to. Not used in dialogs

msg - message HTML

type - type of message, see JIRA.Messages.Types

closeable - if true, message pop-up has an 'X' button, otherwise pop-up fades away automatically

target - the target to prepend the message pop-up to. If null, the message is shown in a global spot

Returns:

action mapping string

insertContextPath

protected String insertContextPath(String url)

Prepends the context path to the URL if it begins with a forward slash (this is commonly used for redirects within a JIRA instance).

Parameters:

url - a String containing a URL

Returns:

a String with the context path prepended

hasErrorMessage

protected final boolean hasErrorMessage(String errorMsg)

hasErrorMessageByKey

protected final boolean hasErrorMessageByKey(String errorMsgKey)

addErrorMessageIfAbsent

protected final void addErrorMessageIfAbsent(String errorMsg)

addErrorMessageByKeyIfAbsent

protected final void addErrorMessageByKeyIfAbsent(String errorMsgKey)

getHint

public final Hint getHint(String context)

getRandomHint

public final Hint getRandomHint()

getConglomerateCookieValue

public String getConglomerateCookieValue(String cookieName,
                                         String key)

Retrieve the value from a conglomerate Cookie from the request.

Parameters:

cookieName - The name of the conglomerate cookie

key - The key of the value

Returns:

the value (or the empty-string if it did not exist)

setConglomerateCookieValue

public void setConglomerateCookieValue(String cookieName,
                                       String key,
                                       String value)

Set the value key/value pair in a conglomerate Cookie.

Parameters:

cookieName - The name of the conglomerate cookie

key - The key of the value

value - The value