Class PTHTTPResponse

Object
   |
   +--PTHTTPResponse

class PTHTTPResponse

Object wrapper for HTTP response received from GET or POST operations. The callback method invoked by the transport mechanism will pass as its one and only argument a PTHTTPResponse object -- there should be no public need to construct one explicitly. Response handling functions can then access the properties of the PTHTTPResponse in the course of processing the HTTP request/response. PTHTTPResponses should never be instantiated directly but should be generated by the PTHTTPTransport in response to a PTHTTPRequest.

Usage:	
 	function handleResponseAlert(response) 
	{
		var text = 'Response Message:\n';
		var text += response.responseText;
		if(response.type == PTHTTPResponse.RESPONSE_TYPE_OK)
			alert(text);
	}
 

Field Detail

_responseHeaders

<private> Object _responseHeaders

_responseHeadersString

<private> Object _responseHeadersString

className

<private> Object className

hasPTResponseType

<private> Object hasPTResponseType

request

PTHTTPRequest request

The PTHTTPRequest object that generated this response.

responseText

String responseText

The response content text returned by the PTHTTPResponse.

responseXML

XML Document responseXML

The response content xml returned by the PTHTTPResponse.

status

Number status

Status code of the respone

type

String type

Response type, typically one of the response type constants.

PT_LOGIN_URL_HEADER

<static> <final> String PT_LOGIN_URL_HEADER

PT login URL header -- used with session timeout respose type

See Also:

Constant Field Values

PT_RESPONSE_TYPE_HEADER

<static> <final> String PT_RESPONSE_TYPE_HEADER

name of the response type header

See Also:

Constant Field Values

PT_RESPONSE_TYPE_HEADER_SAFARI

<static> <final> String PT_RESPONSE_TYPE_HEADER_SAFARI

name of the response type header for Safari browsers, since Safari seems to change the case on custom headers.

See Also:

Constant Field Values

PT_RESPONSE_TYPE_PORTLET_ERROR

<static> <final> String PT_RESPONSE_TYPE_PORTLET_ERROR

header for portlet errors

See Also:

Constant Field Values

PT_RESPONSE_TYPE_PORTLET_TIMEOUT

<static> <final> String PT_RESPONSE_TYPE_PORTLET_TIMEOUT

header for portlet timeouts

See Also:

Constant Field Values

PT_RESPONSE_TYPE_SESSION_TIMEOUT

<static> <final> String PT_RESPONSE_TYPE_SESSION_TIMEOUT

header for session timeouts

See Also:

Constant Field Values

RESPONSE_TYPE_EMPTY_RESPONSE

<static> <final> String RESPONSE_TYPE_EMPTY_RESPONSE

Response Type SERVER_ERROR (Response Code 204 [1223])

See Also:

Constant Field Values

RESPONSE_TYPE_NO_RESPONSE

<static> <final> String RESPONSE_TYPE_NO_RESPONSE

no response from the server at all

See Also:

Constant Field Values

RESPONSE_TYPE_OK

<static> <final> String RESPONSE_TYPE_OK

Response Type OK (Response Code 200)

See Also:

Constant Field Values

RESPONSE_TYPE_PORTLET_ERROR

<static> <final> String RESPONSE_TYPE_PORTLET_ERROR

represents an error in the remote tier or gateway.

See Also:

Constant Field Values

RESPONSE_TYPE_PORTLET_TIMEOUT

<static> <final> String RESPONSE_TYPE_PORTLET_TIMEOUT

represents a portlet timed out by the gateway.

See Also:

Constant Field Values

RESPONSE_TYPE_REDIRECT

<static> <final> String RESPONSE_TYPE_REDIRECT

Response Type REDIRECT (Response Code 302)

See Also:

Constant Field Values

RESPONSE_TYPE_SERVER_ERROR

<static> <final> String RESPONSE_TYPE_SERVER_ERROR

Response Type SERVER_ERROR (Response Code 400-599)

See Also:

Constant Field Values

RESPONSE_TYPE_SESSION_EXPIRED

<static> <final> String RESPONSE_TYPE_SESSION_EXPIRED

Response Type SESSION_EXPIRED (Response Code 200), with portal login page.

See Also:

Constant Field Values

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTHTTPResponse

PTHTTPResponse(request, responseText, responseXML, status, type, responseHeadersString)

Wrapper for HTTP responses recieved from GET or POST requests.

Parameters:
request - Reference to the calling request object(PTHTTPGETRequest or PTHTTPPOSTRequest)
responseText - The raw text returned by the request
responseXML - The XML returned by the request
status - Status of the response
type - Type of response

_getResponseTypeFromHeaders

 <private> Object _getResponseTypeFromHeaders(status)

Gets the response type from the http response header

getResponseHeaders

Hash getResponseHeaders()

getResponseHeaders Returns an associate array (object) of response header name/value pairs

Returns:
a hash of header name/value pairs

isValid

<static> Boolean isValid(HTTPResponse)

isValid Returns whether or not a response appears to be valid

Parameters:
HTTPResponse - HTTP Response object (PTHTTPResponse object)

Returns:
true if the response is valid

Deprecated The prefered way to check for a valid response is to examine the response status