com.sap.tc.webdynpro.services.sal.adapter.api
Interface IWDWebContextAdapter

All Superinterfaces:

IWDService

public interface IWDWebContextAdapter

extends IWDService

this interface defines an abstraction for the protocol used for clientserver communication.

Method Summary

java.lang.String	encodeRedirectURL(java.lang.String url) Method encodeRedirectURL.
java.lang.String	getRequestParameter(java.lang.String key) Method getRequestParameter.
java.util.Map	getRequestParameterMap() Method getRequestParameterMap.
java.lang.String[]	getRequestParameterValues(java.lang.String key) Method getRequestParameterValues.
void	setResponseStatusCode(WDResponseStatusCodeType statusCode) Method setResponseStatusCode allows to set the response code e.g.

Methods inherited from interface com.sap.tc.webdynpro.services.sal.api.IWDService

getDescription, getServiceName, getVersion

Method Detail

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)

Method encodeRedirectURL. Encodes the specified URL by including the session ID (especially jsessionID)in it, or, if encoding is not needed, returns the URL unchanged.

Parameters:

url - The url to encode

Returns:

String

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String key)

Method getRequestParameter. returns the parameter value for the specified key

Parameters:

key - - key for the parameter value

Returns:

String

getRequestParameterValues

public java.lang.String[] getRequestParameterValues(java.lang.String key)

Method getRequestParameterValues. returns all parameter values for the specified key

Parameters:

key - - key for the parameter value

Returns:

String[]

getRequestParameterMap

public java.util.Map getRequestParameterMap()

Method getRequestParameterMap. returns the parameter map for the request

Returns:

Map - the complete map of parameter values Do not write data to this map!

setResponseStatusCode

public void setResponseStatusCode(WDResponseStatusCodeType statusCode)

Method setResponseStatusCode allows to set the response code e.g. in case of a httpResponse to 500. This method should be called in case of exceptions being catched by the application itself that prevents it from accepting a further request.

Parameters:

statusCode -