com.unboundid.scim.sdk

Class SCIMRequest

java.lang.Object

com.unboundid.scim.sdk.SCIMRequest

Direct Known Subclasses:

DeleteResourceRequest, ResourceReturningRequest

public abstract class SCIMRequest
extends Object

This class is the base class for all SCIM requests.

Constructor Summary

Constructors

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.

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCIMRequest

public SCIMRequest(URI baseURL,
           String authenticatedUserID,
           ResourceDescriptor resourceDescriptor)

Create a new SCIM request from the provided information.

Parameters:

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.

SCIMRequest

public SCIMRequest(URI baseURL,
           String authenticatedUserID,
           ResourceDescriptor resourceDescriptor,
           javax.servlet.http.HttpServletRequest httpServletRequest)

Create a new SCIM request from the provided information.

Parameters:

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.

SCIMRequest

public 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.

Parameters:

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.

Method Detail

getBaseURL

public URI getBaseURL()

Retrieve the base URL for the SCIM service.

Returns:

The base URL for the SCIM service.

getAuthenticatedUserID

public String getAuthenticatedUserID()

Get the authenticated user ID.

Returns:

The authenticated user ID or null if the request is not authenticated.

getResourceDescriptor

public ResourceDescriptor getResourceDescriptor()

Get ResourceDescriptor associated with this request.

Returns:

The ResourceDescriptor associated with this request.

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Get the HTTP servlet request associated with this request.

Returns:

The HTTP servlet request associated with this request or null if this request is not initiated by a servlet.

checkPreconditions

public void checkPreconditions(ResourceNotFoundException exception)
                        throws SCIMException

Evaluate request preconditions for a resource that does not currently exist. The primary use of this method is to support the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.24"> If-Match: *</a> and <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26"> If-None-Match: *</a> preconditions.

Parameters:

exception - The ResourceNotFoundException that would've been thrown if the preconditions are met.

Throws:

SCIMException - if preconditions have not been met.

checkPreconditions

public void checkPreconditions(javax.ws.rs.core.EntityTag currentVersion)
                        throws SCIMException

Evaluate request preconditions based on the passed in current version.

Parameters:

currentVersion - an ETag for the current version of the resource

Throws:

SCIMException - if preconditions have not been met.

evaluateIfMatch

protected void evaluateIfMatch(javax.ws.rs.core.EntityTag eTag,
                   String headerValue)
                        throws SCIMException

Evaluate If-Match header against the provided eTag.

Parameters:

eTag - The current eTag.

headerValue - The If-Match header value.

Throws:

SCIMException - If a match was not found or parsing error occurs.

evaluateIfNoneMatch

protected void evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag,
                       String headerValue)
                            throws SCIMException

Evaluate If-None-Match header against the provided eTag.

Parameters:

eTag - The current eTag.

headerValue - The If-None-Match header value.

Throws:

SCIMException - If a match was found or parsing error occurs.