org.wso2.charon.utils

Class DefaultCharonManager

java.lang.Object

org.wso2.charon.utils.DefaultCharonManager

All Implemented Interfaces:

org.wso2.charon.core.extensions.CharonManager

public class DefaultCharonManager
extends Object
implements org.wso2.charon.core.extensions.CharonManager

This illustrates what are the core tasks an implementation should take care of, according to their specific implementation, and how the extension points and utils implementation provided by charon can be initialized/utilized here.

Method Summary

Modifier and Type	Method and Description
org.wso2.charon.core.extensions.AuthenticationHandler	getAuthenticationHandler(String authMechanism) Obtain the authentication handler, given the authentication mechanism.
org.wso2.charon.core.encoder.Decoder	getDecoder(String format) Obtain the decoder for the given format.
org.wso2.charon.core.encoder.Encoder	getEncoder(String format) Obtain the encoder for the given format.
static DefaultCharonManager	getInstance() Should return the static instance of CharonManager implementation.
org.wso2.charon.core.extensions.TenantManager	getTenantManager() Obtain the the instance of registered tenant manager implementation.
org.wso2.charon.core.extensions.UserManager	getUserManager(String tenantAdminUserName) Obtain the user manager, after identifying the tenantId of the tenantAdminUser who invokes the SCIM API exposed by the service provider.
org.wso2.charon.core.extensions.AuthenticationInfo	handleAuthentication(Map<String,String> httpAuthHeaders)
String	identifyAuthMechanism(Map<String,String> authHeaders) Identify the authentication mechanism, given the http headers sent in the SCIM API access request.
boolean	isAuthenticationSupported(String authmechanism) Returns true if the registered authenticators support the given authentication mechanism.
org.wso2.charon.core.extensions.AuthenticationInfo	registerTenant(org.wso2.charon.core.extensions.TenantDTO tenantInfo) Create the tenant in the particular tenant manager, given the tenant info.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DefaultCharonManager getInstance()
                                        throws org.wso2.charon.core.exceptions.CharonException

Should return the static instance of CharonManager implementation. Read the config and initialize extensions as specified in the config.

Returns:

Throws:

org.wso2.charon.core.exceptions.CharonException

getEncoder

public org.wso2.charon.core.encoder.Encoder getEncoder(String format)
                                                throws org.wso2.charon.core.exceptions.FormatNotSupportedException

Obtain the encoder for the given format.

Specified by:

getEncoder in interface org.wso2.charon.core.extensions.CharonManager

Returns:

Throws:

org.wso2.charon.core.exceptions.FormatNotSupportedException

getDecoder

public org.wso2.charon.core.encoder.Decoder getDecoder(String format)
                                                throws org.wso2.charon.core.exceptions.FormatNotSupportedException

Obtain the decoder for the given format.

Specified by:

getDecoder in interface org.wso2.charon.core.extensions.CharonManager

Returns:

Throws:

org.wso2.charon.core.exceptions.FormatNotSupportedException

getAuthenticationHandler

public org.wso2.charon.core.extensions.AuthenticationHandler getAuthenticationHandler(String authMechanism)
                                                                               throws org.wso2.charon.core.exceptions.CharonException

Obtain the authentication handler, given the authentication mechanism.

Specified by:

getAuthenticationHandler in interface org.wso2.charon.core.extensions.CharonManager

Returns:

Throws:

org.wso2.charon.core.exceptions.CharonException

getUserManager

public org.wso2.charon.core.extensions.UserManager getUserManager(String tenantAdminUserName)
                                                           throws org.wso2.charon.core.exceptions.CharonException

Obtain the user manager, after identifying the tenantId of the tenantAdminUser who invokes the SCIM API exposed by the service provider.

Specified by:

getUserManager in interface org.wso2.charon.core.extensions.CharonManager

Parameters:

tenantAdminUserName -

Returns:

Throws:

org.wso2.charon.core.exceptions.CharonException

getTenantManager

public org.wso2.charon.core.extensions.TenantManager getTenantManager()

Obtain the the instance of registered tenant manager implementation.

Specified by:

getTenantManager in interface org.wso2.charon.core.extensions.CharonManager

Returns:

registerTenant

public org.wso2.charon.core.extensions.AuthenticationInfo registerTenant(org.wso2.charon.core.extensions.TenantDTO tenantInfo)
                                                                  throws org.wso2.charon.core.exceptions.CharonException

Create the tenant in the particular tenant manager, given the tenant info. Purpose of registering is, creating a tenant specific storage space in the service provider as well as obtaining credentials to access SCIM SP API for subsequent provisioning activities. Therefore. proper credentials should be returned according to the authentication handler.

Specified by:

registerTenant in interface org.wso2.charon.core.extensions.CharonManager

Parameters:

tenantInfo -

Returns:

Throws:

org.wso2.charon.core.exceptions.CharonException

isAuthenticationSupported

public boolean isAuthenticationSupported(String authmechanism)

Returns true if the registered authenticators support the given authentication mechanism.

Specified by:

isAuthenticationSupported in interface org.wso2.charon.core.extensions.CharonManager

Parameters:

authmechanism -

Returns:

handleAuthentication

public org.wso2.charon.core.extensions.AuthenticationInfo handleAuthentication(Map<String,String> httpAuthHeaders)
                                                                        throws org.wso2.charon.core.exceptions.UnauthorizedException

Specified by:

handleAuthentication in interface org.wso2.charon.core.extensions.CharonManager

Throws:

org.wso2.charon.core.exceptions.UnauthorizedException

identifyAuthMechanism

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

Identify the authentication mechanism, given the http headers sent in the SCIM API access request.

Parameters:

authHeaders -

Returns:

Throws:

org.wso2.charon.core.exceptions.CharonException