com.unboundid.scim.sdk

Class GetResourceRequest

java.lang.Object

com.unboundid.scim.sdk.SCIMRequest

com.unboundid.scim.sdk.ResourceReturningRequest

com.unboundid.scim.sdk.GetResourceRequest

public final class GetResourceRequest
extends ResourceReturningRequest

This class represents a SCIM Get Resource request to retrieve all or selected attributes from a single resource.

Constructor Summary

Constructors

Constructor and Description
GetResourceRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor, String resourceID, SCIMQueryAttributes attributes) Create a new SCIM Get Resource request from the provided information.
GetResourceRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor, String resourceID, SCIMQueryAttributes attributes, javax.servlet.http.HttpServletRequest httpServletRequest) Create a new SCIM Get Resource request from the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag, String headerValue) Evaluate If-None-Match header against the provided eTag.
String	getResourceID() Get the requested resource ID.

Methods inherited from class com.unboundid.scim.sdk.ResourceReturningRequest

getAttributes

Methods inherited from class com.unboundid.scim.sdk.SCIMRequest

checkPreconditions, checkPreconditions, evaluateIfMatch, getAuthenticatedUserID, getBaseURL, getHttpServletRequest, getResourceDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

GetResourceRequest

public GetResourceRequest(URI baseURL,
                  String authenticatedUserID,
                  ResourceDescriptor resourceDescriptor,
                  String resourceID,
                  SCIMQueryAttributes attributes)

Create a new SCIM Get Resource 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.

resourceID - The requested resource ID.

attributes - The set of requested attributes.

GetResourceRequest

public GetResourceRequest(URI baseURL,
                  String authenticatedUserID,
                  ResourceDescriptor resourceDescriptor,
                  String resourceID,
                  SCIMQueryAttributes attributes,
                  javax.servlet.http.HttpServletRequest httpServletRequest)

Create a new SCIM Get Resource 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.

resourceID - The requested resource ID.

attributes - The set of requested attributes.

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

Method Detail

getResourceID

public String getResourceID()

Get the requested resource ID.

Returns:

The requested resource ID.

evaluateIfNoneMatch

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

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

Overrides:

evaluateIfNoneMatch in class SCIMRequest

Parameters:

eTag - The current eTag.

headerValue - The If-None-Match header value.

Throws:

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