com.redhat.rhn.frontend.action.configuration

Class ConfigActionHelper

java.lang.Object

com.redhat.rhn.frontend.action.configuration.ConfigActionHelper

public abstract class ConfigActionHelper
extends java.lang.Object

BaseCompareFileAction - A base class for doing typical config file request processing.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANNEL
static java.lang.String	CHANNEL_ID
static java.lang.String	FILE
static java.lang.String	FILE_ID
static java.lang.String	REVISION
static java.lang.String	REVISION_ID

Method Summary

Modifier and Type	Method and Description
static void	clearRhnSets(User user) Clears all of the configuration management sets.
static ConfigRevision	findRevision(javax.servlet.http.HttpServletRequest req) Find the requested REVISION.
static ConfigChannel	getChannel(javax.servlet.http.HttpServletRequest request) Finds the config channel with the identifier corresponding with the value of the ccid request parameter.
static ConfigChannel	getChannel(javax.servlet.http.HttpServletRequest request, java.lang.String param) Finds the config channel with the identifier corresponding with the value of the request parameter with the given name.
static ConfigFile	getFile(javax.servlet.http.HttpServletRequest request) Finds the config file from the cfid request parameter.
static ConfigRevision	getRevision(javax.servlet.http.HttpServletRequest request, ConfigFile file) Tries to find the revision using a request parameter.
static java.lang.String	makeChannelCountsMessage(long count, java.lang.String url) Makes messages that look like 1 channel 2 channels None Very standard i18nized counts messages used in various places in config management.
static java.lang.String	makeFileCountsMessage(ConfigFileCount count, java.lang.String url, boolean includeAddUrlForEmpty) Makes messages that look like 1 file and 5 directories and 0 symlinks 2 files and 1 directory and 0 symlinks No files or directories or symlinks Very standard i18nized counts messages used in various places in config management.
static java.lang.String	makeFileCountsMessage(ConfigFileCount count, java.lang.String url, boolean includeEmptyFilesAndDirs, boolean includeAddUrlForEmpty) Makes messages that look like 1 file and 5 directories and 0 symlinks 2 files and 1 directory and 0 symlinks No files or directories and 0 symlinks Very standard i18nized counts messages used in various places in config management.
static void	processParamMap(ConfigChannel cc, java.util.Map params) Adds the config channel info to the given map using the identifiers of the request parameters.
static void	processParamMap(javax.servlet.http.HttpServletRequest request, java.util.Map params) Adds the config revision, config file, and config channel to the given map using the identifiers of the request parameters.
static void	processRequestAttributes(RequestContext rctxIn) Adds the config revision, config file, and config channel as request attributes using the identifiers of the request parameters.
static void	setupRequestAttributes(RequestContext ctx, ConfigChannel channel) Adds the config channel info as request attributes when we know the channel Used by the pages that aren't file- and/or revision-specific
static void	setupRequestAttributes(RequestContext rctxIn, ConfigFile file, ConfigRevision cr) Adds the config revision, config file, and config channel as request attributes when we already know the file and rev

Methods inherited from class java.lang.Object

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

Field Detail

REVISION_ID

public static final java.lang.String REVISION_ID

See Also:

Constant Field Values

FILE_ID

public static final java.lang.String FILE_ID

See Also:

Constant Field Values

CHANNEL_ID

public static final java.lang.String CHANNEL_ID

See Also:

Constant Field Values

FILE

public static final java.lang.String FILE

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

CHANNEL

public static final java.lang.String CHANNEL

See Also:

Constant Field Values

Method Detail

processRequestAttributes

public static void processRequestAttributes(RequestContext rctxIn)

Adds the config revision, config file, and config channel as request attributes using the identifiers of the request parameters.

Parameters:

rctxIn - The request context which has the request.

setupRequestAttributes

public static void setupRequestAttributes(RequestContext rctxIn,
                                          ConfigFile file,
                                          ConfigRevision cr)

Adds the config revision, config file, and config channel as request attributes when we already know the file and rev

Parameters:

rctxIn - The request context which has the request.

file - known config-file

cr - known revision (null if there isn't one)

setupRequestAttributes

public static void setupRequestAttributes(RequestContext ctx,
                                          ConfigChannel channel)

Adds the config channel info as request attributes when we know the channel Used by the pages that aren't file- and/or revision-specific

Parameters:

ctx - The request context which has the request.

channel - known channel

processParamMap

public static void processParamMap(ConfigChannel cc,
                                   java.util.Map params)

Adds the config channel info to the given map using the identifiers of the request parameters.

Parameters:

cc - ConfigChannel of interest

params - The map in which findings should be stored.

processParamMap

public static void processParamMap(javax.servlet.http.HttpServletRequest request,
                                   java.util.Map params)

Adds the config revision, config file, and config channel to the given map using the identifiers of the request parameters.

Parameters:

request - The HttServletRequest to get identifiers from

params - The map to which findings should be stored.

getChannel

public static ConfigChannel getChannel(javax.servlet.http.HttpServletRequest request,
                                       java.lang.String param)

Finds the config channel with the identifier corresponding with the value of the request parameter with the given name.

Parameters:

request - The request to look in for the id (if we're creating a new channel, it might be null)

param - The name of the id request parameter.

Returns:

The sought config channel.

getChannel

public static ConfigChannel getChannel(javax.servlet.http.HttpServletRequest request)

Finds the config channel with the identifier corresponding with the value of the ccid request parameter.

Parameters:

request - The request to look in for the id

Returns:

The sought config channel.

getFile

public static ConfigFile getFile(javax.servlet.http.HttpServletRequest request)

Finds the config file from the cfid request parameter.

Parameters:

request - The HttpServletRequest with a cfid

Returns:

The found file

getRevision

public static ConfigRevision getRevision(javax.servlet.http.HttpServletRequest request,
                                         ConfigFile file)

Tries to find the revision using a request parameter. Defaults to the newest revision of the given file if it is not found.

Parameters:

request - The HttpServletRequest which has a crid parameter

file - The file this revision should belong to.

Returns:

The found revision

findRevision

public static ConfigRevision findRevision(javax.servlet.http.HttpServletRequest req)

Find the requested REVISION. We have a revision-id as "crid" - but sometimes, we only have a file-id as "cfid". If the latter, find the ConfigFile's latest revision.

Parameters:

req - incoming request

Returns:

a ConfigRevision, or NULL if we couldn't find one

clearRhnSets

public static void clearRhnSets(User user)

Clears all of the configuration management sets.

Parameters:

user - The user for which to clear the sets.

makeFileCountsMessage

public static java.lang.String makeFileCountsMessage(ConfigFileCount count,
                                                     java.lang.String url,
                                                     boolean includeAddUrlForEmpty)

Makes messages that look like 1 file and 5 directories and 0 symlinks 2 files and 1 directory and 0 symlinks No files or directories or symlinks Very standard i18nized counts messages used in various places in config management.

Parameters:

count - the ConfigFileCount object, that stores info on the number of files and directories

url - the url to wrap the messages if so desired

includeAddUrlForEmpty - include "Add" section for empty

Returns:

the properly formatted File and Directories helper messages ..

makeFileCountsMessage

public static java.lang.String makeFileCountsMessage(ConfigFileCount count,
                                                     java.lang.String url,
                                                     boolean includeEmptyFilesAndDirs,
                                                     boolean includeAddUrlForEmpty)

Makes messages that look like 1 file and 5 directories and 0 symlinks 2 files and 1 directory and 0 symlinks No files or directories and 0 symlinks Very standard i18nized counts messages used in various places in config management.

Parameters:

count - the ConfigFileCount object, that stores info on the number of files and directories

url - the url to wrap the messages if so desired

includeEmptyFilesAndDirs - force the inclusion of both the file and directory information even if their count is 0. for example: if this param == true return "0 files and 1 directory and 0 symlinks" else return "1 directory"

includeAddUrlForEmpty - include "Add" section for empty

Returns:

the properly formatted File and Directories helper messages ..

makeChannelCountsMessage

public static java.lang.String makeChannelCountsMessage(long count,
                                                        java.lang.String url)

Makes messages that look like 1 channel 2 channels None Very standard i18nized counts messages used in various places in config management.

Parameters:

count - the number of config channels

url - the url to wrap the messages if so desired

Returns:

the properly formatted config channel messages