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

public class AuthenticationController
extends AbstractResourceController

User authentication controller.

Field Summary

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

applicationManager, applicationService

Constructor Summary

Constructors

Constructor and Description
AuthenticationController(ApplicationService applicationService, ApplicationManager applicationManager)

Method Summary

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

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

getApplication

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationController

public AuthenticationController(ApplicationService applicationService,
                                ApplicationManager applicationManager)

Method Detail

authenticateUser

public UserEntity authenticateUser(String applicationName,
                                   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:

applicationName - name of the application

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