com.orientechnologies.orient.server.network.protocol.http

Class OHttpResponse

java.lang.Object

com.orientechnologies.orient.server.network.protocol.http.OHttpResponse

Direct Known Subclasses:

OHttpGraphResponse, OHttpResponseImpl

public abstract class OHttpResponse
extends Object

Maintains information about current HTTP response.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_FORMAT
static char[]	URL_SEPARATOR
protected static Charset	utf8

Constructor Summary

Constructors

Constructor and Description
OHttpResponse(OutputStream iOutStream, String iHttpVersion, String[] iAdditionalHeaders, String iResponseCharSet, String iServerInfo, String iSessionId, String iCallbackFunction, boolean iKeepAlive, OClientConnection connection, OContextConfiguration contextConfiguration)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value)
protected abstract void	checkConnection()
byte[]	compress(String jsonStr)
void	flush()
void	formatMultiValue(Iterator<?> iIterator, Writer buffer, String format)
String[]	getAdditionalHeaders()
String	getCallbackFunction()
String	getCharacterSet()
int	getCode()
OClientConnection	getConnection()
String	getContent()
String	getContentEncoding()
String	getContentType()
OContextConfiguration	getContextConfiguration()
String	getHeaders()
Map<String,String>	getHeadersMap()
String	getHttpVersion()
OutputStream	getOut()
OutputStream	getOutputStream()
String	getServerInfo()
String	getSessionId()
String	getStaticEncoding()
boolean	isJsonErrorResponse()
boolean	isKeepAlive()
boolean	isSameSiteCookie()
boolean	isSendStarted()
boolean	isStreaming()
abstract void	send(int iCode, String iReason, String iContentType, Object iContent, String iHeaders)
abstract void	sendStream(int iCode, String iReason, String iContentType, InputStream iContent, long iSize)
abstract void	sendStream(int iCode, String iReason, String iContentType, InputStream iContent, long iSize, String iFileName)
abstract void	sendStream(int iCode, String iReason, String iContentType, InputStream iContent, long iSize, String iFileName, Map<String,String> additionalHeaders)
abstract void	sendStream(int iCode, String iReason, String iContentType, String iFileName, OCallable<Void,OChunkedResponse> iWriter)
void	setAdditionalHeaders(String[] additionalHeaders)
void	setCallbackFunction(String callbackFunction)
void	setCharacterSet(String characterSet)
void	setCode(int code)
void	setConnection(OClientConnection connection)
void	setContent(String content)
void	setContentEncoding(String contentEncoding)
void	setContentType(String contentType)
void	setHeader(String iHeader) Deprecated.
void	setHeaders(String headers)
void	setJsonErrorResponse(boolean jsonErrorResponse)
void	setKeepAlive(boolean keepAlive)
void	setSameSiteCookie(boolean sameSiteCookie)
void	setSendStarted(boolean sendStarted)
void	setServerInfo(String serverInfo)
void	setSessionId(String sessionId)
void	setStaticEncoding(String contentEncoding)
void	setStreaming(boolean streaming)
void	writeContent(String iContent)
void	writeHeaders(String iContentType)
void	writeHeaders(String iContentType, boolean iKeepAlive)
void	writeLine(String iContent)
void	writeRecord(ORecord iRecord)
void	writeRecord(ORecord iRecord, String iFetchPlan, String iFormat)
void	writeRecords(Object iRecords)
void	writeRecords(Object iRecords, String iFetchPlan)
void	writeRecords(Object iRecords, String iFetchPlan, String iFormat, String accept)
void	writeRecords(Object iRecords, String iFetchPlan, String iFormat, String accept, Map<String,Object> iAdditionalProperties)
void	writeRecords(Object iRecords, String iFetchPlan, String iFormat, String accept, Map<String,Object> iAdditionalProperties, String mode)
void	writeResult(Object iResult)
void	writeResult(Object iResult, String iFormat, String iAccept)
void	writeResult(Object iResult, String iFormat, String iAccept, Map<String,Object> iAdditionalProperties)
void	writeResult(Object iResult, String iFormat, String iAccept, Map<String,Object> iAdditionalProperties, String mode)
abstract void	writeStatus(int iStatus, String iReason)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_FORMAT

public static final String JSON_FORMAT

See Also:

Constant Field Values

URL_SEPARATOR

public static final char[] URL_SEPARATOR

utf8

protected static final Charset utf8

Constructor Detail

OHttpResponse

public OHttpResponse(OutputStream iOutStream,
                     String iHttpVersion,
                     String[] iAdditionalHeaders,
                     String iResponseCharSet,
                     String iServerInfo,
                     String iSessionId,
                     String iCallbackFunction,
                     boolean iKeepAlive,
                     OClientConnection connection,
                     OContextConfiguration contextConfiguration)

Method Detail

send

public abstract void send(int iCode,
                          String iReason,
                          String iContentType,
                          Object iContent,
                          String iHeaders)
                   throws IOException

Throws:

IOException

writeStatus

public abstract void writeStatus(int iStatus,
                                 String iReason)
                          throws IOException

Throws:

IOException

writeHeaders

public void writeHeaders(String iContentType)
                  throws IOException

Throws:

IOException

writeHeaders

public void writeHeaders(String iContentType,
                         boolean iKeepAlive)
                  throws IOException

Throws:

IOException

writeLine

public void writeLine(String iContent)
               throws IOException

Throws:

IOException

writeContent

public void writeContent(String iContent)
                  throws IOException

Throws:

IOException

writeResult

public void writeResult(Object iResult)
                 throws InterruptedException,
                        IOException

Throws:

InterruptedException

IOException

writeResult

public void writeResult(Object iResult,
                        String iFormat,
                        String iAccept)
                 throws InterruptedException,
                        IOException

Throws:

InterruptedException

IOException

writeResult

public void writeResult(Object iResult,
                        String iFormat,
                        String iAccept,
                        Map<String,Object> iAdditionalProperties)
                 throws InterruptedException,
                        IOException

Throws:

InterruptedException

IOException

writeResult

public void writeResult(Object iResult,
                        String iFormat,
                        String iAccept,
                        Map<String,Object> iAdditionalProperties,
                        String mode)
                 throws InterruptedException,
                        IOException

Throws:

InterruptedException

IOException

writeRecords

public void writeRecords(Object iRecords)
                  throws IOException

Throws:

IOException

writeRecords

public void writeRecords(Object iRecords,
                         String iFetchPlan)
                  throws IOException

Throws:

IOException

writeRecords

public void writeRecords(Object iRecords,
                         String iFetchPlan,
                         String iFormat,
                         String accept)
                  throws IOException

Throws:

IOException

writeRecords

public void writeRecords(Object iRecords,
                         String iFetchPlan,
                         String iFormat,
                         String accept,
                         Map<String,Object> iAdditionalProperties)
                  throws IOException

Throws:

IOException

writeRecords

public void writeRecords(Object iRecords,
                         String iFetchPlan,
                         String iFormat,
                         String accept,
                         Map<String,Object> iAdditionalProperties,
                         String mode)
                  throws IOException

Throws:

IOException

checkConnection

protected abstract void checkConnection()
                                 throws IOException

Throws:

IOException

formatMultiValue

public void formatMultiValue(Iterator<?> iIterator,
                             Writer buffer,
                             String format)
                      throws IOException

Throws:

IOException

writeRecord

public void writeRecord(ORecord iRecord)
                 throws IOException

Throws:

IOException

writeRecord

public void writeRecord(ORecord iRecord,
                        String iFetchPlan,
                        String iFormat)
                 throws IOException

Throws:

IOException

sendStream

public abstract void sendStream(int iCode,
                                String iReason,
                                String iContentType,
                                InputStream iContent,
                                long iSize)
                         throws IOException

Throws:

IOException

sendStream

public abstract void sendStream(int iCode,
                                String iReason,
                                String iContentType,
                                InputStream iContent,
                                long iSize,
                                String iFileName)
                         throws IOException

Throws:

IOException

sendStream

public abstract void sendStream(int iCode,
                                String iReason,
                                String iContentType,
                                InputStream iContent,
                                long iSize,
                                String iFileName,
                                Map<String,String> additionalHeaders)
                         throws IOException

Throws:

IOException

sendStream

public abstract void sendStream(int iCode,
                                String iReason,
                                String iContentType,
                                String iFileName,
                                OCallable<Void,OChunkedResponse> iWriter)
                         throws IOException

Throws:

IOException

compress

public byte[] compress(String jsonStr)

setHeader

@Deprecated
public void setHeader(String iHeader)

Deprecated.

Stores additional headers to send

getOutputStream

public OutputStream getOutputStream()

flush

public void flush()
           throws IOException

Throws:

IOException

getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

getContentEncoding

public String getContentEncoding()

setContentEncoding

public void setContentEncoding(String contentEncoding)

setStaticEncoding

public void setStaticEncoding(String contentEncoding)

setSessionId

public void setSessionId(String sessionId)

getContent

public String getContent()

setContent

public void setContent(String content)

getCode

public int getCode()

setCode

public void setCode(int code)

setJsonErrorResponse

public void setJsonErrorResponse(boolean jsonErrorResponse)

setStreaming

public void setStreaming(boolean streaming)

getHttpVersion

public String getHttpVersion()

getOut

public OutputStream getOut()

getHeaders

public String getHeaders()

setHeaders

public void setHeaders(String headers)

getAdditionalHeaders

public String[] getAdditionalHeaders()

setAdditionalHeaders

public void setAdditionalHeaders(String[] additionalHeaders)

getCharacterSet

public String getCharacterSet()

setCharacterSet

public void setCharacterSet(String characterSet)

getServerInfo

public String getServerInfo()

setServerInfo

public void setServerInfo(String serverInfo)

getSessionId

public String getSessionId()

getCallbackFunction

public String getCallbackFunction()

setCallbackFunction

public void setCallbackFunction(String callbackFunction)

getStaticEncoding

public String getStaticEncoding()

isSendStarted

public boolean isSendStarted()

setSendStarted

public void setSendStarted(boolean sendStarted)

isKeepAlive

public boolean isKeepAlive()

setKeepAlive

public void setKeepAlive(boolean keepAlive)

isJsonErrorResponse

public boolean isJsonErrorResponse()

getConnection

public OClientConnection getConnection()

setConnection

public void setConnection(OClientConnection connection)

isStreaming

public boolean isStreaming()

setSameSiteCookie

public void setSameSiteCookie(boolean sameSiteCookie)

isSameSiteCookie

public boolean isSameSiteCookie()

getContextConfiguration

public OContextConfiguration getContextConfiguration()

addHeader

public void addHeader(String name,
                      String value)

getHeadersMap

public Map<String,String> getHeadersMap()