Package org.apache.cxf.sts.rest

Interface RESTSecurityTokenService

All Known Implementing Classes:

RESTSecurityTokenServiceImpl

@Path("/token")
public interface RESTSecurityTokenService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RESTSecurityTokenService.Action

Method Summary

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

Method Details

getXMLToken

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

Returns:

Issues required token type with default token settings.

getJSONToken

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

getPlainToken

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

getToken

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

removeToken

@DELETE
@Path("/")
@Produces({"application/xml","application/json"})
jakarta.ws.rs.core.Response removeToken(RequestSecurityTokenType request)

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

Parameters:

request -

Returns:

getKeyExchangeToken

@POST
@Path("KeyExchangeToken")
@Produces({"application/xml","application/json"})
jakarta.ws.rs.core.Response getKeyExchangeToken(RequestSecurityTokenType request)