Interface CSSCustomAuthenticationIF

public interface CSSCustomAuthenticationIF

This interface defines the contract required to be implemented by the Custom Authentication Module. Its is the responsibility of the implementor to return a username string if authentication is successful. An exception should be throws with proper error message on any authentication failure.

The username returned by this method should be a valid shared services users. The format "username@providerName" is supported by the framework. If an invalid username is returned the authentication process will fail with an authentication exception.

The username returned by this method works in trusted mode. Therefore, in case of SAP users, the ticket will not be available in the CSS token.

Note that the authenticate method in this implementation will be invoked when a Custom Authentication Module is configured and the implementation of this class is available in the classpath. Also other providers configured in Shared Services should be configured as trusted providers.

The class implementing this interface should be packaged in jar file named as customAuth.jar, because during initilization if Custom Authentication is configured and the implementing class is not to be found in the Classpath, the initilization components tries to scan for above jar file to load the implementing class from HYPERION_HOME\common\CSS.

Any occurance of the character '*' in the username will not be supported as a literal Character. If the username returned contains '*', it will be treated as wildcard character i.e first user returned by this search criteria of username, will be used to perform post authentication operations.


Method Summary
 java.lang.String authenticate(java.util.Map context, java.lang.String username, java.lang.String password)
           Contract for custom authenticate module.

Method Detail


public java.lang.String authenticate(java.util.Map context,
                                     java.lang.String username,
                                     java.lang.String password)
                              throws java.lang.Exception

Contract for custom authenticate module. The implementation of the authenticate mechanism should be here.

The context can specify the following:

  1. locale

context - - Map structure holding key-value information about locale.
username - - username of the user for login
password - - password of the user for login
- username of the logged in user.
java.lang.Exception - - in case of any abnormalities

Copyright 2005-2009 Oracle Corporation.