Package com.arbortext.e3

Interface E3Response

All Superinterfaces:

E3RequestResponse

public interface E3Response
extends E3RequestResponse

Represents the non-body part of an HTTP response for use by the PE Request Manager.

This is a "new style" response object: the response data is in an XML document in the transaction directory, the body is in a parallel file in the same directory.

Field Summary

Fields inherited from interface com.arbortext.e3.E3RequestResponse

STATE_FILE, STATE_FILE_DELETE, STATE_MAXIMUM, STATE_MINIMUM, STATE_PAGE, STATE_REDIRECT, STATE_SC, STATE_SC_MSG

Method Summary

Modifier and Type	Method	Description
Element	createSubtree(Document doc, Element top)	Constructs a DOM document or subdocument describing this response.
String	getErrorMessage()	Returns the error message string.
String	getRedirectTarget()	Returns the redirect target string.
long	getRedirectTransactionId()	Returns the redirect body file string.
void	saveXmlFile(File target)	Writes this object to disk as an XML document.
void	setRedirectTransactionId(long redirectTransactionId)	Store redirect transaction id.

Methods inherited from interface com.arbortext.e3.E3RequestResponse

addDateHeader, addHeader, addIntHeader, containsHeader, getAlternateArchiveFlag, getArchiveFlag, getCharacterEncoding, getCode, getHeaderNames, getHeaderValues, getLocale, getOutputFile, getRecycleSubprocessFlag, getState, getString, hasFileResult, hasStringResult, reset, sendError, sendError, sendRedirect, setAlternateArchiveFlag, setArchiveFlag, setContentLength, setContentType, setDateHeader, setHeader, setIntHeader, setLocale, setOutputFile, setOutputPage, setOutputPath, setRecycleSubprocessFlag, setStatus

Method Details

createSubtree

Element createSubtree(Document doc,
 Element top)

Constructs a DOM document or subdocument describing this response.

Parameters:

doc - document which will contain subtree

top - top-level container (null to create)

Returns:

top of container; this will be 'top' or the element we create.

getErrorMessage

String getErrorMessage()

Returns the error message string.

Returns:

String error message or null.

saveXmlFile

void saveXmlFile(File target)
          throws Exception

Writes this object to disk as an XML document.

Parameters:

target - file to write to

Throws:

IOException - upon I/O error

Exception

getRedirectTarget

String getRedirectTarget()

Returns the redirect target string.

Returns:

String target or null if this response does not represent a redirect.

getRedirectTransactionId

long getRedirectTransactionId()

Returns the redirect body file string.

Returns:

int redirection transaction id. If there is no transaction id, return negative value.

setRedirectTransactionId

void setRedirectTransactionId(long redirectTransactionId)

Store redirect transaction id. Only when the response uses the redirect one that we need to use the method.