com.atlassian.jira.bc.security.login
Interface LoginService

All Known Implementing Classes:

LoginServiceImpl

@PublicApi
public interface LoginService

The LoginService keeps track of users login activities.

Since:

v4.0.1

Field Summary

static String

LOGIN_RESULT This is set into the the request for the last login result

Method Summary

LoginResult	authenticate(com.atlassian.crowd.embedded.api.User user, String password) This can be called to see if an user knows the given password.
LoginInfo	getLoginInfo(String userName) This is called to get LoginInfo about a given user.
LoginProperties	getLoginProperties(com.atlassian.crowd.embedded.api.User remoteUser, javax.servlet.http.HttpServletRequest request) Returns loginProperties needed to render the login gadget or login form.
boolean	isElevatedSecurityCheckAlwaysShown()
void	logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Log out of JIRA
void	resetFailedLoginCount(com.atlassian.crowd.embedded.api.User user) This can be called to reset the failed login count of a user

Field Detail

LOGIN_RESULT

static final String LOGIN_RESULT

This is set into the the request for the last login result

See Also:

Constant Field Values

Method Detail

getLoginInfo

LoginInfo getLoginInfo(String userName)

This is called to get LoginInfo about a given user.

Parameters:

userName - the name of the user in play. This MUST not be null.

Returns:

a LoginInfo object

isElevatedSecurityCheckAlwaysShown

boolean isElevatedSecurityCheckAlwaysShown()

Returns:

true if the elevated security check (such as CAPTCHA) is always shown

resetFailedLoginCount

void resetFailedLoginCount(com.atlassian.crowd.embedded.api.User user)

This can be called to reset the failed login count of a user

Parameters:

user - the user to authorise. This MUST not be null.

authenticate

LoginResult authenticate(com.atlassian.crowd.embedded.api.User user,
                         String password)

This can be called to see if an user knows the given password. Services such as SOAP and XML-RPC may use this to validate a request.

If the user requests elevatedSecurity then this will always fail with LoginReason.AUTHENTICATION_DENIED

Parameters:

user - the user to authenticate. This MUST not be null.

password - the password to authenticate against

Returns:

true if the user can be authenticated

logout

void logout(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)

Log out of JIRA

Parameters:

request - the current servlet request

response - the current servlet response

getLoginProperties

LoginProperties getLoginProperties(com.atlassian.crowd.embedded.api.User remoteUser,
                                   javax.servlet.http.HttpServletRequest request)

Returns loginProperties needed to render the login gadget or login form.

Parameters:

remoteUser - the currently logged in user

request - the incoming http request which may contain user credentials

Returns:

LoginProperties with information to render the login gadget/form