wt.httpgw
Class HTTPRequestImpl

java.lang.Object
  wt.httpgw.HTTPRequest
      wt.httpgw.HTTPRequestImpl

All Implemented Interfaces:

Externalizable, Serializable, CGIConstants

public class HTTPRequestImpl
extends HTTPRequest
implements Externalizable

This class is a carrier of HTTP request information to a Windchill method server. It uses customized serialization code to stream request bodies to the server. Instances contain information about the request (I.e. CGI environment values) and an input stream reference.

Client-side Serialization The client (HTTP gateway) constructs request objects to carry request information to a method server. The client stores the available HTTP request information in the object and sets the input stream reference to the actual HTTP request's input stream provided by the Web server.

Serialization of the object sends the request information followed by the content of the input stream. The content is forwarded by reading blocks of data from the input stream and writing them to the marshal stream until the entire body has been sent. The length of the body is determined from the content-length HTTP header. If no content-length is specified, it reads until EOF on the input stream.

Server-side Deserialization The server (Windchill method server) receives the request object as an argument to an RMI call. It is deserialized before the target method is invoked. The deserialization code stores a reference to the RMI marshal stream in the object and directly dispatches the target method (HTTPServer.processRequest) prematurely. The body of the request is then available as an input stream to the dispatched method. The RMI marshal stream is simply being used as a pipe to connect the input stream provided to the HTTP gateway by the Web server to an input stream in the Windchill method server.

Supported API: true
Extendable: false

See Also:

Serialized Form

Method Summary

String	getBaseURL() Deprecated. Use URLFactory
String	getEncoding() Guess user agent's file encoding from request headers.
Properties	getFormData() Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data.
Properties	getFormData(String encoding) Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data.
Hashtable	getFormDataMultivalue() Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data.
Hashtable	getFormDataMultivalue(String encoding) Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data.
String	getFullURL() Deprecated. Use URLFactory
String	getMultiPartBoundary(String ContentType) Utility routine to parse out the multipart object-body boundary Supported API: true
String	getProperty(String key) Public getter method for access to CGI data.
String	getProperty(String key, String default_value) Public getter method for access to CGI data.
Enumeration	getPropertyKeys() Public getter method for access to CGI data keys.
String	getQueryString() Gets the URLs query string in decoded format.
String	getQueryString(String encoding) Gets the URLs query string in decoded format.
boolean	isGetRequest() Determine if the REQUEST_METHOD used to send the data from the browser was the GET method.
boolean	isPostRequest() Determine if the REQUEST_METHOD used to send the data from the browser was the POST method.
boolean	isUrlencodedContent() Determine if the CONTENT_TYPE used to send the data from the browser was urlencoded form data.
PrintWriter	newPrintWriter(OutputStream output_stream) Utility routine to construct a buffered PrintWriter from an OutputStream.
void	setFormData(Properties p) Sets the FORM data from a saved session.
void	setProperty(String key, String value) Public setter method for CGI data.
Properties	splitQueryString() Splits the URLs query string into name value pairs based on the ampersand and equal character tokens.
Hashtable	splitQueryStringMultivalue() Splits the URLs query string into name value pairs based on the ampersand and equal character tokens.

Methods inherited from class wt.httpgw.HTTPRequest

splitQueryString, splitQueryString, splitQueryStringMultivalue, splitQueryStringMultivalue

Methods inherited from class java.lang.Object

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

Method Detail

getFormData

public Properties getFormData()

Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data. If the input stream is null, it will read FORM data from the header query string. All hex escaped characters are decoded, then the sequence of 8-bit values is converted to characters using the character encoding returned by getEncoding.

Supported API: true

Specified by:

getFormData in class HTTPRequest

Returns:

Properties the form data as name value pairs.

getFormData

public Properties getFormData(String encoding)

Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data. If the input stream is null, it will read FORM data from the header query string. All hex escaped characters are decoded, then the sequence of 8-bit values is converted to characters using the given character encoding.

Supported API: true

Specified by:

getFormData in class HTTPRequest

Returns:

Properties the form data as name value pairs.

setFormData

public void setFormData(Properties p)

Sets the FORM data from a saved session.

Supported API: true

Specified by:

setFormData in class HTTPRequest

getFormDataMultivalue

public Hashtable getFormDataMultivalue()

Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data. If the input stream is null, it will read FORM data from the header query string. All hex escaped characters are decoded, then the sequence of 8-bit values is converted to characters using the character encoding returned by getEncoding. Multivalue fields are stored in a Vector which can be iterated for the individual values.

Supported API: true

Specified by:

getFormDataMultivalue in class HTTPRequest

Returns:

Properties the form data as name value pairs.

getFormDataMultivalue

public Hashtable getFormDataMultivalue(String encoding)

Retrieves the FORM data from the incoming input stream as x-www-form-urlencoded data. If the input stream is null, it will read FORM data from the header query string. All hex escaped characters are decoded, then the sequence of 8-bit values is converted to characters using the given character encoding. Multivalue fields are stored in a Vector which can be iterated for the individual values.

Supported API: true

Specified by:

getFormDataMultivalue in class HTTPRequest

Returns:

Properties the form data as name value pairs.

getQueryString

public String getQueryString()

Gets the URLs query string in decoded format. All hex escaped characters are decoded. The sequence of 8-bit values is then converted to characters using UTF8 encoding.

Supported API: true

Specified by:

getQueryString in class HTTPRequest

Returns:

String the decoded query string.

getQueryString

public String getQueryString(String encoding)

Gets the URLs query string in decoded format. All hex escaped characters are decoded. The sequence of 8-bit values is then converted to characters using the given character encoding.

Supported API: true

Specified by:

getQueryString in class HTTPRequest

Returns:

String the decoded query string.

splitQueryString

public Properties splitQueryString()

Splits the URLs query string into name value pairs based on the ampersand and equal character tokens. The returned properties are URL decoded and then converted to characters using UTF8 encoding.

Supported API: true

Specified by:

splitQueryString in class HTTPRequest

Returns:

Properties the query string info as name value pairs.

splitQueryStringMultivalue

public Hashtable splitQueryStringMultivalue()

Splits the URLs query string into name value pairs based on the ampersand and equal character tokens. The returned properties are URL decoded and then converted to characters using UTF8 encoding.

Supported API: true

Specified by:

splitQueryStringMultivalue in class HTTPRequest

Returns:

Properties the query string info as name value pairs.

isGetRequest

public boolean isGetRequest()

Determine if the REQUEST_METHOD used to send the data from the browser was the GET method.

Supported API: true

Specified by:

isGetRequest in class HTTPRequest

Returns:

true, if the REQUEST_METHOD was GET. false, otherwise.

isPostRequest

public boolean isPostRequest()

Determine if the REQUEST_METHOD used to send the data from the browser was the POST method.

Supported API: true

Specified by:

isPostRequest in class HTTPRequest

Returns:

true, if the REQUEST_METHOD was POST. false, otherwise.

isUrlencodedContent

public boolean isUrlencodedContent()

Determine if the CONTENT_TYPE used to send the data from the browser was urlencoded form data.

Supported API: true

Specified by:

isUrlencodedContent in class HTTPRequest

Returns:

true, if the CONTENT_TYPE was urlencoded form data. false, otherwise.

getBaseURL

public String getBaseURL()

Deprecated. Use URLFactory

Determine the Base URL of this script. (Does not include the QUERY_STRING (if any) or PATH_INFO (if any).

Supported API: true

Specified by:

getBaseURL in class HTTPRequest

Returns:

The Base URL of this script as a String.

getFullURL

public String getFullURL()

Deprecated. Use URLFactory

Determine the Full URL of this script. (Includes the QUERY_STRING (if any) or PATH_INFO (if any).

Supported API: true

Specified by:

getFullURL in class HTTPRequest

Returns:

The Full URL of this script as a String.

getProperty

public String getProperty(String key)

Public getter method for access to CGI data.

Supported API: true

Specified by:

getProperty in class HTTPRequest

Parameters:

String - the key of interest

Returns:

String the value

getPropertyKeys

public Enumeration getPropertyKeys()

Public getter method for access to CGI data keys.

Supported API: true

Specified by:

getPropertyKeys in class HTTPRequest

Returns:

Enumeration of the keys

getProperty

public String getProperty(String key,
                          String default_value)

Public getter method for access to CGI data. If not set, default value is returned.

Supported API: true

Specified by:

getProperty in class HTTPRequest

Parameters:

String - the key of interest

String - the default value to return

Returns:

String the value

setProperty

public void setProperty(String key,
                        String value)

Public setter method for CGI data.

Supported API: true

Specified by:

setProperty in class HTTPRequest

Parameters:

String - the key of interest

String - the value

getEncoding

public String getEncoding()

Guess user agent's file encoding from request headers. If Accept-Charset is specified, use the first value and apply a mapping of IANA names to Java encoding names. Mapping can be controlled at runtime with properties of the form wt.httpgw.encoding.xxx=yyy where xxx is the lower case IANA encoding name and yyy is the Java encoding name. If no Accept-Charset header is present, use template encoding rules to guess.

Supported API: true

Specified by:

getEncoding in class HTTPRequest

Returns:

String the encoding name

newPrintWriter

public PrintWriter newPrintWriter(OutputStream output_stream)

Utility routine to construct a buffered PrintWriter from an OutputStream.

Supported API: true

Specified by:

newPrintWriter in class HTTPRequest

Parameters:

output_stream - OutputStream to be wrapped

Returns:

A buffered PrintWriter constructed around the given OutPutStream.

getMultiPartBoundary

public String getMultiPartBoundary(String ContentType)

Utility routine to parse out the multipart object-body boundary

Supported API: true

Specified by:

getMultiPartBoundary in class HTTPRequest

Parameters:

ContentType - String containing the content-type and boundary, separated by a semi-colon

Returns:

A String containing the object-body boundary, not to exceed 70 characters per RFC1341