com.atlassian.seraph.auth
Class AbstractAuthenticator

java.lang.Object
  com.atlassian.seraph.auth.AbstractAuthenticator

All Implemented Interfaces:

Authenticator, Initable, java.io.Serializable

Direct Known Subclasses:

DefaultAuthenticator

public abstract class AbstractAuthenticator

extends java.lang.Object

implements Authenticator, java.io.Serializable

An abstract implementation of Authenticator that implements a lot of base methods

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.atlassian.seraph.auth.Authenticator

DEFAULT_AUTHENTICATOR

Constructor Summary

AbstractAuthenticator()

Method Summary

void	destroy()
protected SecurityConfig	getConfig()
java.lang.String	getRemoteUser(javax.servlet.http.HttpServletRequest request)
java.security.Principal	getUser(javax.servlet.http.HttpServletRequest request)
abstract java.security.Principal	getUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	init(java.util.Map params, SecurityConfig config)
abstract 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)
abstract boolean	login(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String username, java.lang.String password, boolean cookie)
abstract boolean	logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAuthenticator

public AbstractAuthenticator()

Method Detail

init

public void init(java.util.Map params,
                 SecurityConfig config)

Specified by:

init in interface Initable

destroy

public void destroy()

Specified by:

destroy in interface Authenticator

isUserInRole

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

Deprecated. Use RoleMapper directly

Specified by:

isUserInRole in interface Authenticator

getRemoteUser

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

Specified by:

getRemoteUser in interface Authenticator

getUser

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

Specified by:

getUser in interface Authenticator

getUser

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

Specified by:

getUser in interface Authenticator

login

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

Specified by:

login in interface Authenticator

Throws:

AuthenticatorException

login

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

Specified by:

login in interface Authenticator

Throws:

AuthenticatorException

logout

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

Specified by:

logout in interface Authenticator

Throws:

AuthenticatorException

getConfig

protected SecurityConfig getConfig()