com.unboundid.scim.sdk

Class GetResourcesRequest

java.lang.Object

com.unboundid.scim.sdk.SCIMRequest

com.unboundid.scim.sdk.ResourceReturningRequest

com.unboundid.scim.sdk.GetResourcesRequest

public class GetResourcesRequest
extends ResourceReturningRequest

This class represents a SCIM Get Resources request to retrieve selected resources.

Constructor Summary

Constructors

Constructor and Description
GetResourcesRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor, SCIMFilter filter, String baseID, String searchScope, SortParameters sortParameters, PageParameters pageParameters, SCIMQueryAttributes attributes) Create a new SCIM Get Resource request from the provided information.
GetResourcesRequest(URI baseURL, String authenticatedUserID, ResourceDescriptor resourceDescriptor, SCIMFilter filter, String baseID, String searchScope, SortParameters sortParameters, PageParameters pageParameters, 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
String	getBaseID() Retrieve the base-id parameter of the request.
SCIMFilter	getFilter() Retrieve the filter parameters of the request.
PageParameters	getPageParameters() Retrieve the pagination parameters of the request.
String	getSearchScope() Retrieve the scope parameter of the request.
SortParameters	getSortParameters() Retrieve the sorting parameters of the request.

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

getAttributes

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GetResourcesRequest

public GetResourcesRequest(URI baseURL,
                   String authenticatedUserID,
                   ResourceDescriptor resourceDescriptor,
                   SCIMFilter filter,
                   String baseID,
                   String searchScope,
                   SortParameters sortParameters,
                   PageParameters pageParameters,
                   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.

filter - The filter parameters of the request.

baseID - The SCIM resource ID of the search base entry, or null.

searchScope - The LDAP search scope to use, or null if the default (whole-subtree) should be used.

sortParameters - The sorting parameters of the request.

pageParameters - The pagination parameters of the request.

attributes - The set of requested attributes.

GetResourcesRequest

public GetResourcesRequest(URI baseURL,
                   String authenticatedUserID,
                   ResourceDescriptor resourceDescriptor,
                   SCIMFilter filter,
                   String baseID,
                   String searchScope,
                   SortParameters sortParameters,
                   PageParameters pageParameters,
                   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.

filter - The filter parameters of the request.

baseID - The SCIM resource ID of the search base entry, or null.

searchScope - The LDAP search scope to use, or null if the default (whole-subtree) should be used.

sortParameters - The sorting parameters of the request.

pageParameters - The pagination parameters of the request.

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

getFilter

public SCIMFilter getFilter()

Retrieve the filter parameters of the request.

Returns:

The filter parameters of the request.

getBaseID

public String getBaseID()

Retrieve the base-id parameter of the request.

Returns:

The base-id parameter of the request.

getSearchScope

public String getSearchScope()

Retrieve the scope parameter of the request.

Returns:

The scope parameter of the request.

getSortParameters

public SortParameters getSortParameters()

Retrieve the sorting parameters of the request.

Returns:

The sorting parameters of the request.

getPageParameters

public PageParameters getPageParameters()

Retrieve the pagination parameters of the request.

Returns:

The pagination parameters of the request.