DvalinRSContext (JAX-RS support for dvalin using Apache CXF 1.24 API)

All Known Implementing Classes:

JAXRSContextImpl
```
public interface DvalinRSContext
```
This class provides access to the current request context

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`assertLoggedIn()` assert that the current request is logged in.
`String`	`getCurrentURI()`
`String`	`getCurrentURIEncoded()`
`IUser`	`getCurrentUser()`
`String`	`getFirstHeader(String name)`
`javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()`
`javax.servlet.http.HttpServletResponse`	`getHttpServletResponse()`
`org.apache.cxf.jaxrs.ext.MessageContext`	`getMessageContext()`
`String`	`getRemoteAddress()`
`UUID`	`getRequestId()`
`javax.ws.rs.core.SecurityContext`	`getSC()`
`String`	`getServerURL()`
`boolean`	`hasRole(String role)`
`boolean`	`isLoggedIn()`
`void`	`redirect(String uriString)` redirect the caller to the given URI
`void`	`redirectPath(String path)` same as redirect(serverURL + path)

- Method Detail
  - getSC
```
javax.ws.rs.core.SecurityContext getSC()
```
    Returns:
    
    the current SecurityContext
  - assertLoggedIn
```
void assertLoggedIn()
```
    assert that the current request is logged in. Otherwise throws a 401 error
  - getCurrentUser
```
IUser getCurrentUser()
```
    Returns:
    
    the current user for this request
  - hasRole
```
boolean hasRole(String role)
```
    Parameters:
    
    role - the role to check
    
    Returns:
    
    true if the current user has the given role
  - getRequestId
```
UUID getRequestId()
```
    Returns:
    
    the unique id of the current reuqest
  - isLoggedIn
```
boolean isLoggedIn()
```
    Returns:
    
    true if the current request is logged in
  - getFirstHeader
```
String getFirstHeader(String name)
```
    Parameters:
    
    name - the header to fetch
    
    Returns:
    
    the first value of the given header
  - redirectPath
```
void redirectPath(String path)
```
    same as redirect(serverURL + path)
    
    Parameters:
    
    path - the path to redirect to
  - getServerURL
```
String getServerURL()
```
    Returns:
    
    the base URL of the application
  - redirect
```
void redirect(String uriString)
```
    redirect the caller to the given URI
    
    Parameters:
    
    uriString - the target URI
  - getCurrentURIEncoded
```
String getCurrentURIEncoded()
```
    Returns:
    
    encoded String containing the current URI
  - getCurrentURI
```
String getCurrentURI()
```
    Returns:
    
    the current URI of the request
  - getMessageContext
```
org.apache.cxf.jaxrs.ext.MessageContext getMessageContext()
```
    Returns:
    
    the MessageContext of the current request
  - getHttpServletRequest
```
javax.servlet.http.HttpServletRequest getHttpServletRequest()
```
    Returns:
    
    the HttpServletRequest of the current request
  - getHttpServletResponse
```
javax.servlet.http.HttpServletResponse getHttpServletResponse()
```
    Returns:
    
    the HttpServletResponse of the current request
  - getRemoteAddress
```
String getRemoteAddress()
```
    Returns:
    
    the remote IP of the client. This parses the 'X-Forwarded-For' header when using a proxy.

Interface DvalinRSContext

Method Summary

Method Detail

getSC

assertLoggedIn

getCurrentUser

hasRole

getRequestId

isLoggedIn

getFirstHeader

redirectPath

getServerURL

redirect

getCurrentURIEncoded

getCurrentURI

getMessageContext

getHttpServletRequest

getHttpServletResponse

getRemoteAddress