com.lf.commons.web

Interface AbstractMessage

All Known Implementing Classes:

AntMessage, DatabaseUpdate, DateMessage, ErrorMessage, License, MapMessage, ModelConfig, ParameterMessage, PingMessage, ReleaseNotes, StatusReport, UpdateMessage, XMLMessage

public interface AbstractMessage

Base class for any type of request message processed by responders.

Since:

1.6

Version:

$Revision: 1.8 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canProcess(java.io.InputStream istream) Checks whether the given input stream can be read/written by this message.
boolean	isArmed() Has the message successfully been loaded with payload?
boolean	isValid() Determines whether the message contents are valid and can be used.
boolean	read(java.io.InputStream istream) Reads the message contents from the given input stream.
boolean	write(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates response message data with the given servlet response.
boolean	write(java.io.OutputStream ostream, java.lang.String encoding) Generates response message data with the given output stream.

Method Detail

canProcess

boolean canProcess(java.io.InputStream istream)

Checks whether the given input stream can be read/written by this message.

Remember that the message class may read some data from the stream which has to be reset afterwards. So better use a BufferedInputStream and mark the position before this method is called. Reset the stream when the method has done its job to allow other messages to perform another lookahead properly.

Parameters:

istream - Input stream with incoming message

Returns:

Processing possible?

Throws:

java.lang.NullPointerException - Parameter was null

read

boolean read(java.io.InputStream istream)
             throws java.io.IOException

Reads the message contents from the given input stream.

Parameters:

istream - Input stream with incoming message

Returns:

Successful?

Throws:

java.io.IOException - An I/O error occurred

java.lang.NullPointerException - Parameter was null

write

boolean write(java.io.OutputStream ostream,
            java.lang.String encoding)
              throws java.io.IOException

Generates response message data with the given output stream.

Parameters:

ostream - Output stream for outgoing message

encoding - Encoding for stream, may be null

Returns:

Successful?

Throws:

java.io.IOException - An I/O error occurred

java.lang.NullPointerException - Parameter was null

write

boolean write(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
              throws java.io.IOException

Generates response message data with the given servlet response.

Parameters:

request - Servlet request with incoming message

response - Servlet response for outgoing message

Returns:

Successful?

Throws:

java.io.IOException - An I/O error occurred

java.lang.NullPointerException - Parameter was null

isArmed

boolean isArmed()

Has the message successfully been loaded with payload?

Returns:

Contents available?

isValid

boolean isValid()

Determines whether the message contents are valid and can be used.

Returns:

Contents valid?