com.bea.wsrp.consumer.resource
Interface IResourceServletResponseContext

public interface IResourceServletResponseContext

A representation a resource request. It is used by IResourceServletInterceptor implementations.

See Also

IResourceServletInterceptor

This interface is intended to be implemented only by Oracle Weblogic Portal. Oracle Systems reserves the right to add abstract methods to this interface without notice. Implementations of this interface by other parties must not be expected to compile without change in future versions of Oracle Weblogic Portal.

Method Summary

int	getContentLength() Set the content-length if set
javax.mail.internet.ContentType	getContentType() The repsonse's content-type
String	getErrorMessage() Get the error message to send to the browser when getStatusCode() >= 400
Map<String,List<String>>	getHeaders() Get the response's headers
InputStream	getInputStream() The stream representing the target's response (body) which will be returned to the browser.
Map<String,List<String>>	getMimeHeaders() The mime-headers returned from the target which will be returned to the browser.
String	getRedirectUrl() Get the URL which if not null will be sent as a redirect to the browser.
int	getStatusCode() The status/error code sent to the browser.
void	setContentLength(int length) Set the response's content-length
void	setContentType(javax.mail.internet.ContentType type) Set the repsonse's content-type
void	setErrorMessage(String message) Set the error message to send to browser when getStatusCode() >= 400
void	setHeaders(Map<String,List<String>> headers) Get the repsonse's headers
void	setInputStream(InputStream out) Set the input stream which will be returned to the browser.
void	setRedirectUrl(String url) Set the URL to redirect to
void	setStatusCode(int code) Set the status/error code to be sent to the browser.

Method Detail

getInputStream

InputStream getInputStream()

The stream representing the target's response (body) which will be returned to the browser.

Returns

The target's output or null if none exists.

setInputStream

void setInputStream(InputStream out)

Set the input stream which will be returned to the browser.

Parameters

out - The stream to write to the browser.

getMimeHeaders

Map<String,List<String>> getMimeHeaders()

The mime-headers returned from the target which will be returned to the browser. These may be modified to change what is sent to the browser.

Returns

The headers which will be returned to the browser.

getStatusCode

int getStatusCode()

The status/error code sent to the browser.

Returns

The response code.

setStatusCode

void setStatusCode(int code)

Set the status/error code to be sent to the browser.

Parameters

code -

getErrorMessage

String getErrorMessage()

Get the error message to send to the browser when getStatusCode() >= 400

Returns

The error message or null if not set.

setErrorMessage

void setErrorMessage(String message)

Set the error message to send to browser when getStatusCode() >= 400

Parameters

message - the error message

getRedirectUrl

String getRedirectUrl()

Get the URL which if not null will be sent as a redirect to the browser.

Returns

The URL to redirect to.

setRedirectUrl

void setRedirectUrl(String url)

Set the URL to redirect to

Parameters

url - the to send a redirect with or null if no redirect should be sent.

setContentType

void setContentType(javax.mail.internet.ContentType type)

Set the repsonse's content-type

Parameters

type - The content-type

getContentType

javax.mail.internet.ContentType getContentType()

The repsonse's content-type

Returns

The content-type if set

setContentLength

void setContentLength(int length)

Set the response's content-length

Parameters

length - The content-length

getContentLength

int getContentLength()

Set the content-length if set

Returns

The content-length or -1 if unset or unknown

setHeaders

void setHeaders(Map<String,List<String>> headers)

Get the repsonse's headers

Parameters

headers - The

getHeaders

Map<String,List<String>> getHeaders()

Get the response's headers

Returns

The headers