org.javaWebGen
Class WebSession

java.lang.Object
  org.javaWebGen.WebSession

All Implemented Interfaces:

java.io.Serializable

public class WebSession
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

WebSession()

Method Summary

void	clearError() clear error status
java.lang.String	getError() get error message that was set
java.lang.Exception	getException() get the exception that caused the error
java.lang.String	getFormattedMessage(java.lang.String key, java.lang.Object[] parms) return a message from message file by key
java.lang.String	getImage()
java.lang.String	getInclude()
LoginBean	getLogin()
java.lang.String	getMessage(java.lang.String key) return a message from message file by key
java.lang.String	getMessage(java.lang.String key, java.lang.String defaultText) return a message from message file by key
java.lang.String	getStyle()
java.lang.String	getTheme()
java.lang.String	getWebRoot()
boolean	hasError() has an error been generated?
java.lang.String	images()
void	setError(java.lang.String error) set an error message generally this is done only by a controller
void	setError(java.lang.String error, java.lang.Exception e) set an error message generally this is done only by a controller
void	setException(java.lang.Exception e)
protected void	setLogin(LoginBean bean)
void	setTheme(java.lang.String newTheme)
void	setWebRoot(java.lang.String url) set web root url
java.lang.String	stylesheet()
java.lang.String	toXml() make xml string of current web session mainly useful for debugging
java.lang.String	webRoot()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSession

public WebSession()

Method Detail

getImage

public java.lang.String getImage()

Returns:

image uri

images

public java.lang.String images()

Returns:

image uri

getStyle

public java.lang.String getStyle()

Returns:

stylesheet uri

stylesheet

public java.lang.String stylesheet()

Returns:

stylesheet uri

getInclude

public java.lang.String getInclude()

Returns:

include uri

getTheme

public java.lang.String getTheme()

Returns:

theme name

setTheme

public void setTheme(java.lang.String newTheme)

Parameters:

newTheme - new theme name

getWebRoot

public java.lang.String getWebRoot()

Returns:

webroot url

webRoot

public java.lang.String webRoot()

Returns:

webroot url

setWebRoot

public void setWebRoot(java.lang.String url)

set web root url

Parameters:

url -

hasError

public boolean hasError()

has an error been generated?

Returns:

true if error status has been set

getError

public java.lang.String getError()

get error message that was set

Returns:

error message

getException

public java.lang.Exception getException()

get the exception that caused the error

Returns:

exception that caused the error

setError

public void setError(java.lang.String error)

set an error message generally this is done only by a controller

Parameters:

error -

setError

public void setError(java.lang.String error,
                     java.lang.Exception e)

set an error message generally this is done only by a controller

Parameters:

error -

e - exception

setException

public void setException(java.lang.Exception e)

Parameters:

e - exception

clearError

public void clearError()

clear error status

getMessage

public java.lang.String getMessage(java.lang.String key)

return a message from message file by key

Parameters:

key -

Returns:

message based on local

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.String defaultText)

return a message from message file by key

Parameters:

key -

defaultText - text if key is not found

Returns:

message based on current local

getFormattedMessage

public java.lang.String getFormattedMessage(java.lang.String key,
                                            java.lang.Object[] parms)

return a message from message file by key

Parameters:

key -

parms - parameters to pass in @see MessageFormat

Returns:

message based on current local

getLogin

public LoginBean getLogin()

setLogin

protected void setLogin(LoginBean bean)

toXml

public java.lang.String toXml()

make xml string of current web session mainly useful for debugging

Returns:

xml