HttpExchangeImpl (rapidoid-http 2.1.1 API)

java.lang.Object
- org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
- - org.rapidoid.http.HttpExchangeImpl

All Implemented Interfaces:

Runnable, org.rapidoid.buffer.BufProvider, HttpExchange, HttpExchangeBody, HttpExchangeHeaders, HttpInterception, org.rapidoid.net.abstracts.CtxConnection<HttpExchange>, org.rapidoid.net.abstracts.CtxFull<HttpExchange,HttpExchangeBody>, org.rapidoid.net.abstracts.CtxIO<HttpExchange>, org.rapidoid.net.abstracts.CtxProtocol<HttpExchange>, org.rapidoid.net.abstracts.CtxRead<HttpExchange>, org.rapidoid.net.abstracts.CtxState<HttpExchange>, org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>, org.rapidoid.util.Constants, org.rapidoid.util.Resetable
```
public class HttpExchangeImpl
extends org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
implements HttpExchange, HttpInterception, org.rapidoid.util.Constants
```

Field Summary

Fields
Modifier and Type Field and Description

static String SESSION_COOKIE

static String SESSION_PAGE_STACK
- Fields inherited from class org.rapidoid.net.impl.DefaultExchange
  conn, totalWritten
- Fields inherited from interface org.rapidoid.util.Constants
  AMP, ASTERISK, BYTE_0, COL, CR, CR_, CR_LF, CR_LF_CR_LF, EMPTY_ARRAY, EMPTY_STRING_ARRAY, EQ, F, LF, LF_, LF_LF, NOT_FOUND, SEMI_COL, SPACE, SPACE_, T, UTF_8

Fields
Modifier and Type	Field and Description
`static String`	`SESSION_COOKIE`
`static String`	`SESSION_PAGE_STACK`

Constructor Summary

Constructors
Constructor and Description

HttpExchangeImpl()

Constructors
Constructor and Description
`HttpExchangeImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`HttpExchangeHeaders`	`accessDeniedIf(boolean accessDeniedCondition)`
`HttpExchange`	`addHeader(byte[] name, byte[] value)`
`HttpExchange`	`addHeader(HttpHeader name, String value)`
`HttpExchangeBody`	`addToPageStack()`
`HttpExchangeHeaders`	`authorize(Class<?> clazz)`
`HttpExchange`	`binary()`
`org.rapidoid.data.Data`	`body_()`
`String`	`body()`
`HttpExchangeHeaders`	`clearSession(String sessionId)`
`HttpExchangeHeaders`	`closeSession()`
`void`	`completeResponse()`
`String`	`constructUrl(String path)`
`String`	`cookie(String name)`
`String`	`cookie(String name, String defaultValue)`
`org.rapidoid.data.MultiData`	`cookies_()`
`Map<String,String>`	`cookies()`
`org.rapidoid.data.MultiData`	`data_()`
`Map<String,String>`	`data()`
`String`	`data(String name)`
`String`	`data(String name, String defaultValue)`
`HttpExchangeImpl`	`done()`
`HttpExchange`	`download(String filename)`
`void`	`ensureHeadersComplete()`
`HttpSuccessException`	`error()`
`HttpExchangeHeaders`	`errorResponse(Throwable err)`
`HttpExchange`	`exchange()`
`byte[]`	`file(String name)`
`byte[]`	`file(String name, byte[] defaultValue)`
`org.rapidoid.data.BinaryMultiData`	`files_()`
`Map<String,byte[]>`	`files()`
`Throwable`	`getError()`
`Map<String,Object>`	`getSessionById(String sessionId)`
`HttpSuccessException`	`goBack(int steps)`
`boolean`	`hasContentType()`
`boolean`	`hasError()`
`boolean`	`hasSession()`
`boolean`	`hasSession(String sessionId)`
`String`	`header(String name)`
`String`	`header(String name, String defaultValue)`
`org.rapidoid.data.MultiData`	`headers_()`
`Map<String,String>`	`headers()`
`org.rapidoid.data.Data`	`host_()`
`String`	`host()`
`HttpExchange`	`html()`
`void`	`init(HttpResponses responses, HttpSession session, Router router)`
`boolean`	`isGetReq()`
`boolean`	`isInitial()`
`boolean`	`isPostReq()`
`HttpExchange`	`json()`
`HttpNotFoundException`	`notFound()`
`OutputStream`	`outputStream()`
`String`	`param(String name)`
`String`	`param(String name, String defaultValue)`
`org.rapidoid.data.MultiData`	`params_()`
`Map<String,String>`	`params()`
`org.rapidoid.data.Data`	`path_()`
`String`	`path()`
`String`	`pathSegment(int segmentIndex)`
`HttpExchange`	`plain()`
`org.rapidoid.data.Data`	`protocol_()`
`String`	`protocol()`
`org.rapidoid.data.Data`	`query_()`
`String`	`query()`
`HttpSuccessException`	`redirect(String url)`
`String`	`redirectUrl()`
`void`	`reset()`
`HttpExchangeHeaders`	`response(int httpResponseCode)`
`HttpExchangeHeaders`	`response(int httpResponseCode, String response)`
`HttpExchangeHeaders`	`response(int httpResponseCode, String response, Throwable err)`
`int`	`responseCode()`
`void`	`run()`
`HttpExchangeBody`	`send()`
`HttpExchangeBody`	`sendFile(File file)`
`HttpExchangeBody`	`sendFile(org.rapidoid.net.mime.MediaType mediaType, byte[] bytes)`
`boolean`	`serveStatic()`
`Map<String,Object>`	`session()`
`<T> T`	`session(String name)`
`<T> T`	`session(String name, T defaultValue)`
`void`	`sessionDeserialize(byte[] bytes)`
`<T> T`	`sessionGetOrCreate(String name, Class<T> valueClass, Object... constructorArgs)`
`String`	`sessionId()`
`byte[]`	`sessionSerialize()`
`HttpExchangeHeaders`	`sessionSet(String name, Object value)`
`HttpExchange`	`setContentType(org.rapidoid.net.mime.MediaType MediaType)`
`HttpExchange`	`setCookie(String name, String value, String... extras)`
`void`	`setSubpath(int start, int end)`
`HttpExchangeHeaders`	`startResponse(int httpResponseCode)`
`org.rapidoid.net.impl.ConnState`	`state()`
`org.rapidoid.data.Data`	`subpath_()`
`String`	`subpath()`
`String`	`toString()`
`org.rapidoid.data.Data`	`uri_()`
`String`	`uri()`
`org.rapidoid.util.UserInfo`	`user()`
`org.rapidoid.data.Data`	`verb_()`
`String`	`verb()`
`HttpExchangeBody`	`write(byte[] bytes)`
`HttpExchangeBody`	`write(byte[] bytes, int offset, int length)`
`HttpExchangeBody`	`write(ByteBuffer buf)`
`HttpExchangeBody`	`write(File file)`
`HttpExchangeBody`	`write(String s)`
`HttpExchangeBody`	`writeJSON(Object value)`
`HttpExchangeBody`	`writeln(String s)`

Methods inherited from class org.rapidoid.net.impl.DefaultExchange
address, async, binaryMultiData, buffer, close, closeIf, connId, data, decodedData, getAddress, getTotalWritten, helper, input, isAsync, meT, meW, multiData, output, readln, readN, restart, setConnection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.rapidoid.net.abstracts.CtxRead
readln, readN

Methods inherited from interface org.rapidoid.net.abstracts.CtxConnection
address, close, closeIf, connId, getAddress, isAsync

Methods inherited from interface org.rapidoid.net.abstracts.CtxIO
helper, input, output

Methods inherited from interface org.rapidoid.net.abstracts.CtxProtocol
restart

Methods inherited from interface org.rapidoid.net.abstracts.CtxWrite
async

- Field Detail
  - SESSION_COOKIE
```
public static final String SESSION_COOKIE
```
    See Also:
    Constant Field Values
  - SESSION_PAGE_STACK
```
public static final String SESSION_PAGE_STACK
```
    See Also:
    Constant Field Values
- Constructor Detail
  - HttpExchangeImpl
```
public HttpExchangeImpl()
```
- Method Detail
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface org.rapidoid.util.Resetable
    
    Overrides:
    
    reset in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - params_
```
public org.rapidoid.data.MultiData params_()
```
    Specified by:
    
    params_ in interface HttpExchange
  - headers_
```
public org.rapidoid.data.MultiData headers_()
```
    Specified by:
    
    headers_ in interface HttpExchange
  - cookies_
```
public org.rapidoid.data.MultiData cookies_()
```
    Specified by:
    
    cookies_ in interface HttpExchange
  - data_
```
public org.rapidoid.data.MultiData data_()
```
    Specified by:
    
    data_ in interface HttpExchange
  - files_
```
public org.rapidoid.data.BinaryMultiData files_()
```
    Specified by:
    
    files_ in interface HttpExchange
  - subpath_
```
public org.rapidoid.data.Data subpath_()
```
    Specified by:
    
    subpath_ in interface HttpExchange
  - body_
```
public org.rapidoid.data.Data body_()
```
    Specified by:
    
    body_ in interface HttpExchange
  - uri_
```
public org.rapidoid.data.Data uri_()
```
    Specified by:
    
    uri_ in interface HttpExchange
  - verb_
```
public org.rapidoid.data.Data verb_()
```
    Specified by:
    
    verb_ in interface HttpExchange
  - path_
```
public org.rapidoid.data.Data path_()
```
    Specified by:
    
    path_ in interface HttpExchange
  - protocol_
```
public org.rapidoid.data.Data protocol_()
```
    Specified by:
    
    protocol_ in interface HttpExchange
  - query_
```
public org.rapidoid.data.Data query_()
```
    Specified by:
    
    query_ in interface HttpExchange
  - setSubpath
```
public void setSubpath(int start,
              int end)
```
  - done
```
public HttpExchangeImpl done()
```
    Specified by:
    
    done in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    done in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - send
```
public HttpExchangeBody send()
```
    Specified by:
    
    send in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - verb
```
public String verb()
```
    Specified by:
    
    verb in interface HttpExchange
  - uri
```
public String uri()
```
    Specified by:
    
    uri in interface HttpExchange
  - path
```
public String path()
```
    Specified by:
    
    path in interface HttpExchange
  - subpath
```
public String subpath()
```
    Specified by:
    
    subpath in interface HttpExchange
  - query
```
public String query()
```
    Specified by:
    
    query in interface HttpExchange
  - protocol
```
public String protocol()
```
    Specified by:
    
    protocol in interface HttpExchange
  - body
```
public String body()
```
    Specified by:
    
    body in interface HttpExchange
  - params
```
public Map<String,String> params()
```
    Specified by:
    
    params in interface HttpExchange
  - param
```
public String param(String name)
```
    Specified by:
    
    param in interface HttpExchange
  - param
```
public String param(String name,
           String defaultValue)
```
    Specified by:
    
    param in interface HttpExchange
  - headers
```
public Map<String,String> headers()
```
    Specified by:
    
    headers in interface HttpExchange
  - header
```
public String header(String name)
```
    Specified by:
    
    header in interface HttpExchange
  - header
```
public String header(String name,
            String defaultValue)
```
    Specified by:
    
    header in interface HttpExchange
  - cookies
```
public Map<String,String> cookies()
```
    Specified by:
    
    cookies in interface HttpExchange
  - cookie
```
public String cookie(String name)
```
    Specified by:
    
    cookie in interface HttpExchange
  - cookie
```
public String cookie(String name,
            String defaultValue)
```
    Specified by:
    
    cookie in interface HttpExchange
  - data
```
public Map<String,String> data()
```
    Specified by:
    
    data in interface HttpExchange
  - data
```
public String data(String name)
```
    Specified by:
    
    data in interface HttpExchange
  - data
```
public String data(String name,
          String defaultValue)
```
    Specified by:
    
    data in interface HttpExchange
  - files
```
public Map<String,byte[]> files()
```
    Specified by:
    
    files in interface HttpExchange
  - file
```
public byte[] file(String name)
```
    Specified by:
    
    file in interface HttpExchange
  - file
```
public byte[] file(String name,
          byte[] defaultValue)
```
    Specified by:
    
    file in interface HttpExchange
  - host_
```
public org.rapidoid.data.Data host_()
```
    Specified by:
    
    host_ in interface HttpExchange
  - host
```
public String host()
```
    Specified by:
    
    host in interface HttpExchange
  - addHeader
```
public HttpExchange addHeader(byte[] name,
                     byte[] value)
```
    Specified by:
    
    addHeader in interface HttpExchangeHeaders
  - completeResponse
```
public void completeResponse()
```
  - addHeader
```
public HttpExchange addHeader(HttpHeader name,
                     String value)
```
    Specified by:
    
    addHeader in interface HttpExchangeHeaders
  - setCookie
```
public HttpExchange setCookie(String name,
                     String value,
                     String... extras)
```
    Specified by:
    
    setCookie in interface HttpExchangeHeaders
  - setContentType
```
public HttpExchange setContentType(org.rapidoid.net.mime.MediaType MediaType)
```
    Specified by:
    
    setContentType in interface HttpExchangeHeaders
  - plain
```
public HttpExchange plain()
```
    Specified by:
    
    plain in interface HttpExchangeHeaders
  - html
```
public HttpExchange html()
```
    Specified by:
    
    html in interface HttpExchangeHeaders
  - json
```
public HttpExchange json()
```
    Specified by:
    
    json in interface HttpExchangeHeaders
  - binary
```
public HttpExchange binary()
```
    Specified by:
    
    binary in interface HttpExchangeHeaders
  - download
```
public HttpExchange download(String filename)
```
    Specified by:
    
    download in interface HttpExchangeHeaders
  - ensureHeadersComplete
```
public void ensureHeadersComplete()
```
  - write
```
public HttpExchangeBody write(String s)
```
    Specified by:
    
    write in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    write in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - writeln
```
public HttpExchangeBody writeln(String s)
```
    Specified by:
    
    writeln in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    writeln in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - write
```
public HttpExchangeBody write(byte[] bytes)
```
    Specified by:
    
    write in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    write in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - write
```
public HttpExchangeBody write(byte[] bytes,
                     int offset,
                     int length)
```
    Specified by:
    
    write in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    write in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - write
```
public HttpExchangeBody write(ByteBuffer buf)
```
    Specified by:
    
    write in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    write in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - write
```
public HttpExchangeBody write(File file)
```
    Specified by:
    
    write in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    write in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - writeJSON
```
public HttpExchangeBody writeJSON(Object value)
```
    Specified by:
    
    writeJSON in interface org.rapidoid.net.abstracts.CtxWrite<HttpExchangeBody>
    
    Overrides:
    
    writeJSON in class org.rapidoid.net.impl.DefaultExchange<HttpExchange,HttpExchangeBody>
  - isInitial
```
public boolean isInitial()
```
    Specified by:
    
    isInitial in interface org.rapidoid.net.abstracts.CtxProtocol<HttpExchange>
  - state
```
public org.rapidoid.net.impl.ConnState state()
```
    Specified by:
    
    state in interface org.rapidoid.net.abstracts.CtxState<HttpExchange>
  - hasContentType
```
public boolean hasContentType()
```
  - sendFile
```
public HttpExchangeBody sendFile(File file)
```
    Specified by:
    
    sendFile in interface HttpExchangeBody
  - sendFile
```
public HttpExchangeBody sendFile(org.rapidoid.net.mime.MediaType mediaType,
                        byte[] bytes)
```
    Specified by:
    
    sendFile in interface HttpExchangeBody
  - redirect
```
public HttpSuccessException redirect(String url)
```
    Specified by:
    
    redirect in interface HttpExchangeBody
  - redirectUrl
```
public String redirectUrl()
```
    Specified by:
    
    redirectUrl in interface HttpExchangeHeaders
  - response
```
public HttpExchangeHeaders response(int httpResponseCode)
```
    Specified by:
    
    response in interface HttpExchangeHeaders
  - response
```
public HttpExchangeHeaders response(int httpResponseCode,
                           String response)
```
    Specified by:
    
    response in interface HttpExchangeHeaders
  - response
```
public HttpExchangeHeaders response(int httpResponseCode,
                           String response,
                           Throwable err)
```
    Specified by:
    
    response in interface HttpExchangeHeaders
  - startResponse
```
public HttpExchangeHeaders startResponse(int httpResponseCode)
```
    Specified by:
    
    startResponse in interface HttpExchangeHeaders
  - constructUrl
```
public String constructUrl(String path)
```
    Specified by:
    
    constructUrl in interface HttpExchange
  - sessionId
```
public String sessionId()
```
    Specified by:
    
    sessionId in interface HttpExchangeHeaders
  - session
```
public Map<String,Object> session()
```
    Specified by:
    
    session in interface HttpExchange
  - getSessionById
```
public Map<String,Object> getSessionById(String sessionId)
```
    Specified by:
    
    getSessionById in interface HttpExchange
  - sessionSet
```
public HttpExchangeHeaders sessionSet(String name,
                             Object value)
```
    Specified by:
    
    sessionSet in interface HttpExchangeHeaders
  - session
```
public <T> T session(String name,
            T defaultValue)
```
    Specified by:
    
    session in interface HttpExchange
  - session
```
public <T> T session(String name)
```
    Specified by:
    
    session in interface HttpExchange
  - sessionGetOrCreate
```
public <T> T sessionGetOrCreate(String name,
                       Class<T> valueClass,
                       Object... constructorArgs)
```
    Specified by:
    
    sessionGetOrCreate in interface HttpExchange
  - closeSession
```
public HttpExchangeHeaders closeSession()
```
    Specified by:
    
    closeSession in interface HttpExchangeHeaders
  - clearSession
```
public HttpExchangeHeaders clearSession(String sessionId)
```
    Specified by:
    
    clearSession in interface HttpExchangeHeaders
  - hasSession
```
public boolean hasSession()
```
    Specified by:
    
    hasSession in interface HttpExchangeHeaders
  - hasSession
```
public boolean hasSession(String sessionId)
```
    Specified by:
    
    hasSession in interface HttpExchangeHeaders
  - notFound
```
public HttpNotFoundException notFound()
```
    Specified by:
    
    notFound in interface HttpExchangeHeaders
  - user
```
public org.rapidoid.util.UserInfo user()
```
  - isGetReq
```
public boolean isGetReq()
```
    Specified by:
    
    isGetReq in interface HttpExchange
  - isPostReq
```
public boolean isPostReq()
```
    Specified by:
    
    isPostReq in interface HttpExchange
  - sessionSerialize
```
public byte[] sessionSerialize()
```
    Specified by:
    
    sessionSerialize in interface HttpExchange
  - sessionDeserialize
```
public void sessionDeserialize(byte[] bytes)
```
    Specified by:
    
    sessionDeserialize in interface HttpExchange
  - outputStream
```
public OutputStream outputStream()
```
    Specified by:
    
    outputStream in interface HttpExchangeBody
  - responseCode
```
public int responseCode()
```
    Specified by:
    
    responseCode in interface HttpExchangeHeaders
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - exchange
```
public HttpExchange exchange()
```
    Specified by:
    
    exchange in interface HttpInterception
  - hasError
```
public boolean hasError()
```
    Specified by:
    
    hasError in interface HttpInterception
  - getError
```
public Throwable getError()
```
    Specified by:
    
    getError in interface HttpInterception
  - pathSegment
```
public String pathSegment(int segmentIndex)
```
    Specified by:
    
    pathSegment in interface HttpExchange
  - accessDeniedIf
```
public HttpExchangeHeaders accessDeniedIf(boolean accessDeniedCondition)
```
    Specified by:
    
    accessDeniedIf in interface HttpExchangeHeaders
  - errorResponse
```
public HttpExchangeHeaders errorResponse(Throwable err)
```
    Specified by:
    
    errorResponse in interface HttpExchangeHeaders
  - authorize
```
public HttpExchangeHeaders authorize(Class<?> clazz)
```
    Specified by:
    
    authorize in interface HttpExchangeHeaders
  - serveStatic
```
public boolean serveStatic()
```
    Specified by:
    
    serveStatic in interface HttpExchangeHeaders
  - goBack
```
public HttpSuccessException goBack(int steps)
```
    Specified by:
    
    goBack in interface HttpExchangeBody
  - addToPageStack
```
public HttpExchangeBody addToPageStack()
```
    Specified by:
    
    addToPageStack in interface HttpExchangeBody
  - init
```
public void init(HttpResponses responses,
        HttpSession session,
        Router router)
```
  - error
```
public HttpSuccessException error()
```
    Specified by:
    
    error in interface HttpExchangeHeaders

Class HttpExchangeImpl

Field Summary

Fields inherited from class org.rapidoid.net.impl.DefaultExchange

Fields inherited from interface org.rapidoid.util.Constants

Constructor Summary

Method Summary

Methods inherited from class org.rapidoid.net.impl.DefaultExchange

Methods inherited from class java.lang.Object

Methods inherited from interface org.rapidoid.net.abstracts.CtxRead

Methods inherited from interface org.rapidoid.net.abstracts.CtxConnection

Methods inherited from interface org.rapidoid.net.abstracts.CtxIO

Methods inherited from interface org.rapidoid.net.abstracts.CtxProtocol

Methods inherited from interface org.rapidoid.net.abstracts.CtxWrite

Field Detail

SESSION_COOKIE

SESSION_PAGE_STACK

Constructor Detail

HttpExchangeImpl

Method Detail

reset

params_

headers_

cookies_

data_

files_

subpath_

body_

uri_

verb_

path_

protocol_

query_

setSubpath

done

send

toString

verb

uri

path

subpath

query

protocol

body

params

param

param

headers

header

header

cookies

cookie

cookie

data

data

data

files

file

file

host_

host

addHeader

completeResponse

addHeader

setCookie

setContentType

plain

html

json

binary

download

ensureHeadersComplete

write

writeln

write

write

write

write

writeJSON

isInitial

state