intradoc.serialize
Class DataBinderSerializer

java.lang.Object
  |
  +--intradoc.serialize.DataBinderSerializer

All Implemented Interfaces:

DataSerialize

public class DataBinderSerializer

extends java.lang.Object

implements DataSerialize

Field Summary

protected DataBinderProtocolInterface	m_dataBinderProtocol
protected IsoJavaEncodingMap	m_encodingMap
protected boolean	m_failOnReplacementCharacter
protected boolean	m_isMultiMode
protected java.lang.String	m_systemEncoding
protected boolean	m_useClientEncoding
protected boolean	m_verboseEncodingTracing
protected java.lang.String	m_webEncoding

Constructor Summary

DataBinderSerializer()
Default constructor.

Method Summary

protected void	closeStream(java.io.OutputStream outStream)
void	continueParse(DataBinder data, ExecutionContext cxt)
java.lang.String	decode(DataBinder data, java.lang.String in, ExecutionContext cxt) Implements the DataDecode interface.
protected java.lang.String	decodeEx(DataBinder data, java.lang.String in)
java.lang.String	detectEncoding(DataBinder data, java.io.BufferedInputStream bstream, ExecutionContext cxt) Detects the encoding of the input stream.
int	determineContentType(DataBinder data, ExecutionContext cxt) Evaluates the contents of the environment variables of the DataBinder to determine the protocol to use when parsing the request body.
java.lang.String	determineEncoding(DataBinder data, ExecutionContext cxt) Determines which character encoding to be used.
protected void	determineParameterizedLocalization(DataBinder data, java.util.Vector rsetList)
java.lang.String	encode(DataBinder data, java.lang.String in, ExecutionContext cxt) Encodes a string using hda style encoding for a value.
protected java.lang.String	encodeEx(DataBinder data, java.lang.String in)
protected byte[]	getConvertedBytes(DataBinder data, java.lang.String in, java.lang.String encoding)
protected java.lang.String	getConvertedString(DataBinder data, byte[] byteArray, int offset, int length, java.lang.String encoding)
DataBinderProtocolInterface	getDataBinderProtocol()
java.lang.String	getIsoEncoding(java.lang.String javaEncoding)
java.lang.String	getJavaEncoding(java.lang.String isoEncoding)
java.lang.String	getSystemEncoding()
java.lang.String	getWebEncoding()
java.lang.String	getWebEncodingEx()
protected boolean	isClientEncoding(DataBinder data)
boolean	isMultiMode()
protected boolean	isRawData(DataBinder data)
java.lang.String	packageEncodingHeader(DataBinder data, ExecutionContext cxt) Formats encoding header if encoding is specified.
protected void	packageOptionList(DataBinder data, java.io.Writer writer, java.util.Vector options, java.lang.String name)
protected void	packageProperties(DataBinder data, java.io.Writer writer, java.util.Properties props, java.lang.String name)
protected void	packageResultSet(DataBinder data, java.io.Writer writer, ResultSet aSet, java.lang.String name)
protected java.lang.String	parseDataValue(DataBinder data, java.lang.String name)
protected java.lang.String	parseFile(DataBinder data, java.lang.String name, java.lang.String fileName)
protected java.lang.String	parseForData(DataBinder data)
int	parseFormat(DataBinder data, java.io.BufferedInputStream bis, ExecutionContext cxt)
java.lang.String	parseHdaEncoding(java.lang.String line) Detects the encoding of the hda header.
java.lang.String	parseHdaEncodingEx(DataBinder data, java.lang.String line) Detects the encoding of the hda header.
void	parseLocalParameters(DataBinder data, java.lang.String params, java.lang.String delimiter, ExecutionContext cxt)
protected void	parseLocalParametersEx(DataBinder data, java.lang.String params, java.lang.String delimiter, boolean allowRaw)
protected void	parseMultiContent(DataBinder data)
protected void	parseNameValue(DataBinder data, java.lang.String envPair, java.lang.String delimiter, boolean allowRaw)
protected void	parseOptionList(DataBinder data, java.lang.String name, java.io.Reader reader)
protected void	parsePost(DataBinder data, java.lang.String delimiter)
protected void	parseProperties(DataBinder data, java.lang.String name, java.io.BufferedReader reader)
protected void	parseReaderData(DataBinder data, java.io.BufferedReader reader, java.util.Vector rsetList, boolean isHeaderOnly)
void	parseRequest(DataBinder data, java.io.BufferedInputStream inStream, ExecutionContext cxt) Parse data received from a browser request (either a "GET", "POST", or "MULTIPART-POST").
void	parseRequestBody(DataBinder data, ExecutionContext cxt) Parses the data of a POST (or MULTIPART-POST) or URL parameters of a GET request.
protected DataResultSet	parseResultSet(DataBinder data, java.lang.String name, java.io.Reader reader, boolean isHeaderOnly)
protected void	prepareParseMultiContent(DataBinder data)
void	prepareParseRequest(DataBinder data, java.io.BufferedInputStream inStream, ExecutionContext cxt) Parses the CGI style environment variables at beginning of stream.
void	readFile(DataBinder data, java.lang.String originalFilePath, java.lang.String key)
protected java.lang.String	readInputLine(DataBinder data, boolean isBytes)
protected java.lang.String	readLine(java.io.BufferedReader reader)
int	readLineBytes(DataBinder data, byte[] inBytes, boolean doCount, int start, int length, int[] newOffset)
java.lang.String	readLineEx(DataBinder data, java.io.BufferedInputStream inStream, boolean doCount, boolean allowRaw, ExecutionContext cxt)
protected java.lang.String	readLineRaw(DataBinder data, java.io.BufferedInputStream inStream, boolean doCount)
protected void	readProperties(DataBinder data, java.util.Properties props, java.lang.String endMark, boolean isJava, boolean isBytes)
protected byte[]	readStreamLineByteEx(DataBinder data, java.io.BufferedInputStream inStream, boolean doCount)
protected java.lang.String	readStreamLineEx(DataBinder data, java.io.BufferedInputStream inStream, boolean doCount, ExecutionContext cxt)
void	receiveEx(DataBinder data, java.io.BufferedReader reader, boolean isHeaderOnly, ExecutionContext cxt) Parses a stream and loads it into attributes of this object.
void	resetMultiContentFlags(DataBinder data, ExecutionContext cxt)
protected void	resetMultiContentFlagsEx(DataBinder data)
protected void	retrieveExecutionContextInfo(DataBinder data, ExecutionContext cxt)
void	send(DataBinder data, java.io.Writer writer, ExecutionContext cxt) Writes out the header, local data, and result sets in hda format (see documentation on basic component architecture for a description of this format).
byte[]	sendBytes(DataBinder data, java.lang.String javaEncoding, boolean sendHeader, ExecutionContext cxt) Allows sending the response in bytes rather than as a string.
void	sendEx(DataBinder data, java.io.Writer writer, boolean sendHeader, ExecutionContext cxt) Writes out the local data and result sets in hda format (see documentation on basic component architecture for a description of this format).
protected void	sendResult(java.io.Writer writer, java.lang.String resultStr)
void	setDataBinderProtocol(DataBinderProtocolInterface dataBinderProtocol)
void	setEncodingMap(ResultSet rset)
void	setMultiMode(boolean flag)
void	setSystemEncoding(java.lang.String systemEncoding)
void	setUseClientEncoding(boolean flag)
void	setWebEncoding(java.lang.String newEncoding)
protected void	translateEnvironment(DataBinder data)
boolean	useClientEncoding()

Methods inherited from class java.lang.Object

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

Field Detail

m_encodingMap

protected IsoJavaEncodingMap m_encodingMap

m_systemEncoding

protected java.lang.String m_systemEncoding

m_webEncoding

protected java.lang.String m_webEncoding

m_isMultiMode

protected boolean m_isMultiMode

m_useClientEncoding

protected boolean m_useClientEncoding

m_verboseEncodingTracing

protected boolean m_verboseEncodingTracing

m_failOnReplacementCharacter

protected boolean m_failOnReplacementCharacter

m_dataBinderProtocol

protected DataBinderProtocolInterface m_dataBinderProtocol

Constructor Detail

DataBinderSerializer

public DataBinderSerializer()

Default constructor.

Method Detail

send

public void send(DataBinder data,
                 java.io.Writer writer,
                 ExecutionContext cxt)
          throws java.io.IOException

Writes out the header, local data, and result sets in hda format (see documentation on basic component architecture for a description of this format). If m_ioLocalOnly is true then the result sets are not written out.

java.io.IOException

sendEx

public void sendEx(DataBinder data,
                   java.io.Writer writer,
                   boolean sendHeader,
                   ExecutionContext cxt)
            throws java.io.IOException

Writes out the local data and result sets in hda format (see documentation on basic component architecture for a description of this format). If m_ioLocalOnly is true then the result sets are not written out. If sendHeader is true, hda header will be written before local data and result sets.

Specified by:

sendEx in interface DataSerialize

java.io.IOException

sendBytes

public byte[] sendBytes(DataBinder data,
                        java.lang.String javaEncoding,
                        boolean sendHeader,
                        ExecutionContext cxt)
                 throws java.io.IOException

Allows sending the response in bytes rather than as a string.

Specified by:

sendBytes in interface DataSerialize

java.io.IOException

sendResult

protected void sendResult(java.io.Writer writer,
                          java.lang.String resultStr)
                   throws java.io.IOException

java.io.IOException

packageProperties

protected void packageProperties(DataBinder data,
                                 java.io.Writer writer,
                                 java.util.Properties props,
                                 java.lang.String name)
                          throws java.io.IOException

java.io.IOException

packageResultSet

protected void packageResultSet(DataBinder data,
                                java.io.Writer writer,
                                ResultSet aSet,
                                java.lang.String name)
                         throws java.io.IOException

java.io.IOException

packageOptionList

protected void packageOptionList(DataBinder data,
                                 java.io.Writer writer,
                                 java.util.Vector options,
                                 java.lang.String name)
                          throws java.io.IOException

java.io.IOException

receiveEx

public void receiveEx(DataBinder data,
                      java.io.BufferedReader reader,
                      boolean isHeaderOnly,
                      ExecutionContext cxt)
               throws java.io.IOException

Parses a stream and loads it into attributes of this object. Previously loaded data is kept although it may be replaced by new data from the stream.

Specified by:

receiveEx in interface DataSerialize

Parameters:

reader - The stream being parsed. Note: this method assumes that 'reader' will provide a clean termination point for consumption. This method does not provide for partial reads based on expected response length or for issues such as persisting connections (i.e. keep alive logic). Such complex issues must be negotiated by the underlying input source (for example, the input stream from a response to an Http request using the java.net.HttpUrlConnection object has a built in termination point created from the Content-Length HTTP response header).

isHeaderOnly - If set to true, then only the local data and the field names of the first result set are read in. This allows sampling of a very large hda file.

Throws:

java.io.IOException - Thrown if there is an error reading from the stream.

DataException - Thrown if there is a data integrity error.

See Also:

#m_isCgi, parseRequest(intradoc.data.DataBinder, java.io.BufferedInputStream, intradoc.common.ExecutionContext), #receive, send(intradoc.data.DataBinder, java.io.Writer, intradoc.common.ExecutionContext)

parseReaderData

protected void parseReaderData(DataBinder data,
                               java.io.BufferedReader reader,
                               java.util.Vector rsetList,
                               boolean isHeaderOnly)
                        throws java.io.IOException

java.io.IOException

determineParameterizedLocalization

protected void determineParameterizedLocalization(DataBinder data,
                                                  java.util.Vector rsetList)
                                           throws java.io.IOException

java.io.IOException

parseOptionList

protected void parseOptionList(DataBinder data,
                               java.lang.String name,
                               java.io.Reader reader)
                        throws java.io.IOException

java.io.IOException

parseResultSet

protected DataResultSet parseResultSet(DataBinder data,
                                       java.lang.String name,
                                       java.io.Reader reader,
                                       boolean isHeaderOnly)
                                throws java.io.IOException

java.io.IOException

parseProperties

protected void parseProperties(DataBinder data,
                               java.lang.String name,
                               java.io.BufferedReader reader)
                        throws java.io.IOException

java.io.IOException

readProperties

protected void readProperties(DataBinder data,
                              java.util.Properties props,
                              java.lang.String endMark,
                              boolean isJava,
                              boolean isBytes)
                       throws java.io.IOException

java.io.IOException

decode

public java.lang.String decode(DataBinder data,
                               java.lang.String in,
                               ExecutionContext cxt)

Implements the DataDecode interface. Used to control how to decode data as its being parsed and stored into attributes.

Specified by:

decode in interface DataSerialize

Parameters:

in - The string to decode.

Returns:

The decoded version of the string.

See Also:

DataDecode, encode(intradoc.data.DataBinder, java.lang.String, intradoc.common.ExecutionContext), #m_isCgi

decodeEx

protected java.lang.String decodeEx(DataBinder data,
                                    java.lang.String in)

encode

public java.lang.String encode(DataBinder data,
                               java.lang.String in,
                               ExecutionContext cxt)

Encodes a string using hda style encoding for a value. That is, it uses the following translations:

\ -> \\

cr -> \r

lf -> \n

@ -> \@

Specified by:

encode in interface DataSerialize

Parameters:

in - The string to encode.

Returns:

The encoded string.

See Also:

decode(intradoc.data.DataBinder, java.lang.String, intradoc.common.ExecutionContext)

encodeEx

protected java.lang.String encodeEx(DataBinder data,
                                    java.lang.String in)

getConvertedBytes

protected byte[] getConvertedBytes(DataBinder data,
                                   java.lang.String in,
                                   java.lang.String encoding)
                            throws java.io.IOException

java.io.IOException

getConvertedString

protected java.lang.String getConvertedString(DataBinder data,
                                              byte[] byteArray,
                                              int offset,
                                              int length,
                                              java.lang.String encoding)
                                       throws java.io.IOException

java.io.IOException

isRawData

protected boolean isRawData(DataBinder data)

isClientEncoding

protected boolean isClientEncoding(DataBinder data)

parseRequest

public void parseRequest(DataBinder data,
                         java.io.BufferedInputStream inStream,
                         ExecutionContext cxt)
                  throws java.io.IOException,
                         DataException

Parse data received from a browser request (either a "GET", "POST", or "MULTIPART-POST"). Note that stream being parsed is not being interpreted by a Reader object. This allows us to parse binary files in the content when the browser is performing a file upload post.

Specified by:

parseRequest in interface DataSerialize

Parameters:

inStream - The stream containing data from the browser. This method calls the methods prepareParseRequest and parseRequestBody to do the actual parsing.

Throws:

java.io.IOException - Thrown if there is an error reading from the stream.

DataException - Thrown if there is a data integrity error.

See Also:

prepareParseRequest(intradoc.data.DataBinder, java.io.BufferedInputStream, intradoc.common.ExecutionContext), parseRequestBody(intradoc.data.DataBinder, intradoc.common.ExecutionContext)

prepareParseRequest

public void prepareParseRequest(DataBinder data,
                                java.io.BufferedInputStream inStream,
                                ExecutionContext cxt)
                         throws java.io.IOException,
                                DataException

Parses the CGI style environment variables at beginning of stream.

Specified by:

prepareParseRequest in interface DataSerialize

Parameters:

inStream - The stream containing data from the browser. Before the data from the browser is sent to the Content Server, the web server prepends the CGI environment variables as name value pairs terminated by a "$$$$" on a single line. This method parses out the CGI environment variables storing it into the environment data of this object. If browser request is a "POST" initiated by an applet, then the data following the "POST" name value pairs is assumed to be data in hda style format and is parsed using the 'receive(...)' method with 'm_isCgi' set to false.

Throws:

java.io.IOException - Thrown if there is an error reading from the stream.

DataException - Thrown if there is a data integrity error.

parseRequestBody

public void parseRequestBody(DataBinder data,
                             ExecutionContext cxt)
                      throws java.io.IOException,
                             DataException

Parses the data of a POST (or MULTIPART-POST) or URL parameters of a GET request. The input stream has already been set by a previous method (such as prepareParseRequest).

Specified by:

parseRequestBody in interface DataSerialize

Throws:

java.io.IOException - Thrown if there is an error reading from the stream.

DataException - Thrown if there is a data integrity error.

See Also:

#receive, decode(intradoc.data.DataBinder, java.lang.String, intradoc.common.ExecutionContext)

determineContentType

public int determineContentType(DataBinder data,
                                ExecutionContext cxt)
                         throws DataException

Evaluates the contents of the environment variables of the DataBinder to determine the protocol to use when parsing the request body.

Specified by:

determineContentType in interface DataSerialize

Returns:

Whether the content is multipart. Values are one of CONTENT_ERROR, URLENCODED_CONTENT, or MULTIPART_CONTENT. Note: URLENCODED_CONTENT handles both the GET and POST case. This method also determines if the flag m_isJava should be set to true. If it is then the POST data is assumed to be in standard encoded 'hda' style format (instead of CGI HTML form post format).

Throws:

DataException - Thrown if wrong semantics were used to specify content type.

See Also:

parseRequestBody(intradoc.data.DataBinder, intradoc.common.ExecutionContext)

resetMultiContentFlags

public void resetMultiContentFlags(DataBinder data,
                                   ExecutionContext cxt)

Specified by:

resetMultiContentFlags in interface DataSerialize

resetMultiContentFlagsEx

protected void resetMultiContentFlagsEx(DataBinder data)

continueParse

public void continueParse(DataBinder data,
                          ExecutionContext cxt)
                   throws java.io.IOException,
                          DataException

Specified by:

continueParse in interface DataSerialize

java.io.IOException

DataException

prepareParseMultiContent

protected void prepareParseMultiContent(DataBinder data)
                                 throws java.io.IOException,
                                        DataException

java.io.IOException

DataException

parseMultiContent

protected void parseMultiContent(DataBinder data)
                          throws java.io.IOException,
                                 DataException

java.io.IOException

DataException

parseForData

protected java.lang.String parseForData(DataBinder data)
                                 throws java.io.IOException,
                                        DataException

java.io.IOException

DataException

parseDataValue

protected java.lang.String parseDataValue(DataBinder data,
                                          java.lang.String name)
                                   throws java.io.IOException

java.io.IOException

readLine

protected java.lang.String readLine(java.io.BufferedReader reader)
                             throws java.io.IOException

java.io.IOException

readInputLine

protected java.lang.String readInputLine(DataBinder data,
                                         boolean isBytes)
                                  throws java.io.IOException

java.io.IOException

readLineBytes

public int readLineBytes(DataBinder data,
                         byte[] inBytes,
                         boolean doCount,
                         int start,
                         int length,
                         int[] newOffset)

readLineEx

public java.lang.String readLineEx(DataBinder data,
                                   java.io.BufferedInputStream inStream,
                                   boolean doCount,
                                   boolean allowRaw,
                                   ExecutionContext cxt)
                            throws java.io.IOException

Specified by:

readLineEx in interface DataSerialize

java.io.IOException

readLineRaw

protected java.lang.String readLineRaw(DataBinder data,
                                       java.io.BufferedInputStream inStream,
                                       boolean doCount)
                                throws java.io.IOException

java.io.IOException

readStreamLineEx

protected java.lang.String readStreamLineEx(DataBinder data,
                                            java.io.BufferedInputStream inStream,
                                            boolean doCount,
                                            ExecutionContext cxt)
                                     throws java.io.IOException

java.io.IOException

readStreamLineByteEx

protected byte[] readStreamLineByteEx(DataBinder data,
                                      java.io.BufferedInputStream inStream,
                                      boolean doCount)
                               throws java.io.IOException

java.io.IOException

translateEnvironment

protected void translateEnvironment(DataBinder data)
                             throws java.io.IOException

java.io.IOException

parsePost

protected void parsePost(DataBinder data,
                         java.lang.String delimiter)
                  throws java.io.IOException,
                         DataException,
                         java.io.UnsupportedEncodingException

java.io.IOException

DataException

java.io.UnsupportedEncodingException

parseLocalParameters

public void parseLocalParameters(DataBinder data,
                                 java.lang.String params,
                                 java.lang.String delimiter,
                                 ExecutionContext cxt)

Specified by:

parseLocalParameters in interface DataSerialize

parseLocalParametersEx

protected void parseLocalParametersEx(DataBinder data,
                                      java.lang.String params,
                                      java.lang.String delimiter,
                                      boolean allowRaw)

parseNameValue

protected void parseNameValue(DataBinder data,
                              java.lang.String envPair,
                              java.lang.String delimiter,
                              boolean allowRaw)

parseFormat

public int parseFormat(DataBinder data,
                       java.io.BufferedInputStream bis,
                       ExecutionContext cxt)
                throws ServiceException

ServiceException

parseFile

protected java.lang.String parseFile(DataBinder data,
                                     java.lang.String name,
                                     java.lang.String fileName)
                              throws java.io.IOException,
                                     DataException

java.io.IOException

DataException

readFile

public void readFile(DataBinder data,
                     java.lang.String originalFilePath,
                     java.lang.String key)
              throws java.io.IOException,
                     DataException

java.io.IOException

DataException

closeStream

protected void closeStream(java.io.OutputStream outStream)

detectEncoding

public java.lang.String detectEncoding(DataBinder data,
                                       java.io.BufferedInputStream bstream,
                                       ExecutionContext cxt)
                                throws java.io.IOException

Detects the encoding of the input stream. It reads in the first line and it attemps to determine the encoding. Stream must have format. jcharset must be a Java encoding and encoding must be a ISO encoding.

Specified by:

detectEncoding in interface DataSerialize

java.io.IOException

parseHdaEncodingEx

public java.lang.String parseHdaEncodingEx(DataBinder data,
                                           java.lang.String line)

Detects the encoding of the hda header. The line must have format. jcharset must be a Java encoding and encoding must be a ISO encoding. Escape can be defined in hda header to indicate use of url encoding (i.e. escape=url).

Specified by:

parseHdaEncodingEx in interface DataSerialize

parseHdaEncoding

public java.lang.String parseHdaEncoding(java.lang.String line)

Detects the encoding of the hda header. The line must have format. jcharset must be a Java encoding and encoding must be a ISO encoding.

Specified by:

parseHdaEncoding in interface DataSerialize

packageEncodingHeader

public java.lang.String packageEncodingHeader(DataBinder data,
                                              ExecutionContext cxt)
                                       throws java.io.IOException

Formats encoding header if encoding is specified.

Specified by:

packageEncodingHeader in interface DataSerialize

java.io.IOException

determineEncoding

public java.lang.String determineEncoding(DataBinder data,
                                          ExecutionContext cxt)

Determines which character encoding to be used. 1. ClientEncoding will be used if it is specified. ClientEncoding will be used for multi mode or for requests received by the application agent 2. m_javaEncoding will be used if ClientEncoding is not specified. 3. SystemEncoding will be used if m_javaEncoding or ClientEncoding is not specified.

Specified by:

determineEncoding in interface DataSerialize

retrieveExecutionContextInfo

protected void retrieveExecutionContextInfo(DataBinder data,
                                            ExecutionContext cxt)

setEncodingMap

public void setEncodingMap(ResultSet rset)
                    throws DataException

Specified by:

setEncodingMap in interface DataSerialize

DataException

getIsoEncoding

public java.lang.String getIsoEncoding(java.lang.String javaEncoding)

Specified by:

getIsoEncoding in interface DataSerialize

getJavaEncoding

public java.lang.String getJavaEncoding(java.lang.String isoEncoding)

Specified by:

getJavaEncoding in interface DataSerialize

setMultiMode

public void setMultiMode(boolean flag)

Specified by:

setMultiMode in interface DataSerialize

isMultiMode

public boolean isMultiMode()

Specified by:

isMultiMode in interface DataSerialize

setUseClientEncoding

public void setUseClientEncoding(boolean flag)

Specified by:

setUseClientEncoding in interface DataSerialize

useClientEncoding

public boolean useClientEncoding()

Specified by:

useClientEncoding in interface DataSerialize

getSystemEncoding

public java.lang.String getSystemEncoding()

Specified by:

getSystemEncoding in interface DataSerialize

setSystemEncoding

public void setSystemEncoding(java.lang.String systemEncoding)

Specified by:

setSystemEncoding in interface DataSerialize

getWebEncoding

public java.lang.String getWebEncoding()

Specified by:

getWebEncoding in interface DataSerialize

getWebEncodingEx

public java.lang.String getWebEncodingEx()

setWebEncoding

public void setWebEncoding(java.lang.String newEncoding)

Specified by:

setWebEncoding in interface DataSerialize

setDataBinderProtocol

public void setDataBinderProtocol(DataBinderProtocolInterface dataBinderProtocol)

Specified by:

setDataBinderProtocol in interface DataSerialize

getDataBinderProtocol

public DataBinderProtocolInterface getDataBinderProtocol()

Specified by:

getDataBinderProtocol in interface DataSerialize