Package net.shibboleth.sp.messaging

Class RemotedHttpServletResponse

java.lang.Object

net.shibboleth.sp.messaging.RemotedHttpServletResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

@NotThreadSafe
public class RemotedHttpServletResponse
extends Object
implements HttpServletResponse

Uses a DDF object to reflect an HTTP response back to a remote caller.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	RemotedHttpServletResponse.BodyOutputStream	A pseudo ServletOutputStream to catch output.
private static final class	RemotedHttpServletResponse.ByteArrayWrapper	Wrapper allowing use of containers of arrays.

Field Summary

Fields

Modifier and Type	Field	Description
private int	bufferSize	Size of each character buffer for output.
private boolean	committed	Tracks committing of response.
static final String	DATA	Field holding response body data.
static final String	HEADERS	Field holding header collection.
private final DDF	obj	Underlying object for remoted data.
private RemotedHttpServletResponse.BodyOutputStream	outputStream	A materialized output stream.
static final String	REDIRECT	Field holding redirect location.
static final String	RESPONSE	Field holding response.
static final String	STATUS	Field holding response body status.
static final String	STRUCTURE_NAME	Field holding name of DDF structure containing response.

Fields inherited from interface jakarta.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MISDIRECTED_REQUEST, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PERMANENT_REDIRECT, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE, SC_UPGRADE_REQUIRED, SC_USE_PROXY

Constructor Summary

Constructors

Constructor	Description
RemotedHttpServletResponse(DDF ddf)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addCookie(Cookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
boolean	containsHeader(String name)
String	encodeRedirectURL(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
String	getContentType()
DDF	getDDF()	Gets the underlying object containing the response data.
String	getHeader(String name)
private DDF	getHeaderList()	Get the list node to which headers should be added.
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
Locale	getLocale()
ServletOutputStream	getOutputStream()
int	getStatus()
PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(byte[] location)	Issues a redirect recongizing as Java does not that URLs are not in fact Unicode-safe.
void	sendRedirect(String location)
void	sendRedirect(String location, int sc, boolean clearBuffer)
void	setBufferSize(int size)
void	setCharacterEncoding(String charset)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setContentType(String type)
void	setDateHeader(String name, long date)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale loc)
void	setStatus(int sc)
private void	unsetHeader(String name)	Removes any existing header(s) of this type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.http.HttpServletResponse

getTrailerFields, sendRedirect, sendRedirect, setTrailerFields

Methods inherited from interface jakarta.servlet.ServletResponse

setCharacterEncoding

Field Details

STRUCTURE_NAME

@Nonnull
@NotEmpty
public static final String STRUCTURE_NAME

Field holding name of DDF structure containing response.

See Also:

• Constant Field Values

REDIRECT

@Nonnull
@NotEmpty
public static final String REDIRECT

Field holding redirect location.

See Also:

• Constant Field Values

RESPONSE

@Nonnull
@NotEmpty
public static final String RESPONSE

Field holding response.

See Also:

• Constant Field Values

DATA

@Nonnull
@NotEmpty
public static final String DATA

Field holding response body data.

See Also:

• Constant Field Values

STATUS

@Nonnull
@NotEmpty
public static final String STATUS

Field holding response body status.

See Also:

• Constant Field Values

HEADERS

@Nonnull
@NotEmpty
public static final String HEADERS

Field holding header collection.

See Also:

• Constant Field Values

obj

@Nonnull
private final DDF obj

Underlying object for remoted data.

bufferSize

private int bufferSize

Size of each character buffer for output.

committed

private boolean committed

Tracks committing of response.

outputStream

@Nullable
private RemotedHttpServletResponse.BodyOutputStream outputStream

A materialized output stream.

Constructor Details

RemotedHttpServletResponse

public RemotedHttpServletResponse(@Nonnull
 DDF ddf)

Constructor.

Parameters:

ddf - object to capture response

Method Details

getDDF

@Nonnull
public DDF getDDF()

Gets the underlying object containing the response data.

Returns:

remoted data object

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletResponse

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Throws:

IOException

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface ServletResponse

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface ServletResponse

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface ServletResponse

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface ServletResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Throws:

IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

reset

public void reset()

Specified by:

reset in interface ServletResponse

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface HttpServletResponse

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface HttpServletResponse

sendError

public void sendError(int sc,
 String msg)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String location,
 int sc,
 boolean clearBuffer)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(byte[] location)

Issues a redirect recongizing as Java does not that URLs are not in fact Unicode-safe.

Parameters:

location - raw location bytes

setDateHeader

public void setDateHeader(String name,
 long date)

Specified by:

setDateHeader in interface HttpServletResponse

addDateHeader

public void addDateHeader(String name,
 long date)

Specified by:

addDateHeader in interface HttpServletResponse

setHeader

public void setHeader(String name,
 String value)

Specified by:

setHeader in interface HttpServletResponse

addHeader

public void addHeader(String name,
 String value)

Specified by:

addHeader in interface HttpServletResponse

setIntHeader

public void setIntHeader(String name,
 int value)

Specified by:

setIntHeader in interface HttpServletResponse

addIntHeader

public void addIntHeader(String name,
 int value)

Specified by:

addIntHeader in interface HttpServletResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface HttpServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface HttpServletResponse

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface HttpServletResponse

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface HttpServletResponse

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletResponse

unsetHeader

private void unsetHeader(@Nonnull @NotEmpty
 String name)

Removes any existing header(s) of this type.

Parameters:

name - name of header to remove

getHeaderList

@Nonnull
private DDF getHeaderList()

Get the list node to which headers should be added.

Returns:

a pre-existing list or a new one for mutation.