org.apache.cxf.sts.rest

Interface RESTSecurityTokenService

All Known Implementing Classes:

RESTSecurityTokenServiceImpl

@Path(value="/token")
public interface RESTSecurityTokenService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RESTSecurityTokenService.Action

Method Summary

Modifier and Type	Method and Description
Response	getJSONToken(String tokenType, String keyType, List<String> requestedClaims, String appliesTo)
Response	getKeyExchangeToken(RequestSecurityTokenType request)
Response	getPlainToken(String tokenType, String keyType, List<String> requestedClaims, String appliesTo)
Response	getToken(RESTSecurityTokenService.Action action, RequestSecurityTokenType request)
Response	getXMLToken(String tokenType, String keyType, List<String> requestedClaims, String appliesTo, boolean wstrustResponse)
Response	removeToken(RequestSecurityTokenType request) Same as getToken(Action, RequestSecurityTokenType) with 'cancel' action.

Method Detail

getXMLToken

@GET
 @Path(value="{tokenType}")
 @Produces(value="application/xml")
Response getXMLToken(@PathParam(value="tokenType")
                                                                                          String tokenType,
                                                                                          @QueryParam(value="keyType")
                                                                                          String keyType,
                                                                                          @QueryParam(value="claim")
                                                                                          List<String> requestedClaims,
                                                                                          @QueryParam(value="appliesTo")
                                                                                          String appliesTo,
                                                                                          @QueryParam(value="wstrustResponse") @DefaultValue(value="false")
                                                                                          boolean wstrustResponse)

Returns:

Issues required token type with default token settings.

getJSONToken

@GET
 @Path(value="{tokenType}")
 @Produces(value="application/json;qs=0.8")
Response getJSONToken(@PathParam(value="tokenType") @DefaultValue(value="jwt")
                                                                                                   String tokenType,
                                                                                                   @QueryParam(value="keyType")
                                                                                                   String keyType,
                                                                                                   @QueryParam(value="claim")
                                                                                                   List<String> requestedClaims,
                                                                                                   @QueryParam(value="appliesTo")
                                                                                                   String appliesTo)

getPlainToken

@GET
 @Path(value="{tokenType}")
 @Produces(value="text/plain;qs=0.9")
Response getPlainToken(@PathParam(value="tokenType")
                                                                                              String tokenType,
                                                                                              @QueryParam(value="keyType")
                                                                                              String keyType,
                                                                                              @QueryParam(value="claim")
                                                                                              List<String> requestedClaims,
                                                                                              @QueryParam(value="appliesTo")
                                                                                              String appliesTo)

getToken

@POST
 @Produces(value={"application/xml","application/json"})
Response getToken(@QueryParam(value="action") @DefaultValue(value="issue")
                                                                                 RESTSecurityTokenService.Action action,
                                                                                 RequestSecurityTokenType request)

removeToken

@DELETE
 @Path(value="/")
 @Produces(value={"application/xml","application/json"})
Response removeToken(RequestSecurityTokenType request)

Same as getToken(Action, RequestSecurityTokenType) with 'cancel' action.

Parameters:

request -

Returns:

getKeyExchangeToken

@POST
 @Path(value="KeyExchangeToken")
 @Produces(value={"application/xml","application/json"})
Response getKeyExchangeToken(RequestSecurityTokenType request)