Package com.esri.arcgis.enterprise.interceptor.server

Class ServerServicesInterceptorResponseWrapper

java.lang.Object

com.esri.arcgis.enterprise.interceptor.server.ServerServicesInterceptorResponseWrapper

All Implemented Interfaces:

IInterceptorResponse

public class ServerServicesInterceptorResponseWrapper
extends Object
implements IInterceptorResponse

Constructor Summary

Constructors

Constructor	Description
ServerServicesInterceptorResponseWrapper(IInterceptorResponse interceptorResponse)

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)	Adds a response header with the given name and value.
void	flushBuffer()	Forces any content in the buffer to be written to the client.
IInterceptorResponse	getAppInterceptorResponse()
String	getCharacterEncoding()	Returns the name of the character encoding
String	getContentType()	Returns a String that indicates the content-type of the response
String	getHeader(String name)	Returns the value of the specified request header as a String
Collection<String>	getHeaderNames()	Gets the names of the headers of this response.
Collection<String>	getHeaders(String name)	Gets the values of the response header with the given name.
jakarta.servlet.ServletOutputStream	getOutputStream()	Returns a ServletOutputStream suitable for writing binary data in the response.
PrintWriter	getWriter()	Returns a PrintWriter object that can send character text to the client.
boolean	isCommitted()	Returns a boolean indicating if the response has been committed.
void	reset()	Clears any data that exists in the buffer as well as the status code and headers.
void	sendError(int sc)	Sends an error response to the client using the specified status code and clears the buffer.
void	sendError(int sc, String msg)	Sends an error response to the client using the specified status code and clears the buffer.
void	setCharacterEncoding(String var1)	Sets the character encoding of the response being sent to the client.
void	setHeader(String name, String value)	Sets a response header with the given name and value.
void	setStatus(int sc)	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

Constructor Details

ServerServicesInterceptorResponseWrapper

public ServerServicesInterceptorResponseWrapper(IInterceptorResponse interceptorResponse)

Method Details

sendError

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

Description copied from interface: IInterceptorResponse

Sends an error response to the client using the specified status code and clears the buffer.

Specified by:

sendError in interface IInterceptorResponse

Parameters:

sc - - the error status code

msg - - the descriptive message

Throws:

IOException - If an input or output exception occurs

sendError

public void sendError(int sc)
               throws IOException

Description copied from interface: IInterceptorResponse

Sends an error response to the client using the specified status code and clears the buffer.

Specified by:

sendError in interface IInterceptorResponse

Parameters:

sc - - the error status code

Throws:

IOException - If an input or output exception occurs

setHeader

public void setHeader(String name,
 String value)

Description copied from interface: IInterceptorResponse

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 IInterceptorResponse

Parameters:

name - - the name of the header

value - - the header value

addHeader

public void addHeader(String name,
 String value)

Description copied from interface: IInterceptorResponse

Adds a response header with the given name and value.

Specified by:

addHeader in interface IInterceptorResponse

Parameters:

name - - the name of the header

value - - the additional header value

setStatus

public void setStatus(int sc)

Description copied from interface: IInterceptorResponse

Sets the status code for this response.

Specified by:

setStatus in interface IInterceptorResponse

Parameters:

sc - - the status code

getHeader

public String getHeader(String name)

Description copied from interface: IInterceptorResponse

Returns the value of the specified request header as a String

Specified by:

getHeader in interface IInterceptorResponse

Parameters:

name - - the name of the response header whose value to return

Returns:

the value of the response header with the given name, or null if no header with the given name has been set on this response

getHeaders

public Collection<String> getHeaders(String name)

Description copied from interface: IInterceptorResponse

Gets the values of the response header with the given name.

Specified by:

getHeaders in interface IInterceptorResponse

Parameters:

name - - the name of the response header whose values to return

Returns:

a Collection of the values of the response header with the given name

getHeaderNames

public Collection<String> getHeaderNames()

Description copied from interface: IInterceptorResponse

Gets the names of the headers of this response.

Specified by:

getHeaderNames in interface IInterceptorResponse

Returns:

a Collection of the names of the headers of this response

getOutputStream

public jakarta.servlet.ServletOutputStream getOutputStream()
                                                    throws IOException

Description copied from interface: IInterceptorResponse

Returns a ServletOutputStream suitable for writing binary data in the response.

Specified by:

getOutputStream in interface IInterceptorResponse

Returns:

a ServletOutputStream for writing binary data

Throws:

IOException - if the getWriter method has been called on this response

getWriter

public PrintWriter getWriter()
                      throws IOException

Description copied from interface: IInterceptorResponse

Returns a PrintWriter object that can send character text to the client.

Specified by:

getWriter in interface IInterceptorResponse

Returns:

a PrintWriter object that can return character data to the client

Throws:

IOException - if an input or output exception occurred

flushBuffer

public void flushBuffer()
                 throws IOException

Description copied from interface: IInterceptorResponse

Forces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written.

Specified by:

flushBuffer in interface IInterceptorResponse

Throws:

IOException

reset

public void reset()

Description copied from interface: IInterceptorResponse

Clears any data that exists in the buffer as well as the status code and headers.

Specified by:

reset in interface IInterceptorResponse

setCharacterEncoding

public void setCharacterEncoding(String var1)

Description copied from interface: IInterceptorResponse

Sets the character encoding of the response being sent to the client.

Specified by:

setCharacterEncoding in interface IInterceptorResponse

Parameters:

var1 - - a String specifying only the character

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: IInterceptorResponse

Returns the name of the character encoding

Specified by:

getCharacterEncoding in interface IInterceptorResponse

isCommitted

public boolean isCommitted()

Description copied from interface: IInterceptorResponse

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

Specified by:

isCommitted in interface IInterceptorResponse

Returns:

a boolean indicating if the response has been committed

getContentType

public String getContentType()

Description copied from interface: IInterceptorResponse

Returns a String that indicates the content-type of the response

Specified by:

getContentType in interface IInterceptorResponse

Returns:

String that indicates the content-type of the response

getAppInterceptorResponse

public IInterceptorResponse getAppInterceptorResponse()