NWebCallContext (NHTTP Server API Support 0.8.9.0 API)

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

NWebCallContextAdapter
```
public interface NWebCallContext
extends AutoCloseable
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NWebCallContext`	`addResponseHeader(String name, String value)`
`NWebUser`	`authenticateWithAccessToken(String accessToken)`
`NLoginResult`	`authenticateWithCredentials(NAuthenticationRequest authenticationRequest)`
`NLoginResult`	`authenticateWithRefreshToken(String refreshToken)`
`void`	`close()`
`boolean`	`containsQueryParam(String queryParam)`
`NWebCallContext`	`error(NMsg msg)`
`NOptional<String>`	`getApiKeyRequestHeader()`
`String`	`getFirstPath()`
`NOptional<FormDataItem>`	`getFormData(String name)`
`Map<String,FormDataItem>`	`getFormDataMap()`
`NHttpMethod`	`getMethod()`
`NOptional<String>`	`getMultipartRequestBoundary()`
`String`	`getPath()`
`String`	`getPathPart(int pos)`
`String[]`	`getPathParts()`
`int`	`getPathSize()`
`NWebPrincipal`	`getPrincipal()`
`NOptional<String>`	`getQueryParam(String queryParam)`
`Map<String,List<String>>`	`getQueryParams()`
`NOptional<String>`	`getRealmRequestHeader()`
`InputStream`	`getRequestBody()`
`<T> T`	`getRequestBodyAs(Class<T> cl)`
`<T> T`	`getRequestBodyAs(Class<T> cl, NContentType contentType)`
`String`	`getRequestBodyAsString()`
`NOptional<String>`	`getRequestHeader(String header)`
`Map<String,List<String>>`	`getRequestHeaders()`
`List<String>`	`getRequestHeaders(String header)`
`URI`	`getRequestURI()`
`OutputStream`	`getResponseBody()`
`NHttpCode`	`getResponseCode()`
`NOptional<NWebToken>`	`getToken()`
`NOptional<NWebUser>`	`getUser()`
`NWebContext`	`getWebContext()`
`NWebCallContext`	`info(NMsg msg)`
`void`	`initializeConfig()`
`boolean`	`isEmptyPath()`
`boolean`	`isMultipartRequest()`
`boolean`	`isResponseSent()`
`NWebCallContext`	`requireAuth()`
`NWebCallContext`	`requireMethod(NHttpMethod... m)`
`NWebCallContext`	`runWithUnsafe(NUnsafeRunnable callable)`
`NWebCallContext`	`sendResponse()`
`NWebCallContext`	`sendResponseHeaders()`
`NWebCallContext`	`setBytesResponse(byte[] value)`
`NWebCallContext`	`setErrorCode(NMsgCode errorCode)`
`NWebCallContext`	`setErrorResponse(NMsgCode errorCode)`
`NWebCallContext`	`setErrorResponse(NWebHttpException ex)`
`NWebCallContext`	`setErrorResponse(Throwable ex)`
`NWebCallContext`	`setFileResponse(NPath value)`
`NWebCallContext`	`setJsonResponse(Object value)`
`NWebCallContext`	`setResponseCode(NHttpCode responseCode)`
`NWebCallContext`	`setResponseContentType(String contentType)`
`NWebCallContext`	`setResponseHeader(String name, String value)`
`NWebCallContext`	`setTextResponse(String value)`
`NWebCallContext`	`setToken(NWebToken token)`
`NWebCallContext`	`setUser(NWebUser user)`
`NWebCallContext`	`setXmlResponse(String value)`
`NWebCallContext`	`throwNoFound()`
`NWebCallContext`	`trace(NHttpLogMsg msg)`
`NWebHttpException`	`wrapException(Throwable ex)`

Method Detail

getRequestURI
```
URI getRequestURI()
```

getFirstPath
```
String getFirstPath()
```

isEmptyPath
```
boolean isEmptyPath()
```

getPathSize
```
int getPathSize()
```

getPathParts
```
String[] getPathParts()
```

getPathPart
```
String getPathPart(int pos)
```

getRequestBodyAs
```
<T> T getRequestBodyAs(Class<T> cl)
```

getRequestBodyAs

<T> T getRequestBodyAs(Class<T> cl,
                       NContentType contentType)

getRequestBodyAsString
```
String getRequestBodyAsString()
```

getPath
```
String getPath()
```

wrapException

NWebHttpException wrapException(Throwable ex)

setResponseContentType

NWebCallContext setResponseContentType(String contentType)

setErrorCode

NWebCallContext setErrorCode(NMsgCode errorCode)

sendResponseHeaders
```
NWebCallContext sendResponseHeaders()
```

getResponseBody
```
OutputStream getResponseBody()
```

getMethod
```
NHttpMethod getMethod()
```

requireAuth
```
NWebCallContext requireAuth()
```

info
```
NWebCallContext info(NMsg msg)
```

error
```
NWebCallContext error(NMsg msg)
```

trace

NWebCallContext trace(NHttpLogMsg msg)

requireMethod

NWebCallContext requireMethod(NHttpMethod... m)

throwNoFound
```
NWebCallContext throwNoFound()
```

getPrincipal
```
NWebPrincipal getPrincipal()
```

getUser
```
NOptional<NWebUser> getUser()
```

setUser

NWebCallContext setUser(NWebUser user)

getToken
```
NOptional<NWebToken> getToken()
```

setToken

NWebCallContext setToken(NWebToken token)

runWithUnsafe

NWebCallContext runWithUnsafe(NUnsafeRunnable callable)
                       throws Throwable

Throws:: Throwable

getQueryParams

Map<String,List<String>> getQueryParams()

getQueryParam

NOptional<String> getQueryParam(String queryParam)

containsQueryParam

boolean containsQueryParam(String queryParam)

addResponseHeader

NWebCallContext addResponseHeader(String name,
                                  String value)

setResponseHeader

NWebCallContext setResponseHeader(String name,
                                  String value)

getResponseCode
```
NHttpCode getResponseCode()
```

setResponseCode

NWebCallContext setResponseCode(NHttpCode responseCode)

getApiKeyRequestHeader

NOptional<String> getApiKeyRequestHeader()

getRealmRequestHeader

NOptional<String> getRealmRequestHeader()

getRequestHeader

NOptional<String> getRequestHeader(String header)

getRequestHeaders

Map<String,List<String>> getRequestHeaders()

getRequestHeaders

List<String> getRequestHeaders(String header)

getFormDataMap

Map<String,FormDataItem> getFormDataMap()

getRequestBody
```
InputStream getRequestBody()
```

getFormData

NOptional<FormDataItem> getFormData(String name)

isMultipartRequest
```
boolean isMultipartRequest()
```

getMultipartRequestBoundary

NOptional<String> getMultipartRequestBoundary()

setTextResponse

NWebCallContext setTextResponse(String value)

setXmlResponse

NWebCallContext setXmlResponse(String value)

setJsonResponse

NWebCallContext setJsonResponse(Object value)

setBytesResponse

NWebCallContext setBytesResponse(byte[] value)

setFileResponse

NWebCallContext setFileResponse(NPath value)

setErrorResponse

NWebCallContext setErrorResponse(NMsgCode errorCode)

sendResponse
```
NWebCallContext sendResponse()
```

setErrorResponse

NWebCallContext setErrorResponse(NWebHttpException ex)

setErrorResponse

NWebCallContext setErrorResponse(Throwable ex)

close
```
void close()
```
Specified by:

close in interface AutoCloseable

isResponseSent
```
boolean isResponseSent()
```

authenticateWithCredentials

NLoginResult authenticateWithCredentials(NAuthenticationRequest authenticationRequest)

authenticateWithRefreshToken

NLoginResult authenticateWithRefreshToken(String refreshToken)

authenticateWithAccessToken

NWebUser authenticateWithAccessToken(String accessToken)

initializeConfig
```
void initializeConfig()
```

getWebContext
```
NWebContext getWebContext()
```

Interface NWebCallContext

Method Summary

Method Detail

getRequestURI

getFirstPath

isEmptyPath

getPathSize

getPathParts

getPathPart

getRequestBodyAs

getRequestBodyAs

getRequestBodyAsString

getPath

wrapException

setResponseContentType

setErrorCode

sendResponseHeaders

getResponseBody

getMethod

requireAuth

info

error

trace

requireMethod

throwNoFound

getPrincipal

getUser

setUser

getToken

setToken

runWithUnsafe

getQueryParams

getQueryParam

containsQueryParam

addResponseHeader

setResponseHeader

getResponseCode

setResponseCode

getApiKeyRequestHeader

getRealmRequestHeader

getRequestHeader

getRequestHeaders

getRequestHeaders

getFormDataMap

getRequestBody

getFormData

isMultipartRequest

getMultipartRequestBoundary

setTextResponse

setXmlResponse

setJsonResponse

setBytesResponse

setFileResponse

setErrorResponse

sendResponse

setErrorResponse

setErrorResponse

close

isResponseSent

authenticateWithCredentials

authenticateWithRefreshToken

authenticateWithAccessToken

initializeConfig

getWebContext