org.wso2.charon.utils.authentication

Class BasicAuthHandler

java.lang.Object

org.wso2.charon.utils.authentication.BasicAuthHandler

All Implemented Interfaces:

org.wso2.charon.core.extensions.AuthenticationHandler

public class BasicAuthHandler
extends Object
implements org.wso2.charon.core.extensions.AuthenticationHandler

AuthenticationHandler for validating API access through basic auth - authentication mechanism.

Constructor Summary

Constructors

Constructor and Description
BasicAuthHandler()

Method Summary

Modifier and Type	Method and Description
BasicAuthInfo	decodeBasicAuthHeader(String authorizationHeader)
org.wso2.charon.core.extensions.AuthenticationInfo	getAuthenticationInfo() Once - isAuthenticated method is called on an implementation of this, AuthenticationInfo object can be created out of the information extracted from the authentication headers passed into the isAuthenticated method.
org.wso2.charon.core.extensions.AuthenticationInfo	getAuthenticationToken(org.wso2.charon.core.extensions.AuthenticationInfo authInfo)
String	getBase64EncodedBasicAuthHeader(String userName, String password) Get the Base64 encoded basic auth header.
boolean	isAuthenticated(Map<String,String> authHeaders)
void	setCharonManager(org.wso2.charon.core.extensions.CharonManager charonManager) Pass a handler of Charon Manager - who knows about other extensions such as TenantManager,UserManagers etc, so that authentication handler can utilize them if needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthHandler

public BasicAuthHandler()

Method Detail

isAuthenticated

public boolean isAuthenticated(Map<String,String> authHeaders)
                        throws org.wso2.charon.core.exceptions.CharonException

Specified by:

isAuthenticated in interface org.wso2.charon.core.extensions.AuthenticationHandler

Throws:

org.wso2.charon.core.exceptions.CharonException

getAuthenticationToken

public org.wso2.charon.core.extensions.AuthenticationInfo getAuthenticationToken(org.wso2.charon.core.extensions.AuthenticationInfo authInfo)

Specified by:

getAuthenticationToken in interface org.wso2.charon.core.extensions.AuthenticationHandler

getBase64EncodedBasicAuthHeader

public String getBase64EncodedBasicAuthHeader(String userName,
                                              String password)

Get the Base64 encoded basic auth header.

Parameters:

userName -

password -

Returns:

decodeBasicAuthHeader

public BasicAuthInfo decodeBasicAuthHeader(String authorizationHeader)

setCharonManager

public void setCharonManager(org.wso2.charon.core.extensions.CharonManager charonManager)

Pass a handler of Charon Manager - who knows about other extensions such as TenantManager,UserManagers etc, so that authentication handler can utilize them if needed.

Specified by:

setCharonManager in interface org.wso2.charon.core.extensions.AuthenticationHandler

Parameters:

charonManager -

getAuthenticationInfo

public org.wso2.charon.core.extensions.AuthenticationInfo getAuthenticationInfo()

Once - isAuthenticated method is called on an implementation of this, AuthenticationInfo object can be created out of the information extracted from the authentication headers passed into the isAuthenticated method.

Specified by:

getAuthenticationInfo in interface org.wso2.charon.core.extensions.AuthenticationHandler

Returns:

AuthenticationInfo