com.unboundid.scim.wink

Class XMLQueryResource

java.lang.Object

com.unboundid.scim.wink.AbstractStaticResource

com.unboundid.scim.wink.AbstractSCIMResource

com.unboundid.scim.wink.XMLQueryResource

@Path(value="{endpoint}.xml")
public class XMLQueryResource
extends AbstractSCIMResource

This class is a Wink dynamic resource implementation for query operations on a SCIM resource where the client requests XML response format in the URL by appending ".xml" on to the endpoint.

Constructor Summary

Constructors

Constructor and Description
XMLQueryResource(SCIMApplication application, OAuthTokenHandler tokenHandler) Create a new SCIM wink resource for XML query operations on a SCIM endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	doJsonDotXmlPost(InputStream inputStream, String endpoint, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Implement the POST operation consuming JSON and producing XML format.
javax.ws.rs.core.Response	doXmlDotXmlPost(InputStream inputStream, String endpoint, javax.servlet.http.HttpServletRequest request, 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	doXmlGet(String endpoint, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, String filterString, String baseID, String searchScope, String sortBy, String sortOrder, String pageStartIndex, String pageSize) Implement the GET operation producing XML format.

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

getUsers

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

setResponseEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLQueryResource

public XMLQueryResource(SCIMApplication application,
                OAuthTokenHandler tokenHandler)

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

Parameters:

application - The SCIM JAX-RS application associated with this resource.

tokenHandler - The token handler to use for OAuth authentication.

Method Detail

doXmlGet

@GET
@Produces(value="application/xml")
public javax.ws.rs.core.Response doXmlGet(@PathParam(value="endpoint")
                                              String endpoint,
                                              @Context
                                              javax.servlet.http.HttpServletRequest request,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo,
                                              @QueryParam(value="filter")
                                              String filterString,
                                              @QueryParam(value="base-id")
                                              String baseID,
                                              @QueryParam(value="scope")
                                              String searchScope,
                                              @QueryParam(value="sortBy")
                                              String sortBy,
                                              @QueryParam(value="sortOrder")
                                              String sortOrder,
                                              @QueryParam(value="startIndex")
                                              String pageStartIndex,
                                              @QueryParam(value="count")
                                              String pageSize)

Implement the GET operation producing XML format.

Parameters:

endpoint - The resource endpoint.

request - The current HTTP servlet 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.

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

searchScope - The LDAP search scope to use, 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.

doXmlDotXmlPost

@POST
@Consumes(value="application/xml")
@Produces(value="application/xml")
public javax.ws.rs.core.Response doXmlDotXmlPost(InputStream inputStream,
                                                               @PathParam(value="endpoint")
                                                               String endpoint,
                                                               @Context
                                                               javax.servlet.http.HttpServletRequest request,
                                                               @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.

endpoint - The resource endpoint.

request - The current HTTP servlet 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.

doJsonDotXmlPost

@POST
@Consumes(value="application/json")
@Produces(value="application/xml")
public javax.ws.rs.core.Response doJsonDotXmlPost(InputStream inputStream,
                                                                @PathParam(value="endpoint")
                                                                String endpoint,
                                                                @Context
                                                                javax.servlet.http.HttpServletRequest request,
                                                                @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 and producing XML format.

Parameters:

inputStream - The content to be consumed.

endpoint - The resource endpoint.

request - The current HTTP servlet 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.