com.unboundid.scim.wink

Class SCIMApplication

java.lang.Object

javax.ws.rs.core.Application

org.glassfish.jersey.server.ResourceConfig

org.apache.wink.common.WinkApplication

com.unboundid.scim.wink.SCIMApplication

All Implemented Interfaces:

javax.ws.rs.core.Configurable<org.glassfish.jersey.server.ResourceConfig>, javax.ws.rs.core.Configuration, org.glassfish.jersey.ExtendedConfig, org.glassfish.jersey.server.ServerConfig

public class SCIMApplication
extends WinkApplication

This class is a JAX-RS Application that returns the SCIM resource implementations.

Constructor Summary

Constructors

Constructor and Description
SCIMApplication(SCIMBackend backend, OAuthTokenHandler tokenHandler) Create a new SCIMApplication that defines the endpoints provided by the ResourceDescriptors and uses the provided backend to process the request.

Method Summary

Methods

Modifier and Type	Method and Description
void	acquireBulkRequestPermit() Attempt to acquire a permit to process a bulk request.
SCIMBackend	getBackend() Retrieves the SCIMBackend used by this SCIMApplication.
Collection<ResourceStats>	getResourceStats() Retrieves the statistics for the resources being served by this application instance.
ServiceProviderConfig	getServiceProviderConfig() Retrieve the service provider configuration.
ResourceStats	getStatsForResource(String resourceName) Retrieve the stats for a given resource.
File	getTmpDataDir() Return the directory that should be used to store temporary files, or null for the system dependent default temporary-file directory (specified by the system property java.io.tmpdir.
void	releaseBulkRequestPermit() Release a permit to process a bulk request.
void	setBulkMaxConcurrentRequests(int bulkMaxConcurrentRequests) Specify the maximum number of concurrent bulk requests.
void	setBulkMaxOperations(long bulkMaxOperations) Specify the maximum number of operations permitted in a bulk request.
void	setBulkMaxPayloadSize(long bulkMaxPayloadSize) Specify the maximum payload size in bytes of a bulk request.
void	setTmpDataDir(File tmpDataDir) Return the directory that should be used to store temporary files, or null for the system dependent default temporary-file directory (specified by the system property java.io.tmpdir.

Methods inherited from class org.glassfish.jersey.server.ResourceConfig

addProperties, files, files, forApplication, forApplicationClass, forApplicationClass, getApplication, getApplicationName, getClasses, getClassLoader, getConfiguration, getContracts, getInstances, getProperties, getProperty, getPropertyNames, getResources, getRuntimeType, getSingletons, isEnabled, isEnabled, isProperty, isRegistered, isRegistered, packages, packages, property, register, register, register, register, register, register, register, register, registerClasses, registerClasses, registerFinder, registerInstances, registerInstances, registerResources, registerResources, setApplicationName, setClassLoader, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

SCIMApplication

public SCIMApplication(SCIMBackend backend,
               OAuthTokenHandler tokenHandler)

Create a new SCIMApplication that defines the endpoints provided by the ResourceDescriptors and uses the provided backend to process the request.

Parameters:

backend - The backend that should be used to process the requests.

tokenHandler - The OAuthTokenHandler implementation to use (this may be null.

Method Detail

getResourceStats

public Collection<ResourceStats> getResourceStats()

Retrieves the statistics for the resources being served by this application instance.

Returns:

The statistics for the resources being served by this application instance.

getStatsForResource

public ResourceStats getStatsForResource(String resourceName)

Retrieve the stats for a given resource.

Parameters:

resourceName - The name of the resource.

Returns:

The stats for the requested resource.

getServiceProviderConfig

public ServiceProviderConfig getServiceProviderConfig()

Retrieve the service provider configuration.

Returns:

The service provider configuration.

getBackend

public SCIMBackend getBackend()

Retrieves the SCIMBackend used by this SCIMApplication.

Returns:

The SCIMBackend used by this SCIMApplication.

setBulkMaxOperations

public void setBulkMaxOperations(long bulkMaxOperations)

Specify the maximum number of operations permitted in a bulk request.

Parameters:

bulkMaxOperations - The maximum number of operations permitted in a bulk request.

setBulkMaxPayloadSize

public void setBulkMaxPayloadSize(long bulkMaxPayloadSize)

Specify the maximum payload size in bytes of a bulk request.

Parameters:

bulkMaxPayloadSize - The maximum payload size in bytes of a bulk request.

setBulkMaxConcurrentRequests

public void setBulkMaxConcurrentRequests(int bulkMaxConcurrentRequests)

Specify the maximum number of concurrent bulk requests.

Parameters:

bulkMaxConcurrentRequests - The maximum number of concurrent bulk requests.

getTmpDataDir

public File getTmpDataDir()

Return the directory that should be used to store temporary files, or null for the system dependent default temporary-file directory (specified by the system property java.io.tmpdir.

Returns:

The directory that should be used to store temporary files, or null for the system dependent default temporary-file directory.

setTmpDataDir

public void setTmpDataDir(File tmpDataDir)

Return the directory that should be used to store temporary files, or null for the system dependent default temporary-file directory (specified by the system property java.io.tmpdir.

Parameters:

tmpDataDir - The directory that should be used to store temporary files, or null for the system dependent default temporary-file directory.

acquireBulkRequestPermit

public void acquireBulkRequestPermit()
                              throws SCIMException

Attempt to acquire a permit to process a bulk request.

Throws:

SCIMException - If a permit cannot be immediately obtained.

releaseBulkRequestPermit

public void releaseBulkRequestPermit()

Release a permit to process a bulk request.