com.knowgate.stripes

Class BaseStripesBean

java.lang.Object

com.knowgate.stripes.BaseStripesBean

All Implemented Interfaces:

net.sourceforge.stripes.action.ActionBean

Direct Known Subclasses:

BaseAjaxBean

public abstract class BaseStripesBean
extends Object
implements net.sourceforge.stripes.action.ActionBean

Base class for beans serving a response to be used as HTML page data

Version:

1.0

Author:

Sergio Montoro Ten

See Also:

Stripes

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BUNDLE
static String	DEFAULT_RESOURCE_BASE

Constructor Summary

Constructors

Constructor and Description
BaseStripesBean() Create action bean with resource base path /WEB-INF/classes/ and resource bundle prefix StripesResources
BaseStripesBean(String resourceBasepath, String resourceBundleName) Create action bean

Method Summary

Modifier and Type	Method and Description
String	errorsToXML(Collection<net.sourceforge.stripes.validation.SimpleError> errors) Get error collection as XML String like:
net.sourceforge.stripes.action.ActionBeanContext	getContext()
String	getCookie(String cookieName) Get value of cookie from HttpServletRequest
String	getLastUrl() Concatenate attributes javax.servlet.forward.request_uri and javax.servlet.forward.path_info, then append parameter key=value pairs.
String	getPageName() Call HttpServletRequest.getServletPath() and return the substring after the last slash / and before the first hash # after the slash (if present).
String	getParam(String paramName) Get parameter value from HttpServletRequest
String	getParam(String paramName, String defaultValue) Get parameter value from HttpServletRequest with default value
String	getResource(String key, String... params) Get string resource from the associated ResourceBundle and replace {n} parameter with given values.
StringBuffer	getResourceAsStringBuffer(String fileName) Call ServletContect.getResourceAsStream() and convert the returned InputStream into a StringBuffer.
StringBuffer	getResourceAsStringBuffer(String fileName, String language) Get localized resource file as StringBuffer.
abstract String	getSessionToken() Get session token
void	setContext(net.sourceforge.stripes.action.ActionBeanContext actionBeanContext)
void	setCookie(String cookieName, String cookieValue) Set value of cookie.
void	setParam(String sParamName, String sParamValue) Set parameter value at FlashScope

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESOURCE_BASE

public static final String DEFAULT_RESOURCE_BASE

See Also:

Constant Field Values

DEFAULT_BUNDLE

public static final String DEFAULT_BUNDLE

See Also:

Constant Field Values

Constructor Detail

BaseStripesBean

public BaseStripesBean()

Create action bean with resource base path /WEB-INF/classes/ and resource bundle prefix StripesResources

BaseStripesBean

public BaseStripesBean(String resourceBasepath,
                       String resourceBundleName)

Create action bean

Parameters:

resourceBasepath - String resource base path

resourceBundleName - String resource bundle prefix

Method Detail

getContext

public net.sourceforge.stripes.action.ActionBeanContext getContext()

Specified by:

getContext in interface net.sourceforge.stripes.action.ActionBean

Returns:

ActionBeanContext

setContext

public void setContext(net.sourceforge.stripes.action.ActionBeanContext actionBeanContext)

Specified by:

setContext in interface net.sourceforge.stripes.action.ActionBean

Parameters:

actionBeanContext -

getPageName

public String getPageName()

Call HttpServletRequest.getServletPath() and return the substring after the last slash / and before the first hash # after the slash (if present).

Returns:

String

getResource

public String getResource(String key,
                          String... params)

Get string resource from the associated ResourceBundle and replace {n} parameter with given values.

Parameters must be numbered starting with 1. So at the resource bundle the resource will look like:

key=Phrase with parameter {1} and {2}

Parameters:

key - String Resource name

params - String[] Parameter values

Returns:

String

getResourceAsStringBuffer

public StringBuffer getResourceAsStringBuffer(String fileName)
                                       throws FileNotFoundException,
                                              IOException

Call ServletContect.getResourceAsStream() and convert the returned InputStream into a StringBuffer.

Parameters:

fileName - String Name of resource file to be read.

Returns:

StringBuffer

Throws:

FileNotFoundException

IOException

getResourceAsStringBuffer

public StringBuffer getResourceAsStringBuffer(String fileName,
                                              String language)
                                       throws FileNotFoundException,
                                              IOException

Get localized resource file as StringBuffer.

Parameters:

fileName - String Prefix of of resource file to be read.

language - String Language code. It is expected to be appended after the file name with an underscore like "fileName_es" or "fileName_fr"

Returns:

StringBuffer

Throws:

FileNotFoundException

IOException

getCookie

public String getCookie(String cookieName)

Get value of cookie from HttpServletRequest

Cookie value must be ISO8859_1 encoded.

Parameters:

cookieName - String

Returns:

String

setCookie

public void setCookie(String cookieName,
                      String cookieValue)

Set value of cookie. The supplied string value will be ISO8859_1 encoded.

Parameters:

cookieName - String

cookieValue - String

getParam

public String getParam(String paramName)

Get parameter value from HttpServletRequest

Parameters:

paramName - String Parameter name

Returns:

String

getParam

public String getParam(String paramName,
                       String defaultValue)

Get parameter value from HttpServletRequest with default value

Parameters:

paramName - String Parameter name

defaultValue - String Default value

Returns:

String

setParam

public void setParam(String sParamName,
                     String sParamValue)

Set parameter value at FlashScope

Parameters:

sParamName - String Parameter name

sParamValue - String Parameter value

getSessionToken

public abstract String getSessionToken()

Get session token

Returns:

String or null if there is no active session.

getLastUrl

public String getLastUrl()

Concatenate attributes javax.servlet.forward.request_uri and javax.servlet.forward.path_info, then append parameter key=value pairs.

Returns:

String request_uri + path_info + ? param1=value1 & param1=value1 …

errorsToXML

public String errorsToXML(Collection<net.sourceforge.stripes.validation.SimpleError> errors)

Get error collection as XML String like:

<errors count="1"/> <error field=\"field_name">Error Message</error> </errors>

Parameters:

errors - Collection<SimpleError>

Returns:

String