Package org.bedework.util.struts

Class ErrorEmitSvlt

java.lang.Object

org.bedework.util.struts.ErrorEmitSvlt

All Implemented Interfaces:

Serializable, org.bedework.util.logging.Logged, MessageEmit

Direct Known Subclasses:

MessageEmitSvlt

public class ErrorEmitSvlt
extends Object
implements MessageEmit

This class allows error message generation in the servlet world.

Version:

1.0

Author:

Mike Douglass douglm@rpi.edu

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ErrorEmitSvlt.Msg	We save the message property and the parameters in the following class which we can return as an alternative to the struts message generation.

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	caller
protected org.apache.struts.action.ActionErrors	errors
protected String	exceptionPname
protected String	id
protected org.apache.struts.util.MessageResources	messages
protected ArrayList<ErrorEmitSvlt.Msg>	msgList

Constructor Summary

Constructors

Constructor	Description
ErrorEmitSvlt()

Method Summary

Modifier and Type	Method	Description
protected String	className()
void	clear()	Indicate no messages emitted.
protected void	debugMsg(String pname, String ptype, String pval)
void	emit(String pname)
void	emit(String pname, int num)
void	emit(String pname, Object o)
void	emit(String pname, Object o1, Object o2)
void	emit(String pname, Object o1, Object o2, Object o3)
void	emit(Throwable t)
org.apache.struts.action.ActionErrors	getErrors()
org.bedework.util.logging.BwLogger	getLogger()
ArrayList<ErrorEmitSvlt.Msg>	getMsgList()
protected boolean	haveOutputObject()
boolean	messagesEmitted()
void	reinit(String id, Object caller, org.apache.struts.util.MessageResources messages, org.apache.struts.action.ActionErrors errors, String exceptionPname, boolean clear)	Generation of errors in the servlet world means adding them to the errors object.
void	setExceptionPname(String pname)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, warn

Field Detail

id

protected transient String id

caller

protected transient Object caller

messages

protected transient org.apache.struts.util.MessageResources messages

errors

protected transient org.apache.struts.action.ActionErrors errors

exceptionPname

protected transient String exceptionPname

msgList

protected ArrayList<ErrorEmitSvlt.Msg> msgList

Constructor Detail

ErrorEmitSvlt

public ErrorEmitSvlt()

Method Detail

reinit

public void reinit(String id,
                   Object caller,
                   org.apache.struts.util.MessageResources messages,
                   org.apache.struts.action.ActionErrors errors,
                   String exceptionPname,
                   boolean clear)

Generation of errors in the servlet world means adding them to the errors object. We need to call this routine on every entry to the application

Parameters:

id - An identifying name

caller - Used for log identification

messages - Resources

errors - Error message will be appended on failure.

exceptionPname - Property name for exceptions

clear - true to clear list

getMsgList

public ArrayList<ErrorEmitSvlt.Msg> getMsgList()

Returns:

msg list

emit

public void emit(String pname)

Specified by:

emit in interface MessageEmit

emit

public void emit(String pname,
                 int num)

Specified by:

emit in interface MessageEmit

setExceptionPname

public void setExceptionPname(String pname)

Specified by:

setExceptionPname in interface MessageEmit

emit

public void emit(Throwable t)

Specified by:

emit in interface MessageEmit

emit

public void emit(String pname,
                 Object o)

Specified by:

emit in interface MessageEmit

emit

public void emit(String pname,
                 Object o1,
                 Object o2)

Specified by:

emit in interface MessageEmit

emit

public void emit(String pname,
                 Object o1,
                 Object o2,
                 Object o3)

Specified by:

emit in interface MessageEmit

clear

public void clear()

Indicate no messages emitted. Null in this implementation.

Specified by:

clear in interface MessageEmit

messagesEmitted

public boolean messagesEmitted()

Specified by:

messagesEmitted in interface MessageEmit

Returns:

true if any messages emitted

getErrors

public org.apache.struts.action.ActionErrors getErrors()

Returns:

errors

haveOutputObject

protected boolean haveOutputObject()

className

protected String className()

debugMsg

protected void debugMsg(String pname,
                        String ptype,
                        String pval)

getLogger

public org.bedework.util.logging.BwLogger getLogger()

Specified by:

getLogger in interface org.bedework.util.logging.Logged