com.sun.identity.rest

Class CoreTokenResource

java.lang.Object

com.sun.identity.rest.ResourceBase

com.sun.identity.rest.CoreTokenResource

@Path(value="/1/token")
public class CoreTokenResource
extends ResourceBase

Defines REST resources for Core Token Service.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.identity.rest.ResourceBase

ResourceBase.MimeType

Field Summary

Fields inherited from class com.sun.identity.rest.ResourceBase

BODY, STATUS_CODE, STATUS_MESSAGE

Constructor Summary

Constructors

Constructor and Description
CoreTokenResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createToken(javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request, String msgBody) Creates a token.
void	deleteToken(javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request, String tokenId) Deletes a token.
javax.ws.rs.core.Response	readToken(javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request, String tokenId) Reads token attributes.
String	searchTokens(javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Searches tokens.
void	updateToken(javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request, String tokenId, String eTag, String msgBody) Updates a token.

Methods inherited from class com.sun.identity.rest.ResourceBase

createResponseJSONString, createResponseJSONString, createResponseJSONString, createStringResponseJSONString, getCaller, getLocalizedMessage, getSubject, getUserLocale, getWebApplicationException, getWebApplicationException, getWebApplicationException, getWebApplicationException, getWebApplicationException, toSubject, toSubject

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreTokenResource

public CoreTokenResource()

Method Detail

createToken

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createToken(@Context
                                                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                                                             @Context
                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                             String msgBody)

Creates a token.

Parameters:

headers - HTTPHeaders object of the request.

request - HTTPServletRequest object of the request.

msgBody - Message body containing the JSON-encoded token attributes.

Returns:

JSON-encoded token.id attribute of the new token.

readToken

@GET
 @Produces(value="application/json")
 @Path(value="{token.id}")
public javax.ws.rs.core.Response readToken(@Context
                                                                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                                                                @Context
                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                @PathParam(value="token.id")
                                                                                                                String tokenId)

Reads token attributes.

Parameters:

headers - HTTPHeaders object of the request.

request - HTTPServletRequest object of the request.

tokenId - token.id of the token to be retrieved.

Returns:

JSON-encoded token attributes.

updateToken

@PUT
 @Consumes(value="application/json")
 @Path(value="{token.id}")
public void updateToken(@Context
                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                             @Context
                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                             @PathParam(value="token.id")
                                                                                             String tokenId,
                                                                                             @HeaderParam(value="If-Match")
                                                                                             String eTag,
                                                                                             String msgBody)

Updates a token.

Parameters:

headers - HTTPHeaders object of the request.

request - HTTPServletRequest object of the request.

tokenId - value of token.id in the request path parameter.

eTag - value of the If-Match header in the request.

msgBody - Message body containing the JSON-encoded token attributes.

deleteToken

@DELETE
 @Path(value="{token.id}")
public void deleteToken(@Context
                                                           javax.ws.rs.core.HttpHeaders headers,
                                                           @Context
                                                           javax.servlet.http.HttpServletRequest request,
                                                           @PathParam(value="token.id")
                                                           String tokenId)

Deletes a token.

Parameters:

headers - HTTPHeaders object of the request.

request - HTTPServletRequest object of the request.

tokenId - value of token.id in the request path parameter.

searchTokens

@GET
 @Produces(value="application/json")
public String searchTokens(@Context
                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                     @Context
                                                                     javax.servlet.http.HttpServletRequest request)

Searches tokens.

Parameters:

headers - HTTPHeaders object of the request.

request - HTTPServletRequest object of the request.

Returns:

JSON array of tokens matching the queryString