Package org.wso2.carbon.ui

Class DefaultCarbonAuthenticator

java.lang.Object

org.wso2.carbon.ui.AbstractCarbonUIAuthenticator

org.wso2.carbon.ui.BasicAuthUIAuthenticator

org.wso2.carbon.ui.DefaultCarbonAuthenticator

All Implemented Interfaces:

CarbonUIAuthenticator

public class DefaultCarbonAuthenticator
extends BasicAuthUIAuthenticator

Default implementation of CarbonUIAuthenticator.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.commons.logging.Log	log

Fields inherited from class org.wso2.carbon.ui.AbstractCarbonUIAuthenticator

PASSWORD, REMEMBER_ME, USERNAME

Constructor Summary

Constructors

Constructor	Description
DefaultCarbonAuthenticator()

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(javax.servlet.http.HttpServletRequest request)	This method will check whether given request can be handled by the authenticator.
String	doAuthentication(Object credentials, boolean isRememberMe, org.apache.axis2.client.ServiceClient client, javax.servlet.http.HttpServletRequest request)
String	getAuthenticatorName()	Returns the name of the authenticator.
void	handleRememberMe(Map transportHeaders, javax.servlet.http.HttpServletRequest httpServletRequest)
void	unauthenticate(Object object)	Invalidates the authentication session.

Methods inherited from class org.wso2.carbon.ui.BasicAuthUIAuthenticator

authenticate, authenticateWithCookie, getAuthenticationAdminCient

Methods inherited from class org.wso2.carbon.ui.AbstractCarbonUIAuthenticator

getAuthenticationSkippingUrls, getPriority, getSessionValidationSkippingUrls, getUserNameFromCookie, handleSecurity, isAdminCookieSet, isDisabled, onSuccessAdminLogin, setAdminCookie, setUserInformation, skipLoginPage

Methods inherited from class java.lang.Object

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

Field Details

log

protected static final org.apache.commons.logging.Log log

Constructor Details

DefaultCarbonAuthenticator

public DefaultCarbonAuthenticator()

Method Details

canHandle

public boolean canHandle(javax.servlet.http.HttpServletRequest request)

This method will check whether given request can be handled by the authenticator. If authenticator is capable of handling given request this method will return true. Else this will return false.

Specified by:

canHandle in interface CarbonUIAuthenticator

Overrides:

canHandle in class BasicAuthUIAuthenticator

Returns:

true if this authenticator can handle the request, else false.

doAuthentication

public String doAuthentication(Object credentials,
 boolean isRememberMe,
 org.apache.axis2.client.ServiceClient client,
 javax.servlet.http.HttpServletRequest request)
                        throws org.wso2.carbon.core.common.AuthenticationException

Overrides:

doAuthentication in class BasicAuthUIAuthenticator

Parameters:

credentials -

client -

request -

Throws:

org.wso2.carbon.core.common.AuthenticationException

unauthenticate

public void unauthenticate(Object object)
                    throws Exception

Description copied from interface: CarbonUIAuthenticator

Invalidates the authentication session. TODO why we need this ? An authenticator should not maintain a session

Specified by:

unauthenticate in interface CarbonUIAuthenticator

Overrides:

unauthenticate in class BasicAuthUIAuthenticator

Parameters:

object - The request to invalidate TODO (?)

Throws:

Exception - If an error occurred during authentication process.

getAuthenticatorName

public String getAuthenticatorName()

Returns the name of the authenticator.

Specified by:

getAuthenticatorName in interface CarbonUIAuthenticator

Overrides:

getAuthenticatorName in class BasicAuthUIAuthenticator

Returns:

The name of the authenticator.

handleRememberMe

public void handleRememberMe(Map transportHeaders,
 javax.servlet.http.HttpServletRequest httpServletRequest)
                      throws org.wso2.carbon.core.common.AuthenticationException

Overrides:

handleRememberMe in class BasicAuthUIAuthenticator

Parameters:

httpServletRequest -

Throws:

org.wso2.carbon.core.common.AuthenticationException