Interface contracts of the web UI framework - authentication

The interface contracts for authentication defines the behavior expected in any implementation of authentication in an application.

For more information, refer to the Java™ API documentation in your installation directory (<INSTALL_DIR>/xapidocs/core_javadocs).

Interface Contract	Description	Methods
ISCUIAuthenticationProvider	Defines the behavior expected in any implementation of authentication in an application. AuthenticationProvider is plugged in to an application using the context parameter in web.xml: <param-name> scui-authentication-provider <param-value> com.app.MyAppAuthenticationProvider The ISCUIAuthenticationProvider class extends the ISCUISessionAware class, which is a marker class that helps the ISCUIAuthenticationProvider class register itself to the HttpSessionListener implementation class.	authenticate Takes in the SCUIContext. The expected response is in the form of the SCUISecurityResponse object that encapsulates the return status, the URL of the page, exception, and error message. The AuthenticationProvider class needs to set SCUISecurityContext and SCUIUserPreferences in SCUIContext if the user is authenticated. init Handles initialization, like loading the security information or caching it. This method is called once, when AuthenticationProvider is first set. sessionDestroyed Closes all opened session-specific handles.

Interface Contract

Description

Methods

ISCUIAuthenticationProvider

Defines the behavior expected in any implementation of authentication in an application.

AuthenticationProvider is plugged in to an application using the context parameter in web.xml:

<param-name>
scui-authentication-provider
<param-value>
com.app.MyAppAuthenticationProvider

The ISCUIAuthenticationProvider class extends the ISCUISessionAware class, which is a marker class that helps the ISCUIAuthenticationProvider class register itself to the HttpSessionListener implementation class.

authenticate
Takes in the SCUIContext. The expected response is in the form of the SCUISecurityResponse object that encapsulates the return status, the URL of the page, exception, and error message.

The AuthenticationProvider class needs to set SCUISecurityContext and SCUIUserPreferences in SCUIContext if the user is authenticated.
init
Handles initialization, like loading the security information or caching it. This method is called once, when AuthenticationProvider is first set.
sessionDestroyed
Closes all opened session-specific handles.