Package com.atlassian.crowd.plugin.rest.service.resource.usermanagement

Class TokenResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

com.atlassian.crowd.plugin.rest.service.resource.usermanagement.TokenResource

@Path("session")
@Produces({"application/xml","application/json"})
@Consumes({"application/xml","application/json"})
public class TokenResource
extends AbstractResource

Crowd SSO Token Resource.

Field Summary

Fields

Modifier and Type	Field	Description
static final IntegerSystemProperty	TOKEN_CACHE_CONTROL_MAX_AGE_SYSTEM_PROPERTY	Set a system property with this name to define the max-age of the 'Cache-Control' header in the response of the token validation and get user operations on this resource.

Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

APPLICATION_SCOPE, request, uriInfo

Constructor Summary

Constructors

Constructor	Description
TokenResource(TokenController tokenController)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	authenticateUser(AuthenticationContextEntity authenticationContext, boolean validatePassword, long durationInSeconds)
jakarta.ws.rs.core.Response	deleteTokensForUser(String username, String exclusionToken)
jakarta.ws.rs.core.Response	getSession(String token)
jakarta.ws.rs.core.Response	invalidateToken(String token)
jakarta.ws.rs.core.Response	validateToken(String token, ValidationFactorEntityList validationFactors)

Methods inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

getApplicationName, getBaseUri, setApplicationName, setRequest, setUriInfo

Methods inherited from class java.lang.Object

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

Field Details

TOKEN_CACHE_CONTROL_MAX_AGE_SYSTEM_PROPERTY

public static final IntegerSystemProperty TOKEN_CACHE_CONTROL_MAX_AGE_SYSTEM_PROPERTY

Set a system property with this name to define the max-age of the 'Cache-Control' header in the response of the token validation and get user operations on this resource. The default value (negative) means that the 'Cache-Control' header will not be sent, which was the previous behaviour until this system property was added.

Constructor Details

TokenResource

@Inject
public TokenResource(TokenController tokenController)

Method Details

authenticateUser

@POST
public jakarta.ws.rs.core.Response authenticateUser(AuthenticationContextEntity authenticationContext,
 @DefaultValue("true") @QueryParam("validate-password")
 boolean validatePassword,
 @DefaultValue("-1") @QueryParam("duration")
 long durationInSeconds)
                                             throws InvalidAuthenticationException,
InactiveAccountException,
ExpiredCredentialException,
ApplicationAccessDeniedException,
OperationFailedException

Throws:

InvalidAuthenticationException

InactiveAccountException

ExpiredCredentialException

ApplicationAccessDeniedException

OperationFailedException

invalidateToken

@DELETE
@Path("{token}")
public jakarta.ws.rs.core.Response invalidateToken(@PathParam("token")
 String token)

validateToken

@POST
@Path("{token}")
public jakarta.ws.rs.core.Response validateToken(@PathParam("token")
 String token,
 ValidationFactorEntityList validationFactors)
                                          throws InvalidTokenException,
ApplicationAccessDeniedException,
OperationFailedException

Throws:

InvalidTokenException

ApplicationAccessDeniedException

OperationFailedException

getSession

@GET
@Path("{token}")
public jakarta.ws.rs.core.Response getSession(@PathParam("token")
 String token)
                                       throws InvalidTokenException,
OperationFailedException,
ApplicationAccessDeniedException

Throws:

InvalidTokenException

OperationFailedException

ApplicationAccessDeniedException

deleteTokensForUser

@DELETE
public jakarta.ws.rs.core.Response deleteTokensForUser(@QueryParam("username")
 String username,
 @QueryParam("exclude")
 String exclusionToken)