com.atlassian.seraph.auth
Interface Authenticator

All Superinterfaces:

Initable

All Known Implementing Classes:

AbstractAuthenticator

public interface Authenticator

extends Initable

An Authenticator is used to authenticate users, log them in, log them out and check their roles.

Field Summary

static java.lang.String

DEFAULT_AUTHENTICATOR

Method Summary

void	destroy()
java.lang.String	getRemoteUser(javax.servlet.http.HttpServletRequest request)
java.security.Principal	getUser(javax.servlet.http.HttpServletRequest request)
java.security.Principal	getUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	isUserInRole(javax.servlet.http.HttpServletRequest request, java.lang.String role) Deprecated. Use RoleMapper directly
boolean	login(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String username, java.lang.String password)
boolean	login(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String username, java.lang.String password, boolean storeCookie)
boolean	logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from interface com.atlassian.seraph.Initable

init

Field Detail

DEFAULT_AUTHENTICATOR

public static final java.lang.String DEFAULT_AUTHENTICATOR

See Also:

Constant Field Values

Method Detail

destroy

public void destroy()

getRemoteUser

public java.lang.String getRemoteUser(javax.servlet.http.HttpServletRequest request)

getUser

public java.security.Principal getUser(javax.servlet.http.HttpServletRequest request)

getUser

public java.security.Principal getUser(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)

isUserInRole

public boolean isUserInRole(javax.servlet.http.HttpServletRequest request,
                            java.lang.String role)

Deprecated. Use RoleMapper directly

login

public boolean login(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     java.lang.String username,
                     java.lang.String password)
              throws AuthenticatorException

Throws:

AuthenticatorException

login

public boolean login(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     java.lang.String username,
                     java.lang.String password,
                     boolean storeCookie)
              throws AuthenticatorException

Throws:

AuthenticatorException

logout

public boolean logout(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws AuthenticatorException

Throws:

AuthenticatorException