wt.templateutil.processor
Class HTTPState

java.lang.Object
  wt.templateutil.processor.HTTPState

All Implemented Interfaces:

Externalizable, Serializable, ContextHolder, Evolvable

Deprecated.

public class HTTPState
extends Object
implements ContextHolder, Evolvable

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release. This class is used through out the HTML Client as a "cookie" that contains the current "state" of the HTML Template Processing. In particular, all of the information required by the Factories that drive the processing of an HTML Template. Some of these factories are

• The TemplateProcessorFactory
• The HTMLTemplateFactory
• The FormTaskDelegateFactory

Essentially, the information that drives the factories is one of the following combinations

• An Action (java.lang.Object is the default object)
• An Action and an Object (the class of the object is used)
• An Action and a named class

An Action is always required, the object or class is not.

There is also additional information that is available through the HTTPState object. The name/values pairs on the URL query string are available in the Properties object returned from the method getQueryData. Similarly, the name values pairs of the HTTP POST are available from the Properties object returned from the method getPostData.

If the URL goes throught the wt.enterprise.URLProcessor class, all of these values are set for by URLProcessor. If you go through any other class, there is not any guarentee.

There are also some convenience methods available from this class. Some, but not all, of these methods are :

• get/setContextProperties
• copyStateFrom
• addToResponseExceptions
• addToResponseHeaders

These methods provide a way to pass information between TemplateProcessors(for subTemplateProcessing) and between FormTaskDelegates and TemplateProcessors(Help in generating Response Pages).

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Method Summary

void	addToResponseExceptions(Exception newException) Deprecated.
void	addToResponseFooters(LocalizableMessage newFooter) Deprecated.
void	addToResponseHeaders(LocalizableMessage newHeader) Deprecated.
void	addToResponseMessages(LocalizableMessage newMessage) Deprecated.
void	copyContextInto(ContextHolder contextHolder) Deprecated.
void	copyStateFrom(HTTPState httpState) Deprecated.
Properties	getFormData() Deprecated.
Hashtable	getFormDataMultivalue() Deprecated.
Properties	getQueryData() Deprecated.
HTTPRequest	getRequestObj() Deprecated. Returns the current wt.httpgw.HTTPRequest object for the current request from the client.
Vector	getResponseExceptions() Deprecated.
Vector	getResponseFooters() Deprecated.
Vector	getResponseHeaders() Deprecated.
Vector	getResponseMessages() Deprecated.
HTTPResponse	getResponseObj() Deprecated. Returns the current wt.httpgw.HTTPResponse object for the current request from the client.
String	getResponseString() Deprecated.
int	getStatus() Deprecated.
int	getUpdateCount() Deprecated.
void	setContextAction(String a_ContextAction) Deprecated.
void	setContextClassName(String a_ContextClassName) Deprecated.
void	setContextObj(Object a_ContextObj) Deprecated.
void	setContextProperties(Properties a_ContextProperties) Deprecated.
void	setFormData(Properties a_FormData) Deprecated.
void	setFormDataMultivalue(Hashtable a_FormDataMultivalue) Deprecated.
void	setQueryData(Properties a_QueryData) Deprecated.
void	setRequestObj(HTTPRequest a_request) Deprecated. Sets wt.httpgw.HTTPResponse object for the current request.
void	setResponseExceptions(Vector a_ResponseExceptions) Deprecated.
void	setResponseFooters(Vector a_ResponseFooters) Deprecated.
void	setResponseHeaders(Vector a_ResponseHeaders) Deprecated.
void	setResponseMessages(Vector a_ResponseMessages) Deprecated.
void	setResponseObj(HTTPResponse a_response) Deprecated. Sets wt.httpgw.HTTPResponse object for the current request.
void	setResponseString(String a_ResponseString) Deprecated.
void	setStatus(int a_Status) Deprecated.
void	setUpdateCount(int a_UpdateCount) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

setContextAction

public void setContextAction(String a_ContextAction)

Deprecated.

Sets the value of the attribute: contextAction.

Supported API: true

Specified by:

setContextAction in interface ContextHolder

Parameters:

a_ContextAction -

setContextObj

public void setContextObj(Object a_ContextObj)

Deprecated.

Sets the value of the attribute: contextObj.

Supported API: true

Specified by:

setContextObj in interface ContextHolder

Parameters:

a_ContextObj -

setContextClassName

public void setContextClassName(String a_ContextClassName)

Deprecated.

Sets the value of the attribute: contextClassName.

Supported API: true

Specified by:

setContextClassName in interface ContextHolder

Parameters:

a_ContextClassName -

setContextProperties

public void setContextProperties(Properties a_ContextProperties)

Deprecated.

Sets the value of the attribute: contextProperties.

Supported API: true

Specified by:

setContextProperties in interface ContextHolder

Parameters:

a_ContextProperties -

getResponseExceptions

public Vector getResponseExceptions()

Deprecated.

Gets the value of the attribute: responseExceptions.

Supported API: true

Specified by:

getResponseExceptions in interface ContextHolder

Returns:

Vector

setResponseExceptions

public void setResponseExceptions(Vector a_ResponseExceptions)

Deprecated.

Sets the value of the attribute: responseExceptions.

Supported API: true

Specified by:

setResponseExceptions in interface ContextHolder

Parameters:

a_ResponseExceptions -

getResponseFooters

public Vector getResponseFooters()

Deprecated.

Gets the value of the attribute: responseFooters.

Supported API: true

Specified by:

getResponseFooters in interface ContextHolder

Returns:

Vector

setResponseFooters

public void setResponseFooters(Vector a_ResponseFooters)

Deprecated.

Sets the value of the attribute: responseFooters.

Supported API: true

Specified by:

setResponseFooters in interface ContextHolder

Parameters:

a_ResponseFooters -

getResponseHeaders

public Vector getResponseHeaders()

Deprecated.

Gets the value of the attribute: responseHeaders.

Supported API: true

Specified by:

getResponseHeaders in interface ContextHolder

Returns:

Vector

setResponseHeaders

public void setResponseHeaders(Vector a_ResponseHeaders)

Deprecated.

Sets the value of the attribute: responseHeaders.

Supported API: true

Specified by:

setResponseHeaders in interface ContextHolder

Parameters:

a_ResponseHeaders -

getResponseMessages

public Vector getResponseMessages()

Deprecated.

Gets the value of the attribute: responseMessages.

Supported API: true

Specified by:

getResponseMessages in interface ContextHolder

Returns:

Vector

setResponseMessages

public void setResponseMessages(Vector a_ResponseMessages)

Deprecated.

Sets the value of the attribute: responseMessages.

Supported API: true

Specified by:

setResponseMessages in interface ContextHolder

Parameters:

a_ResponseMessages -

getResponseString

public String getResponseString()

Deprecated.

Gets the value of the attribute: responseString.

Supported API: true

Specified by:

getResponseString in interface ContextHolder

Returns:

String

setResponseString

public void setResponseString(String a_ResponseString)

Deprecated.

Sets the value of the attribute: responseString.

Supported API: true

Specified by:

setResponseString in interface ContextHolder

Parameters:

a_ResponseString -

getStatus

public int getStatus()

Deprecated.

Gets the value of the attribute: status.

Supported API: true

Specified by:

getStatus in interface ContextHolder

Returns:

int

setStatus

public void setStatus(int a_Status)

Deprecated.

Sets the value of the attribute: status.

Supported API: true

Specified by:

setStatus in interface ContextHolder

Parameters:

a_Status -

getFormData

public Properties getFormData()

Deprecated.

Gets the value of the attribute: formData.

Supported API: true

Specified by:

getFormData in interface ContextHolder

Returns:

Properties

setFormData

public void setFormData(Properties a_FormData)

Deprecated.

Sets the value of the attribute: formData.

Supported API: true

Specified by:

setFormData in interface ContextHolder

Parameters:

a_FormData -

getFormDataMultivalue

public Hashtable getFormDataMultivalue()

Deprecated.

Gets the value of the attribute: formDataMultivalue.

Supported API: true

Returns:

Hashtable

setFormDataMultivalue

public void setFormDataMultivalue(Hashtable a_FormDataMultivalue)

Deprecated.

Sets the value of the attribute: formDataMultivalue.

Supported API: true

Parameters:

a_FormDataMultivalue -

getQueryData

public Properties getQueryData()

Deprecated.

Gets the value of the attribute: queryData.

Supported API: true

Specified by:

getQueryData in interface ContextHolder

Returns:

Properties

setQueryData

public void setQueryData(Properties a_QueryData)

Deprecated.

Sets the value of the attribute: queryData.

Supported API: true

Specified by:

setQueryData in interface ContextHolder

Parameters:

a_QueryData -

getUpdateCount

public int getUpdateCount()

Deprecated.

Gets the value of the attribute: updateCount.

Supported API: true

Returns:

int

setUpdateCount

public void setUpdateCount(int a_UpdateCount)

Deprecated.

Sets the value of the attribute: updateCount.

Supported API: true

Parameters:

a_UpdateCount -

copyContextInto

public void copyContextInto(ContextHolder contextHolder)

Deprecated.

Supported API: true

Parameters:

contextHolder -

copyStateFrom

public void copyStateFrom(HTTPState httpState)

Deprecated.

Supported API: true

Parameters:

httpState -

addToResponseExceptions

public void addToResponseExceptions(Exception newException)

Deprecated.

Adds a LocalizableMessage message to the list of stackTraces that can be presented with the Windchill Script call

showResponseExceptions

Supported API: true

Specified by:

addToResponseExceptions in interface ContextHolder

Parameters:

newException -

addToResponseMessages

public void addToResponseMessages(LocalizableMessage newMessage)

Deprecated.

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseMessages

Supported API: true

Specified by:

addToResponseMessages in interface ContextHolder

Parameters:

newMessage -

addToResponseHeaders

public void addToResponseHeaders(LocalizableMessage newHeader)

Deprecated.

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseHeaders

Supported API: true

Specified by:

addToResponseHeaders in interface ContextHolder

Parameters:

newHeader -

addToResponseFooters

public void addToResponseFooters(LocalizableMessage newFooter)

Deprecated.

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseFooters

Supported API: true

Specified by:

addToResponseFooters in interface ContextHolder

Parameters:

newFooter -

getRequestObj

public HTTPRequest getRequestObj()

Deprecated.

Returns the current wt.httpgw.HTTPRequest object for the current request from the client.

Supported API: true

Returns:

HTTPRequest

setRequestObj

public void setRequestObj(HTTPRequest a_request)

Deprecated.

Sets wt.httpgw.HTTPResponse object for the current request. This is set in wt.enterprise.URLProcessor.

This should not be reset in general.

Supported API: true

Parameters:

HTTPRequest -

getResponseObj

public HTTPResponse getResponseObj()

Deprecated.

Returns the current wt.httpgw.HTTPResponse object for the current request from the client.

Supported API: true

Returns:

HTTPResponse

setResponseObj

public void setResponseObj(HTTPResponse a_response)

Deprecated.

Sets wt.httpgw.HTTPResponse object for the current request. This is set in wt.enterprise.URLProcessor.

This should not be reset in general.

Supported API: true

Parameters:

HTTPResponse -