com.atlassian.plugin.webresource.impl.support.http

Class Response

java.lang.Object

com.atlassian.plugin.webresource.impl.support.http.Response

public class Response
extends Object

Probably would be removed after the refactoring, currently needed to hide some implementation details.

Since:

3.3

Constructor Summary

Constructors

Constructor and Description
Response(Request request, javax.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value)
boolean	checkRequestHelper(com.atlassian.plugin.servlet.util.LastModifiedHandler lastModifiedHandler) Deprecated.
OutputStream	getOutputStream()
int	getStatus()
long	numBytesWritten() Returns the total number of bytes written to the output stream.
void	sendError(int code)
void	sendRedirect(String location, String contentType)
void	setContentType(String contentType)
void	setContentTypeIfNotBlank(String contentType)
void	setStatus(int status)

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response(Request request,
                javax.servlet.http.HttpServletResponse response)

Method Detail

addHeader

public void addHeader(String name,
                      String value)

checkRequestHelper

@Deprecated
public boolean checkRequestHelper(@Nonnull
                                              com.atlassian.plugin.servlet.util.LastModifiedHandler lastModifiedHandler)

Deprecated.

DEPRECATED - just like the underlying method.

Only exists because WRM common has been left behind accidentally in Atlassian Plugins repo and we can't get both upgraded at the same time AND we don't want to expose the underlying HttpServletResponse

Parameters:

lastModifiedHandler - last modified handler to checkRequest with

Returns:

lastModifiedHandler#checkRequest

sendRedirect

public void sendRedirect(String location,
                         String contentType)

sendError

public void sendError(int code)

setContentType

public void setContentType(String contentType)

getOutputStream

public OutputStream getOutputStream()

setContentTypeIfNotBlank

public void setContentTypeIfNotBlank(String contentType)

setStatus

public void setStatus(int status)

getStatus

public int getStatus()

numBytesWritten

public long numBytesWritten()

Returns the total number of bytes written to the output stream. NOTE: this is not necessarily the size of the Response.

Returns:

total number of of bytes written to the output stream