com.atlassian.crowd.plugin.rest.service.controller

Class AuthenticationController

java.lang.Object

com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

com.atlassian.crowd.plugin.rest.service.controller.AuthenticationController

@Named
public class AuthenticationController
extends AbstractResourceController

User authentication controller.

Constructor Summary

Constructors

Constructor and Description
AuthenticationController(ApplicationService applicationService, AuthenticatedApplicationHolder authenticatedApplicationHolder)

Method Summary

Modifier and Type	Method and Description
UserEntity	authenticateUser(String username, PasswordEntity password, URI baseUri) Authenticates the user with the given username and password.
UserEntity	userAuthenticated(String username, URI baseUri)

Methods inherited from class com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

getAuthenticatedApplication

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationController

@Inject
public AuthenticationController(ApplicationService applicationService,
                                        AuthenticatedApplicationHolder authenticatedApplicationHolder)

Method Detail

authenticateUser

public UserEntity authenticateUser(String username,
                                   PasswordEntity password,
                                   URI baseUri)
                            throws UserNotFoundException,
                                   ExpiredCredentialException,
                                   InactiveAccountException,
                                   InvalidAuthenticationException,
                                   OperationFailedException

Authenticates the user with the given username and password. Does not generate a token.

Parameters:

username - username to authenticate the user

password - password to authenticate the user

baseUri - Base URI of the REST service

Returns:

UserEntity if the authentication succeeded

Throws:

ExpiredCredentialException - if the user's credentials have expired.

InactiveAccountException - if the user's account is inactive.

InvalidAuthenticationException - if the authentication details provided are not valid, or if the user does not exist.

OperationFailedException - if the underlying directory implementation failed to execute the operation.

UserNotFoundException

userAuthenticated

public UserEntity userAuthenticated(String username,
                                    URI baseUri)
                             throws UserNotFoundException,
                                    OperationFailedException,
                                    InactiveAccountException,
                                    InvalidAuthenticationException

Throws:

UserNotFoundException

OperationFailedException

InactiveAccountException

InvalidAuthenticationException