public abstract class SCIMRequest extends Object
| Constructor and Description |
|---|
SCIMRequest(URI baseURL,
String authenticatedUserID,
ResourceDescriptor resourceDescriptor)
Create a new SCIM request from the provided information.
|
SCIMRequest(URI baseURL,
String authenticatedUserID,
ResourceDescriptor resourceDescriptor,
javax.servlet.http.HttpServletRequest httpServletRequest)
Create a new SCIM request from the provided information.
|
SCIMRequest(URI baseURL,
String authenticatedUserID,
ResourceDescriptor resourceDescriptor,
javax.servlet.http.HttpServletRequest httpServletRequest,
String ifMatchHeaderValue,
String ifNoneMatchHeaderValue)
Create a new SCIM request from the provided information.
|
| Modifier and Type | Method and Description |
|---|---|
void |
checkPreconditions(javax.ws.rs.core.EntityTag currentVersion)
Evaluate request preconditions based on the passed in current version.
|
void |
checkPreconditions(ResourceNotFoundException exception)
Evaluate request preconditions for a resource that does not currently
exist.
|
protected void |
evaluateIfMatch(javax.ws.rs.core.EntityTag eTag,
String headerValue)
Evaluate If-Match header against the provided eTag.
|
protected void |
evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag,
String headerValue)
Evaluate If-None-Match header against the provided eTag.
|
String |
getAuthenticatedUserID()
Get the authenticated user ID.
|
URI |
getBaseURL()
Retrieve the base URL for the SCIM service.
|
javax.servlet.http.HttpServletRequest |
getHttpServletRequest()
Get the HTTP servlet request associated with this request.
|
ResourceDescriptor |
getResourceDescriptor()
Get ResourceDescriptor associated with this request.
|
public SCIMRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor)
baseURL - The base URL for the SCIM service.authenticatedUserID - The authenticated user name or null if
the request is not authenticated.resourceDescriptor - The ResourceDescriptor associated with this
request.public SCIMRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor, javax.servlet.http.HttpServletRequest httpServletRequest)
baseURL - The base URL for the SCIM service.authenticatedUserID - The authenticated user name or null if
the request is not authenticated.resourceDescriptor - The ResourceDescriptor associated with this
request.httpServletRequest - The HTTP servlet request associated with this
request or null if this request is not
initiated by a servlet.public SCIMRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor, javax.servlet.http.HttpServletRequest httpServletRequest, String ifMatchHeaderValue, String ifNoneMatchHeaderValue)
baseURL - The base URL for the SCIM service.authenticatedUserID - The authenticated user name or null if
the request is not authenticated.resourceDescriptor - The ResourceDescriptor associated with this
request.httpServletRequest - The HTTP servlet request associated with this
request or null if this request is not
initiated by a servlet.ifMatchHeaderValue - The If-Match header value.ifNoneMatchHeaderValue - The If-None-Match header value.public URI getBaseURL()
public String getAuthenticatedUserID()
null if the request is
not authenticated.public ResourceDescriptor getResourceDescriptor()
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
null if this request is not initiated by a servlet.public void checkPreconditions(ResourceNotFoundException exception) throws SCIMException
exception - The ResourceNotFoundException that would've been thrown
if the preconditions are met.SCIMException - if preconditions have not been met.public void checkPreconditions(javax.ws.rs.core.EntityTag currentVersion) throws SCIMException
currentVersion - an ETag for the current version of the resourceSCIMException - if preconditions have not been met.protected void evaluateIfMatch(javax.ws.rs.core.EntityTag eTag, String headerValue) throws SCIMException
eTag - The current eTag.headerValue - The If-Match header value.SCIMException - If a match was not found or parsing error occurs.protected void evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag, String headerValue) throws SCIMException
eTag - The current eTag.headerValue - The If-None-Match header value.SCIMException - If a match was found or parsing error occurs.Copyright © 2011–2016 UnboundID. All rights reserved.