services.moleculer.web.servlet.response

Class AbstractWebResponse

java.lang.Object

services.moleculer.web.servlet.response.AbstractWebResponse

All Implemented Interfaces:

WebResponse

Direct Known Subclasses:

BlockingWebResponse, NonBlockingWebResponse

public abstract class AbstractWebResponse
extends java.lang.Object
implements WebResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicBoolean	closed
protected javax.servlet.ServletOutputStream	out
protected java.util.HashMap<java.lang.String,java.lang.Object>	properties Custom properties (for inter-middleware communication).
protected javax.servlet.http.HttpServletResponse	rsp

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebResponse(javax.servlet.http.HttpServletResponse rsp)

Method Summary

Modifier and Type	Method and Description
boolean	end() Completes the synchronous operation that was started on the request.
java.lang.String	getHeader(java.lang.String name) Returns the value of the specified response header as a String.
java.lang.Object	getInternalObject() Returns the internal object of this WebResponse.
java.lang.Object	getProperty(java.lang.String name) Returns the value to which the specified "name" is mapped, or null if this WebResponse contains no mapping for the "name".
int	getStatus() Gets the current status code of this response.
void	send(byte[] bytes) Writes b.length bytes of body from the specified byte array to the output stream.
void	setHeader(java.lang.String name, java.lang.String value) Sets a response header with the given name and value.
void	setProperty(java.lang.String name, java.lang.Object value) Associates the specified value with the specified "name" in this WebResponse.
void	setStatus(int code) Sets the status code for this response.

Methods inherited from class java.lang.Object

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

Field Detail

rsp

protected final javax.servlet.http.HttpServletResponse rsp

out

protected final javax.servlet.ServletOutputStream out

closed

protected final java.util.concurrent.atomic.AtomicBoolean closed

properties

protected java.util.HashMap<java.lang.String,java.lang.Object> properties

Custom properties (for inter-middleware communication).

Constructor Detail

AbstractWebResponse

protected AbstractWebResponse(javax.servlet.http.HttpServletResponse rsp)
                       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setStatus

public void setStatus(int code)

Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the 200 or 404 status codes). This method preserves any cookies and other response headers. Valid status codes are those in the 2XX, 3XX, 4XX, and 5XX ranges. Other status codes are treated as container specific.

Specified by:

setStatus in interface WebResponse

Parameters:

code - the status code

getStatus

public int getStatus()

Gets the current status code of this response.

Specified by:

getStatus in interface WebResponse

Returns:

the status code

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.

Specified by:

setHeader in interface WebResponse

Parameters:

name - the name of the header

value - the header value If it contains octet string, it should be encoded according to RFC 2047

getHeader

public java.lang.String getHeader(java.lang.String name)

Returns the value of the specified response header as a String. If the response did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the response.

Specified by:

getHeader in interface WebResponse

Parameters:

name - name a String specifying the header name

Returns:

a String containing the value of the response header, or null if the response does not have a header of that name

send

public void send(byte[] bytes)
          throws java.io.IOException

Writes b.length bytes of body from the specified byte array to the output stream.

Specified by:

send in interface WebResponse

Parameters:

bytes - the data

Throws:

java.io.IOException - if an I/O error occurs

end

public boolean end()

Completes the synchronous operation that was started on the request.

Specified by:

end in interface WebResponse

Returns:

return true, if any resources are released

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Associates the specified value with the specified "name" in this WebResponse. If the WebResponse previously contained a mapping for the "name", the old value is replaced.

Specified by:

setProperty in interface WebResponse

Parameters:

name - a "name" with which the specified value is to be associated

value - value to be associated with the specified "name"

getProperty

public java.lang.Object getProperty(java.lang.String name)

Returns the value to which the specified "name" is mapped, or null if this WebResponse contains no mapping for the "name".

Specified by:

getProperty in interface WebResponse

Parameters:

name - the "name" whose associated value is to be returned

Returns:

the value to which the specified "name" is mapped, or null if this WebResponse contains no mapping for the "name"

getInternalObject

public java.lang.Object getInternalObject()

Returns the internal object of this WebResponse.

Specified by:

getInternalObject in interface WebResponse

Returns:

internal object (HttpServletResponse)