com.unboundid.scim.wink
Class SCIMResource

java.lang.Object
  org.apache.wink.common.AbstractDynamicResource
      com.unboundid.scim.wink.AbstractSCIMResource
          com.unboundid.scim.wink.SCIMResource

All Implemented Interfaces:

org.apache.wink.common.DynamicResource

public class SCIMResource
extends AbstractSCIMResource

This class is a Wink dynamic resource implementation for operations on a SCIM resource. The set of supported resources and their endpoints are not known until run-time hence it must be implemented as a dynamic resource.

Constructor Summary

SCIMResource(ResourceDescriptor resourceDescriptor, ResourceStats resourceStats, SCIMBackend backend)
Create a new SCIM wink resource for operations on a SCIM endpoint.

Method Summary

javax.ws.rs.core.Response	doDotJsonDelete(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the DELETE operation on a specified user resource where the URL specifies JSON content type.
javax.ws.rs.core.Response	doDotJsonGet(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the GET operation on a specified user resource where the URL specifies JSON content type.
javax.ws.rs.core.Response	doDotJsonPut(InputStream inputStream, String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the PUT operation where the URL specifies JSON format.
javax.ws.rs.core.Response	doDotXmlDelete(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the DELETE operation on a specified user resource where the URL specifies XML content type.
javax.ws.rs.core.Response	doDotXmlGet(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the GET operation on a specified user resource where the URL specifies XML content type.
javax.ws.rs.core.Response	doDotXmlPut(InputStream inputStream, String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the PUT operation where the URL specifies XML format.
javax.ws.rs.core.Response	doJsonDelete(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the DELETE operation on a specified user resource producing JSON format.
javax.ws.rs.core.Response	doJsonGet(javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, String filterString, String sortBy, String sortOrder, String pageStartIndex, String pageSize) Implement the GET query operation producing JSON format.
javax.ws.rs.core.Response	doJsonGet(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the GET operation on a specified user resource producing JSON format.
javax.ws.rs.core.Response	doJsonJsonPost(InputStream inputStream, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the POST operation consuming and producing JSON format.
javax.ws.rs.core.Response	doJsonJsonPut(InputStream inputStream, String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the PUT operation consuming and producing JSON format.
javax.ws.rs.core.Response	doJsonXmlPost(InputStream inputStream, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the POST operation consuming JSON format and producing XML format.
javax.ws.rs.core.Response	doJsonXmlPut(InputStream inputStream, String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the PUT operation consuming JSON format and producing XML format.
javax.ws.rs.core.Response	doXmlDelete(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the DELETE operation on a specified user resource producing XML format.
javax.ws.rs.core.Response	doXmlGet(javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, String filterString, String sortBy, String sortOrder, String pageStartIndex, String pageSize) Implement the GET query operation producing XML format.
javax.ws.rs.core.Response	doXmlGet(String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the GET operation on a specified user resource producing XML format.
javax.ws.rs.core.Response	doXmlJsonPost(InputStream inputStream, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the POST operation consuming XML format and producing JSON format.
javax.ws.rs.core.Response	doXmlJsonPut(InputStream inputStream, String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the PUT operation consuming XML format and producing JSON format.
javax.ws.rs.core.Response	doXmlXmlPost(InputStream inputStream, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the POST operation consuming and producing XML format.
javax.ws.rs.core.Response	doXmlXmlPut(InputStream inputStream, String userID, javax.servlet.ServletContext servletContext, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the PUT operation consuming and producing XML format.

Methods inherited from class com.unboundid.scim.wink.AbstractSCIMResource

getUsers

Methods inherited from class org.apache.wink.common.AbstractDynamicResource

getBeanName, getCollectionTitle, getParent, getPath, getWorkspaceTitle, setBeanName, setCollectionTitle, setParent, setPath, setWorkspaceTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

SCIMResource

public SCIMResource(ResourceDescriptor resourceDescriptor,
                    ResourceStats resourceStats,
                    SCIMBackend backend)

Create a new SCIM wink resource for operations on a SCIM endpoint.

Parameters:

resourceDescriptor - The resource descriptor to use.

resourceStats - The ResourceStats instance to use.

backend - The SCIMBackend to use to process requests.

Method Detail

doJsonGet

public javax.ws.rs.core.Response doJsonGet(@Context
                                           javax.servlet.ServletContext servletContext,
                                           @Context
                                           javax.ws.rs.core.SecurityContext securityContext,
                                           @Context
                                           javax.ws.rs.core.HttpHeaders headers,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo,
                                           String filterString,
                                           String sortBy,
                                           String sortOrder,
                                           String pageStartIndex,
                                           String pageSize)

Implement the GET query operation producing JSON format.

Parameters:

servletContext - The servlet context of the current request.

securityContext - The security context of the current request.

headers - The request headers.

uriInfo - The URI info for the request.

filterString - The filter query parameter, or null.

sortBy - The sortBy query parameter, or null.

sortOrder - The sortOrder query parameter, or null.

pageStartIndex - The startIndex query parameter, or null.

pageSize - The count query parameter, or null.

Returns:

The response to the request.

doXmlGet

public javax.ws.rs.core.Response doXmlGet(@Context
                                          javax.servlet.ServletContext servletContext,
                                          @Context
                                          javax.ws.rs.core.SecurityContext securityContext,
                                          @Context
                                          javax.ws.rs.core.HttpHeaders headers,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo,
                                          String filterString,
                                          String sortBy,
                                          String sortOrder,
                                          String pageStartIndex,
                                          String pageSize)

Implement the GET query operation producing XML format.

Parameters:

servletContext - The servlet context of the current request.

securityContext - The security context of the current request.

headers - The request headers.

uriInfo - The URI info for the request.

filterString - The filter query parameter, or null.

sortBy - The sortBy query parameter, or null.

sortOrder - The sortOrder query parameter, or null.

pageStartIndex - The startIndex query parameter, or null.

pageSize - The count query parameter, or null.

Returns:

The response to the request.

doJsonGet

public javax.ws.rs.core.Response doJsonGet(String userID,
                                           @Context
                                           javax.servlet.ServletContext servletContext,
                                           @Context
                                           javax.ws.rs.core.SecurityContext securityContext,
                                           @Context
                                           javax.ws.rs.core.HttpHeaders headers,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)

Implement the GET operation on a specified user resource producing JSON format.

Parameters:

userID - The requested user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doXmlGet

public javax.ws.rs.core.Response doXmlGet(String userID,
                                          @Context
                                          javax.servlet.ServletContext servletContext,
                                          @Context
                                          javax.ws.rs.core.SecurityContext securityContext,
                                          @Context
                                          javax.ws.rs.core.HttpHeaders headers,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)

Implement the GET operation on a specified user resource producing XML format.

Parameters:

userID - The requested user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doDotJsonGet

public javax.ws.rs.core.Response doDotJsonGet(String userID,
                                              @Context
                                              javax.servlet.ServletContext servletContext,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

Implement the GET operation on a specified user resource where the URL specifies JSON content type.

Parameters:

userID - The requested user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doDotXmlGet

public javax.ws.rs.core.Response doDotXmlGet(String userID,
                                             @Context
                                             javax.servlet.ServletContext servletContext,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)

Implement the GET operation on a specified user resource where the URL specifies XML content type.

Parameters:

userID - The requested user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doJsonJsonPost

public javax.ws.rs.core.Response doJsonJsonPost(InputStream inputStream,
                                                @Context
                                                javax.servlet.ServletContext servletContext,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext,
                                                @Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)

Implement the POST operation consuming and producing JSON format.

Parameters:

inputStream - The content to be consumed.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doXmlXmlPost

public javax.ws.rs.core.Response doXmlXmlPost(InputStream inputStream,
                                              @Context
                                              javax.servlet.ServletContext servletContext,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

Implement the POST operation consuming and producing XML format.

Parameters:

inputStream - The content to be consumed.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doXmlJsonPost

public javax.ws.rs.core.Response doXmlJsonPost(InputStream inputStream,
                                               @Context
                                               javax.servlet.ServletContext servletContext,
                                               @Context
                                               javax.ws.rs.core.SecurityContext securityContext,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo)

Implement the POST operation consuming XML format and producing JSON format.

Parameters:

inputStream - The content to be consumed.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doJsonXmlPost

public javax.ws.rs.core.Response doJsonXmlPost(InputStream inputStream,
                                               @Context
                                               javax.servlet.ServletContext servletContext,
                                               @Context
                                               javax.ws.rs.core.SecurityContext securityContext,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo)

Implement the POST operation consuming JSON format and producing XML format.

Parameters:

inputStream - The content to be consumed.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doJsonJsonPut

public javax.ws.rs.core.Response doJsonJsonPut(InputStream inputStream,
                                               String userID,
                                               @Context
                                               javax.servlet.ServletContext servletContext,
                                               @Context
                                               javax.ws.rs.core.SecurityContext securityContext,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo)

Implement the PUT operation consuming and producing JSON format.

Parameters:

inputStream - The content to be consumed.

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doDotJsonPut

public javax.ws.rs.core.Response doDotJsonPut(InputStream inputStream,
                                              String userID,
                                              @Context
                                              javax.servlet.ServletContext servletContext,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

Implement the PUT operation where the URL specifies JSON format.

Parameters:

inputStream - The content to be consumed.

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doDotXmlPut

public javax.ws.rs.core.Response doDotXmlPut(InputStream inputStream,
                                             String userID,
                                             @Context
                                             javax.servlet.ServletContext servletContext,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)

Implement the PUT operation where the URL specifies XML format.

Parameters:

inputStream - The content to be consumed.

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doXmlXmlPut

public javax.ws.rs.core.Response doXmlXmlPut(InputStream inputStream,
                                             String userID,
                                             @Context
                                             javax.servlet.ServletContext servletContext,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)

Implement the PUT operation consuming and producing XML format.

Parameters:

inputStream - The content to be consumed.

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doXmlJsonPut

public javax.ws.rs.core.Response doXmlJsonPut(InputStream inputStream,
                                              String userID,
                                              @Context
                                              javax.servlet.ServletContext servletContext,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

Implement the PUT operation consuming XML format and producing JSON format.

Parameters:

inputStream - The content to be consumed.

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doJsonXmlPut

public javax.ws.rs.core.Response doJsonXmlPut(InputStream inputStream,
                                              String userID,
                                              @Context
                                              javax.servlet.ServletContext servletContext,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

Implement the PUT operation consuming JSON format and producing XML format.

Parameters:

inputStream - The content to be consumed.

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doJsonDelete

public javax.ws.rs.core.Response doJsonDelete(String userID,
                                              @Context
                                              javax.servlet.ServletContext servletContext,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

Implement the DELETE operation on a specified user resource producing JSON format.

Parameters:

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doXmlDelete

public javax.ws.rs.core.Response doXmlDelete(String userID,
                                             @Context
                                             javax.servlet.ServletContext servletContext,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)

Implement the DELETE operation on a specified user resource producing XML format.

Parameters:

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doDotJsonDelete

public javax.ws.rs.core.Response doDotJsonDelete(String userID,
                                                 @Context
                                                 javax.servlet.ServletContext servletContext,
                                                 @Context
                                                 javax.ws.rs.core.SecurityContext securityContext,
                                                 @Context
                                                 javax.ws.rs.core.HttpHeaders headers,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo uriInfo)

Implement the DELETE operation on a specified user resource where the URL specifies JSON content type.

Parameters:

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.

doDotXmlDelete

public javax.ws.rs.core.Response doDotXmlDelete(String userID,
                                                @Context
                                                javax.servlet.ServletContext servletContext,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext,
                                                @Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)

Implement the DELETE operation on a specified user resource where the URL specifies XML content type.

Parameters:

userID - The target user ID.

servletContext - The servlet context for the request.

securityContext - The security context for the request.

headers - The request headers.

uriInfo - The URI info for the request.

Returns:

The response to the request.