com.redhat.rhn.frontend.action

Class BaseSearchAction

java.lang.Object

org.apache.struts.action.Action

com.redhat.rhn.frontend.struts.RhnAction

com.redhat.rhn.frontend.action.BaseSearchAction

Direct Known Subclasses:

DocSearchSetupAction, ErrataSearchAction, PackageSearchAction, SystemSearchAction, XccdfSearchAction

public abstract class BaseSearchAction
extends RhnAction

Base action for searches - this is a place to put the 'magic strings' that connect the JSP forms and pages to the action, and to impose a certain amount of uniformity on our (currently-very-non-uniform) search processing.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_CHANNELS
static java.lang.String	ARCHITECTURE
static java.lang.String	CHANNEL
static java.lang.String	CHANNEL_ARCH
static java.lang.String	CHANNEL_ARCHES
static java.lang.String	CHANNEL_FILTER
static java.lang.String[]	DEFAULT_ARCHES Channel-arches a default package-search should look in
static java.lang.String	DISPLAY_KEY
static java.lang.String	ERRATA_BUG
static java.lang.String	ERRATA_ENH
static java.lang.String	ERRATA_SEC
static java.util.List<java.lang.String>	EXCLUDED_ARCHES List of channel arches we don't really support any more.
static java.lang.String	FINE_GRAINED
static java.lang.String	INVERT_RESULTS
protected static org.apache.log4j.Logger	LOG
static java.lang.String	OPT_ADVISORY
static java.lang.String	OPT_ALL_FIELDS
static java.lang.String	OPT_CONTENT_ONLY
static java.lang.String	OPT_CONTENT_TITLE
static java.lang.String	OPT_CVE
static java.lang.String	OPT_FREE_FORM
static java.lang.String	OPT_GROUPS_KEYS
static java.lang.String	OPT_GROUPS_MAP
static java.lang.String	OPT_ISSUE_DATE
static java.lang.String	OPT_NAME_AND_DESC
static java.lang.String	OPT_NAME_AND_SUMMARY
static java.lang.String	OPT_NAME_ONLY
static java.lang.String	OPT_PKG_NAME
static java.lang.String	OPT_TITLE_ONLY
static java.lang.String	RELEVANT
static java.lang.String	SCAN_DATE_SEARCH
static java.lang.String	SEARCH_OPT
static java.lang.String	SEARCH_STR
static java.lang.String	VALUE_KEY
static java.lang.String	VIEW_MODE
static java.lang.String	WHERE_ALL
static java.lang.String	WHERE_CRITERIA
static java.lang.String	WHERE_SSM
static java.lang.String	WHERE_TO_SEARCH

Fields inherited from class com.redhat.rhn.frontend.struts.RhnAction

SUBMITTED

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
BaseSearchAction()

Method Summary

Modifier and Type	Method and Description
protected void	addOption(java.util.List<java.util.Map<java.lang.String,java.lang.String>> options, java.lang.String key, java.lang.String value) Utility function to create options for the dropdown.
void	addOption(java.util.List<java.util.Map<java.lang.String,java.lang.String>> options, java.lang.String key, java.lang.String value, boolean flag) Utility function to create options for the dropdown.
protected abstract org.apache.struts.action.ActionForward	doExecute(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.DynaActionForm form) This is the guts of a search action - do what needs doing, and return what you think the next page should be
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) The default execute() workflow for search-related actions is to call executeBody(), handle any execptions thrown, and return whatever destination executeBody returned.
protected org.apache.struts.action.ActionForward	executeBody(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.DynaActionForm form) This method invokes insureFormDefaults(), followed by doExecute().
protected abstract void	insureFormDefaults(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.DynaActionForm form) This gives the child-actions a chance to set up sane defaults no matter how the happen to be invoked.

Methods inherited from class com.redhat.rhn.frontend.struts.RhnAction

addGlobalMessage, addGlobalMessage, addMessage, createErrorMessage, createErrorMessageWithMultipleArgs, createLabelValueList, createMessage, createSuccessMessage, getStrutsDelegate, isSubmitted, l10n, localize, lv, lve, lvel10n, lvl10n, makeParamMap, saveMessages

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

DEFAULT_ARCHES

public static final java.lang.String[] DEFAULT_ARCHES

Channel-arches a default package-search should look in

EXCLUDED_ARCHES

public static final java.util.List<java.lang.String> EXCLUDED_ARCHES

List of channel arches we don't really support any more.

FINE_GRAINED

public static final java.lang.String FINE_GRAINED

See Also:

Constant Field Values

SEARCH_STR

public static final java.lang.String SEARCH_STR

See Also:

Constant Field Values

VIEW_MODE

public static final java.lang.String VIEW_MODE

See Also:

Constant Field Values

SEARCH_OPT

public static final java.lang.String SEARCH_OPT

See Also:

Constant Field Values

ALL_CHANNELS

public static final java.lang.String ALL_CHANNELS

See Also:

Constant Field Values

ARCHITECTURE

public static final java.lang.String ARCHITECTURE

See Also:

Constant Field Values

CHANNEL

public static final java.lang.String CHANNEL

See Also:

Constant Field Values

CHANNEL_ARCH

public static final java.lang.String CHANNEL_ARCH

See Also:

Constant Field Values

CHANNEL_ARCHES

public static final java.lang.String CHANNEL_ARCHES

See Also:

Constant Field Values

CHANNEL_FILTER

public static final java.lang.String CHANNEL_FILTER

See Also:

Constant Field Values

OPT_FREE_FORM

public static final java.lang.String OPT_FREE_FORM

See Also:

Constant Field Values

OPT_NAME_AND_DESC

public static final java.lang.String OPT_NAME_AND_DESC

See Also:

Constant Field Values

OPT_NAME_AND_SUMMARY

public static final java.lang.String OPT_NAME_AND_SUMMARY

See Also:

Constant Field Values

OPT_NAME_ONLY

public static final java.lang.String OPT_NAME_ONLY

See Also:

Constant Field Values

RELEVANT

public static final java.lang.String RELEVANT

See Also:

Constant Field Values

WHERE_CRITERIA

public static final java.lang.String WHERE_CRITERIA

See Also:

Constant Field Values

OPT_ISSUE_DATE

public static final java.lang.String OPT_ISSUE_DATE

See Also:

Constant Field Values

OPT_ADVISORY

public static final java.lang.String OPT_ADVISORY

See Also:

Constant Field Values

OPT_PKG_NAME

public static final java.lang.String OPT_PKG_NAME

See Also:

Constant Field Values

OPT_CVE

public static final java.lang.String OPT_CVE

See Also:

Constant Field Values

OPT_ALL_FIELDS

public static final java.lang.String OPT_ALL_FIELDS

See Also:

Constant Field Values

ERRATA_BUG

public static final java.lang.String ERRATA_BUG

See Also:

Constant Field Values

ERRATA_SEC

public static final java.lang.String ERRATA_SEC

See Also:

Constant Field Values

ERRATA_ENH

public static final java.lang.String ERRATA_ENH

See Also:

Constant Field Values

OPT_CONTENT_ONLY

public static final java.lang.String OPT_CONTENT_ONLY

See Also:

Constant Field Values

OPT_TITLE_ONLY

public static final java.lang.String OPT_TITLE_ONLY

See Also:

Constant Field Values

OPT_CONTENT_TITLE

public static final java.lang.String OPT_CONTENT_TITLE

See Also:

Constant Field Values

OPT_GROUPS_MAP

public static final java.lang.String OPT_GROUPS_MAP

See Also:

Constant Field Values

OPT_GROUPS_KEYS

public static final java.lang.String OPT_GROUPS_KEYS

See Also:

Constant Field Values

WHERE_TO_SEARCH

public static final java.lang.String WHERE_TO_SEARCH

See Also:

Constant Field Values

INVERT_RESULTS

public static final java.lang.String INVERT_RESULTS

See Also:

Constant Field Values

WHERE_ALL

public static final java.lang.String WHERE_ALL

See Also:

Constant Field Values

WHERE_SSM

public static final java.lang.String WHERE_SSM

See Also:

Constant Field Values

SCAN_DATE_SEARCH

public static final java.lang.String SCAN_DATE_SEARCH

See Also:

Constant Field Values

DISPLAY_KEY

public static final java.lang.String DISPLAY_KEY

See Also:

Constant Field Values

VALUE_KEY

public static final java.lang.String VALUE_KEY

See Also:

Constant Field Values

Constructor Detail

BaseSearchAction

public BaseSearchAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm formIn,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)

The default execute() workflow for search-related actions is to call executeBody(), handle any execptions thrown, and return whatever destination executeBody returned.

Overrides:

execute in class org.apache.struts.action.Action

executeBody

protected org.apache.struts.action.ActionForward executeBody(javax.servlet.http.HttpServletRequest request,
                                                             org.apache.struts.action.ActionMapping mapping,
                                                             org.apache.struts.action.DynaActionForm form)
                                                      throws java.net.MalformedURLException,
                                                             redstone.xmlrpc.XmlRpcFault

This method invokes insureFormDefaults(), followed by doExecute(). Child classes are expected to do "reasonable" things in those methods.

Parameters:

request - http request

mapping - action mapping

form - associated form

Returns:

expected destination from doExecute

Throws:

java.net.MalformedURLException - malformed URL exception

redstone.xmlrpc.XmlRpcFault - XMLrpc fault

doExecute

protected abstract org.apache.struts.action.ActionForward doExecute(javax.servlet.http.HttpServletRequest request,
                                                                    org.apache.struts.action.ActionMapping mapping,
                                                                    org.apache.struts.action.DynaActionForm form)
                                                             throws java.net.MalformedURLException,
                                                                    redstone.xmlrpc.XmlRpcFault

This is the guts of a search action - do what needs doing, and return what you think the next page should be

Parameters:

request - incoming HTTP request

mapping - incoming action-mapping

form - form associated with this mapping

Returns:

the desired desitination based on your processing

Throws:

java.net.MalformedURLException - malformed URL exception

redstone.xmlrpc.XmlRpcFault - XMLrpc fault

insureFormDefaults

protected abstract void insureFormDefaults(javax.servlet.http.HttpServletRequest request,
                                           org.apache.struts.action.DynaActionForm form)

This gives the child-actions a chance to set up sane defaults no matter how the happen to be invoked. Set up the form here, so that it can be relied on by code later in the workflow.

Parameters:

request - incoming HTTP request

form - form associated with the request

addOption

protected void addOption(java.util.List<java.util.Map<java.lang.String,java.lang.String>> options,
                         java.lang.String key,
                         java.lang.String value)

Utility function to create options for the dropdown.

Parameters:

options - list containing all options.

key - resource bundle key used as the display value.

value - value to be submitted with form.

addOption

public void addOption(java.util.List<java.util.Map<java.lang.String,java.lang.String>> options,
                      java.lang.String key,
                      java.lang.String value,
                      boolean flag)

Utility function to create options for the dropdown.

Parameters:

options - list containing all options.

key - resource bundle key used as the display value.

value - value to be submitted with form.

flag - Flag the item with an asterisk (*) indicating it is *not* synch'd