com.redhat.rhn.frontend.action

Class CSVDownloadAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DownloadAction

com.redhat.rhn.frontend.action.CSVDownloadAction

public class CSVDownloadAction
extends org.apache.struts.actions.DownloadAction

Expects that the following parameters are available from the request object: EXPORT_COLUMNS set to the value of the session attribute containing the exportColumns PAGE_LIST_DATA set to the value of the session attribute containg the List of items to export UNIQUE_NAME set to the value of the uniqueName associated with this list from the CSVTag

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.struts.actions.DownloadAction

org.apache.struts.actions.DownloadAction.FileStreamInfo, org.apache.struts.actions.DownloadAction.ResourceStreamInfo, org.apache.struts.actions.DownloadAction.StreamInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXPORT_COLUMNS
static java.lang.String	HEADER_NAME
static java.lang.String	PAGE_LIST_DATA
static java.lang.String	QUERY_DATA
static java.lang.String	UNIQUE_NAME

Fields inherited from class org.apache.struts.actions.DownloadAction

DEFAULT_BUFFER_SIZE

Fields inherited from class org.apache.struts.actions.BaseAction

messages

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

servlet

Constructor Summary

Constructors

Constructor and Description
CSVDownloadAction()

Method Summary

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected java.lang.String	getExportColumns(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session) Returns String containing a comma separated list of names to represent the header values of the List or throws Exception if request attribute EXPORT_COLUMNN is missing or session attribute is null.
protected java.lang.String	getHeaderText(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session) Returns the header name
protected java.util.List	getPageData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session) Returns List of data referred to by session attribute with the name PAGE_LIST_DATA.
protected org.apache.struts.actions.DownloadAction.StreamInfo	getStreamInfo(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected java.lang.String	getUniqueName(javax.servlet.http.HttpServletRequest request) Returns the value of the UNIQUE_NAME attribute or exception if value is null.

Methods inherited from class org.apache.struts.actions.DownloadAction

copy, getBufferSize

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, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

EXPORT_COLUMNS

public static final java.lang.String EXPORT_COLUMNS

See Also:

Constant Field Values

PAGE_LIST_DATA

public static final java.lang.String PAGE_LIST_DATA

See Also:

Constant Field Values

QUERY_DATA

public static final java.lang.String QUERY_DATA

See Also:

Constant Field Values

UNIQUE_NAME

public static final java.lang.String UNIQUE_NAME

See Also:

Constant Field Values

HEADER_NAME

public static final java.lang.String HEADER_NAME

See Also:

Constant Field Values

Constructor Detail

CSVDownloadAction

public CSVDownloadAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws java.lang.Exception

Overrides:

execute in class org.apache.struts.actions.DownloadAction

Throws:

java.lang.Exception

getExportColumns

protected java.lang.String getExportColumns(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpSession session)
                                     throws java.lang.Exception

Returns String containing a comma separated list of names to represent the header values of the List or throws Exception if request attribute EXPORT_COLUMNN is missing or session attribute is null.

Parameters:

request - HTTP request

session - HTTP session

Returns:

exported columns

Throws:

java.lang.Exception - thrown if request attribute EXPORT_COLUMN is missing.

getPageData

protected java.util.List getPageData(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpSession session)
                              throws java.lang.Exception

Returns List of data referred to by session attribute with the name PAGE_LIST_DATA. Throws Exception if request attribute PAGE_LIST_DATA is missing or session attribute is null.

Parameters:

request - HTTP Request

session - HTTP session

Returns:

page data

Throws:

java.lang.Exception - thrown if column missing.

getUniqueName

protected java.lang.String getUniqueName(javax.servlet.http.HttpServletRequest request)
                                  throws java.lang.Exception

Returns the value of the UNIQUE_NAME attribute or exception if value is null.

Parameters:

request - HTTP request containing UNIQUE_NAME parameter

Returns:

unique name

Throws:

java.lang.Exception - thrown if UNIQUE_NAME value is null.

getHeaderText

protected java.lang.String getHeaderText(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpSession session)
                                  throws java.lang.Exception

Returns the header name

Parameters:

request - the http servlet request

session - the session

Returns:

the header name

Throws:

java.lang.Exception - something bad happened

getStreamInfo

protected org.apache.struts.actions.DownloadAction.StreamInfo getStreamInfo(org.apache.struts.action.ActionMapping mapping,
                                                                            org.apache.struts.action.ActionForm form,
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)
                                                                     throws java.lang.Exception

Specified by:

getStreamInfo in class org.apache.struts.actions.DownloadAction

Throws:

java.lang.Exception