| Package | Description |
|---|---|
| com.unboundid.scim.marshal | |
| com.unboundid.scim.marshal.json | |
| com.unboundid.scim.marshal.xml | |
| com.unboundid.scim.sdk | |
| com.unboundid.scim.wink |
| Modifier and Type | Method and Description |
|---|---|
SCIMException |
Unmarshaller.unmarshalError(InputStream inputStream)
Reads a SCIM error response from an input stream.
|
| Modifier and Type | Method and Description |
|---|---|
void |
StreamMarshaller.marshal(SCIMException response)
Write a SCIM error response.
|
void |
Marshaller.marshal(SCIMException response,
OutputStream outputStream)
Write a SCIM error response to an output stream.
|
| Modifier and Type | Method and Description |
|---|---|
void |
StreamMarshaller.bulkMarshal(int failOnErrors,
List<BulkOperation> operations)
Write the content of a SCIM bulk operation request or response.
|
void |
Marshaller.bulkMarshal(OutputStream outputStream,
int failOnErrors,
List<BulkOperation> operations)
Write the content of a SCIM bulk operation request or response to an
output stream.
|
void |
Unmarshaller.bulkUnmarshal(File file,
BulkConfig bulkConfig,
BulkContentHandler handler)
Reads a SCIM bulk request or response from a file.
|
void |
Unmarshaller.bulkUnmarshal(InputStream inputStream,
BulkConfig bulkConfig,
BulkContentHandler handler)
Reads a SCIM bulk request or response from an input stream.
|
void |
StreamMarshaller.close()
Close the marshaller.
|
void |
StreamMarshaller.marshal(BaseResource resource)
Write a SCIM object.
|
void |
Marshaller.marshal(BaseResource resource,
OutputStream outputStream)
Write a SCIM object to an output stream.
|
void |
StreamMarshaller.marshal(Resources<? extends BaseResource> response)
Write a SCIM query response.
|
void |
Marshaller.marshal(Resources<? extends BaseResource> response,
OutputStream outputStream)
Write a SCIM listing response to an output stream.
|
void |
StreamMarshaller.marshal(SCIMException response)
Write a SCIM error response.
|
void |
Marshaller.marshal(SCIMException response,
OutputStream outputStream)
Write a SCIM error response to an output stream.
|
void |
StreamMarshaller.writeBulkFinish()
Write the end of a bulk request or response.
|
void |
StreamMarshaller.writeBulkOperation(BulkOperation o)
Write a bulk operation to a bulk request or response.
|
void |
StreamMarshaller.writeBulkStart(int failOnErrors,
Set<String> schemaURIs)
Write the start of a bulk request or response.
|
| Modifier and Type | Method and Description |
|---|---|
SCIMException |
JsonUnmarshaller.unmarshalError(InputStream inputStream)
Reads a SCIM error response from an input stream.
|
| Modifier and Type | Method and Description |
|---|---|
void |
JsonStreamMarshaller.marshal(SCIMException response)
Write a SCIM error response.
|
void |
JsonMarshaller.marshal(SCIMException response,
OutputStream outputStream)
Write a SCIM error response to an output stream.
|
| Modifier and Type | Method and Description |
|---|---|
void |
JsonStreamMarshaller.bulkMarshal(int failOnErrors,
List<BulkOperation> operations)
Write the content of a SCIM bulk operation request or response.
|
void |
JsonMarshaller.bulkMarshal(OutputStream outputStream,
int failOnErrors,
List<BulkOperation> operations)
Write the content of a SCIM bulk operation request or response to an
output stream.
|
void |
JsonUnmarshaller.bulkUnmarshal(File file,
BulkConfig bulkConfig,
BulkContentHandler handler)
Reads a SCIM bulk request or response from a file.
|
void |
JsonUnmarshaller.bulkUnmarshal(InputStream inputStream,
BulkConfig bulkConfig,
BulkContentHandler handler)
Reads a SCIM bulk request or response from an input stream.
|
void |
JsonStreamMarshaller.close()
Close the marshaller.
|
void |
JsonStreamMarshaller.marshal(BaseResource resource)
Write a SCIM object.
|
void |
JsonMarshaller.marshal(BaseResource resource,
OutputStream outputStream)
Write a SCIM object to an output stream.
|
void |
JsonStreamMarshaller.marshal(Resources<? extends BaseResource> response)
Write a SCIM query response.
|
void |
JsonMarshaller.marshal(Resources<? extends BaseResource> response,
OutputStream outputStream)
Write a SCIM listing response to an output stream.
|
void |
JsonStreamMarshaller.marshal(SCIMException response)
Write a SCIM error response.
|
void |
JsonMarshaller.marshal(SCIMException response,
OutputStream outputStream)
Write a SCIM error response to an output stream.
|
void |
JsonBulkParser.unmarshal()
Reads a SCIM bulk request or response from the input stream.
|
void |
JsonStreamMarshaller.writeBulkFinish()
Write the end of a bulk request or response.
|
void |
JsonStreamMarshaller.writeBulkOperation(BulkOperation o)
Write a bulk operation to a bulk request or response.
|
void |
JsonStreamMarshaller.writeBulkStart(int failOnErrors,
Set<String> schemaURIs)
Write the start of a bulk request or response.
|
| Constructor and Description |
|---|
JsonStreamMarshaller(OutputStream outputStream)
Create a JSON marshaller that writes to the given output stream.
|
| Modifier and Type | Method and Description |
|---|---|
SCIMException |
XmlUnmarshaller.unmarshalError(InputStream inputStream)
Reads a SCIM error response from an input stream.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XmlStreamMarshaller.marshal(SCIMException response)
Write a SCIM error response.
|
void |
XmlMarshaller.marshal(SCIMException response,
OutputStream outputStream)
Write a SCIM error response to an output stream.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XmlStreamMarshaller.bulkMarshal(int failOnErrors,
List<BulkOperation> operations)
Write the content of a SCIM bulk operation request or response.
|
void |
XmlMarshaller.bulkMarshal(OutputStream outputStream,
int failOnErrors,
List<BulkOperation> operations)
Write the content of a SCIM bulk operation request or response to an
output stream.
|
void |
XmlUnmarshaller.bulkUnmarshal(File file,
BulkConfig bulkConfig,
BulkContentHandler handler)
Reads a SCIM bulk request or response from a file.
|
void |
XmlUnmarshaller.bulkUnmarshal(InputStream inputStream,
BulkConfig bulkConfig,
BulkContentHandler handler)
Reads a SCIM bulk request or response from an input stream.
|
void |
XmlStreamMarshaller.close()
Close the marshaller.
|
void |
XmlStreamMarshaller.marshal(BaseResource resource)
Write a SCIM object.
|
void |
XmlMarshaller.marshal(BaseResource resource,
OutputStream outputStream)
Write a SCIM object to an output stream.
|
void |
XmlStreamMarshaller.marshal(Resources<? extends BaseResource> response)
Write a SCIM query response.
|
void |
XmlMarshaller.marshal(Resources<? extends BaseResource> resources,
OutputStream outputStream)
Write a SCIM listing response to an output stream.
|
void |
XmlStreamMarshaller.marshal(SCIMException response)
Write a SCIM error response.
|
void |
XmlMarshaller.marshal(SCIMException response,
OutputStream outputStream)
Write a SCIM error response to an output stream.
|
void |
XmlBulkParser.unmarshal()
Reads a SCIM bulk request or response from the input stream.
|
void |
XmlStreamMarshaller.writeBulkFinish()
Write the end of a bulk request or response.
|
void |
XmlStreamMarshaller.writeBulkOperation(BulkOperation o)
Write a bulk operation to a bulk request or response.
|
void |
XmlStreamMarshaller.writeBulkStart(int failOnErrors,
Set<String> schemaURIs)
Write the start of a bulk request or response.
|
| Constructor and Description |
|---|
XmlStreamMarshaller(OutputStream outputStream)
Create a new XML marshaller that writes to the provided output stream.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConnectException
Signals a problem connecting to the service provider.
|
class |
ForbiddenException
Signals the server does not support the requested operation.
|
class |
InvalidResourceException
Signals an error while looking up resources and attributes.
|
class |
NotModifiedException
Signals the Resource has not changed on the server since last retrieved
This exception corresponds to HTTP response code
304 NOT MODIFIED.
|
class |
PreconditionFailedException
Signals server failed to update as Resource changed on the server since last
retrieved
This exception corresponds to HTTP response code
412 PRECONDITION FAILED.
|
class |
RequestEntityTooLargeException
Signals the request entity is larger than then the limit imposed by the
server.
|
class |
ResourceConflictException
Signals the specified version number does not match the resource's latest
version number or a Service Provider refused to create a new,
duplicate resource.
|
class |
ResourceNotFoundException
Signals the specified resource; e.g., User, does not exist.
|
class |
ServerErrorException
Signals an internal error from the service provider.
|
class |
UnauthorizedException
Signals an authorization failure from the service provider.
|
class |
UnsupportedOperationException
Signals the service provider does not support the requested operation.
|
| Modifier and Type | Method and Description |
|---|---|
static SCIMException |
SCIMException.createException(int statusCode,
String errorMessage)
Create the appropriate SCIMException from the provided information.
|
static SCIMException |
SCIMException.createException(int statusCode,
String errorMessage,
Exception cause)
Create the appropriate SCIMException from the provided information.
|
SCIMException |
BulkException.getCause() |
| Modifier and Type | Method and Description |
|---|---|
void |
SCIMRequest.checkPreconditions(javax.ws.rs.core.EntityTag currentVersion)
Evaluate request preconditions based on the passed in current version.
|
void |
SCIMRequest.checkPreconditions(ResourceNotFoundException exception)
Evaluate request preconditions for a resource that does not currently
exist.
|
R |
SCIMEndpoint.create(R resource,
String... requestedAttributes)
Create the specified resource instance at the service provider and return
only the specified attributes from the newly inserted resource.
|
void |
SCIMEndpoint.delete(R resource)
Delete the specified resource instance.
|
void |
SCIMEndpoint.delete(String id)
Deprecated.
|
void |
SCIMEndpoint.delete(String id,
String etag)
Delete the resource instance specified by the provided ID.
|
abstract void |
SCIMBackend.deleteResource(DeleteResourceRequest request)
Delete a specific resource.
|
void |
ResourceSchemaBackend.deleteResource(DeleteResourceRequest request)
Delete a specific resource.
|
protected void |
SCIMRequest.evaluateIfMatch(javax.ws.rs.core.EntityTag eTag,
String headerValue)
Evaluate If-Match header against the provided eTag.
|
protected void |
SCIMRequest.evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag,
String headerValue)
Evaluate If-None-Match header against the provided eTag.
|
protected void |
GetResourceRequest.evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag,
String headerValue)
Evaluate If-None-Match header against the provided eTag.
|
R |
SCIMEndpoint.get(String id)
Retrieves a resource instance given the ID.
|
R |
SCIMEndpoint.get(String id,
String etag,
String... requestedAttributes)
Retrieves a resource instance given the ID, only if the current version
has been modified.
|
SCIMEndpoint<BaseResource> |
SCIMService.getEndpoint(String endpointPath)
Returns a SCIMEndpoint for the specified endpoint.
|
<R extends BaseResource> |
SCIMService.getEndpoint(String endpointPath,
ResourceFactory<R> resourceFactory)
Returns a SCIMEndpoint for the specified endpoint.
|
abstract BaseResource |
SCIMBackend.getResource(GetResourceRequest request)
Retrieve all or selected attributes of a resource.
|
ResourceDescriptor |
ResourceSchemaBackend.getResource(GetResourceRequest request)
Retrieve all or selected attributes of a resource.
|
ResourceDescriptor |
SCIMService.getResourceDescriptor(String resourceName,
String schema)
Retrieves the ResourceDescriptor for the specified resource from the
SCIM service provider.
|
ResourceDescriptor |
SCIMService.getResourceDescriptorForEndpoint(String endpoint)
Retrieves the ResourceDescriptor for the specified endpoint from the
SCIM service provider.
|
abstract Resources |
SCIMBackend.getResources(GetResourcesRequest request)
Retrieve selected resources.
|
Resources |
ResourceSchemaBackend.getResources(GetResourcesRequest request)
Retrieve selected resources.
|
ServiceProviderConfig |
SCIMService.getServiceProviderConfig()
Retrieves the Service Provider Config from the SCIM service provider.
|
boolean |
BulkContentHandler.handleException(int opIndex,
BulkException bulkException)
Handle an exception encountered when processing an individual operation.
|
void |
BulkContentHandler.handleOperation(int opIndex,
BulkOperation bulkOperation)
Handle an individual operation.
|
SCIMFilter |
FilterParser.parse()
Parse the filter provided in the constructor.
|
static SCIMFilter |
SCIMFilter.parse(String filterString)
Parse a filter from its string representation.
|
static SCIMFilter |
SCIMFilter.parse(String filterString,
String defaultSchema)
Parse a filter from its string representation.
|
abstract BaseResource |
SCIMBackend.patchResource(PatchResourceRequest request)
Update the contents of an existing resource with attributes specified.
|
BaseResource |
ResourceSchemaBackend.patchResource(PatchResourceRequest request)
Update the contents of an existing resource with attributes specified.
|
abstract BaseResource |
SCIMBackend.postResource(PostResourceRequest request)
Create a new resource.
|
BaseResource |
ResourceSchemaBackend.postResource(PostResourceRequest request)
Create a new resource.
|
BulkResponse |
SCIMService.processBulkRequest(List<BulkOperation> operations)
Invoke a bulk request.
|
BulkResponse |
SCIMService.processBulkRequest(List<BulkOperation> operations,
int failOnErrors)
Invoke a bulk request.
|
BulkResponse |
BulkEndpoint.processRequest(List<BulkOperation> operations,
int failOnErrors)
Retrieves the response to the bulk request.
|
abstract BaseResource |
SCIMBackend.putResource(PutResourceRequest request)
Replace the contents of an existing resource.
|
BaseResource |
ResourceSchemaBackend.putResource(PutResourceRequest request)
Replace the contents of an existing resource.
|
Resources<R> |
SCIMEndpoint.query(String filter)
Retrieves all resource instances that match the provided filter.
|
Resources<R> |
SCIMEndpoint.query(String filter,
SortParameters sortParameters,
PageParameters pageParameters,
Map<String,String> additionalQueryParams,
String... requestedAttributes)
Retrieves all resource instances that match the provided filter.
|
Resources<R> |
SCIMEndpoint.query(String filter,
SortParameters sortParameters,
PageParameters pageParameters,
String... requestedAttributes)
Retrieves all resource instances that match the provided filter.
|
R |
SCIMEndpoint.update(R resource)
Update the existing resource with the one provided (using the HTTP PUT
method).
|
R |
SCIMEndpoint.update(R resource,
List<SCIMAttribute> attributesToUpdate,
List<String> attributesToDelete)
Update the existing resource with the one provided (using the HTTP PATCH
method).
|
R |
SCIMEndpoint.update(R resource,
String etag,
String... requestedAttributes)
Deprecated.
|
void |
SCIMEndpoint.update(String id,
List<SCIMAttribute> attributesToUpdate,
List<String> attributesToDelete)
Deprecated.
|
R |
SCIMEndpoint.update(String id,
String etag,
List<SCIMAttribute> attributesToUpdate,
List<String> attributesToDelete,
String... requestedAttributes)
Update the existing resource with the one provided (using the HTTP PATCH
method).
|
R |
SCIMEndpoint.update(String id,
String etag,
R resource,
String... requestedAttributes)
Update the existing resource with the one provided (using the HTTP PUT
method).
|
void |
BulkStreamResponse.writeBulkOperation(BulkOperation o)
Write a bulk operation to the response.
|
| Constructor and Description |
|---|
BulkException(SCIMException throwable,
BulkOperation.Method method,
String bulkId,
String path) |
| Constructor and Description |
|---|
BulkStreamResponse(SCIMApplication application,
RequestContext requestContext)
Create a new bulk stream response.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SCIMApplication.acquireBulkRequestPermit()
Attempt to acquire a permit to process a bulk request.
|
boolean |
BulkContentRequestHandler.handleException(int opIndex,
BulkException bulkException)
Handle an exception encountered when processing an individual operation.
|
void |
BulkContentRequestHandler.handleOperation(int opIndex,
BulkOperation bulkOperation)
Handle an individual operation.
|
Copyright © 2011–2016 UnboundID. All rights reserved.