Oracle 9iAS Single Sign-On SDK

oracle.security.sso.enabler
Class SSOEnabler

java.lang.Object
  |
  +--oracle.security.sso.enabler.SSOEnabler

public class SSOEnabler
extends java.lang.Object

This class implements the enabler stack of the Oracle Single Sign-On service for partner application development.

See Also:
SSOUserInfo

Constructor Summary
SSOEnabler()
          Creates an Oracle Single Sign-On enabler object, with no database connection
SSOEnabler(java.sql.Connection p_db_conn)
          Creates an Oracle Single Sign-On enabler object, with database connection
 
Method Summary
TypeMethod
 java.lang.String decryptCookie(java.lang.String p_listenerToken, java.lang.String p_encryptedCookie)
          This method will decrypt the encrypted application cookie The return value will be decrypted application cookie
 java.lang.String encryptCookie(java.lang.String p_listenerToken, java.lang.String p_appCookie)
          This method will encrypt the application cookie The return value will be encrypted application cookie
 java.lang.String generateRedirect(java.lang.String p_listenerToken, java.lang.String p_requestedUrl, java.lang.String p_onCancelUrl, boolean p_forcedAuth)
          It generates a redirect URL from requested URL and cancel URL.
 SSOUserInfo getSSOUserInfo(java.lang.String p_listenerToken, java.lang.String p_urlcToken, java.net.InetAddress p_clientIp)
          It parses a redirect URL token from Oracle Single Sign-On server that contains user information.
 void setDbConnection(java.sql.Connection p_db_conn)
          Initializes Oracle Single Sign-On enabler object, with a database connection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SSOEnabler

public SSOEnabler()
Creates an Oracle Single Sign-On enabler object, with no database connection

SSOEnabler

public SSOEnabler(java.sql.Connection p_db_conn)
Creates an Oracle Single Sign-On enabler object, with database connection
See Also:
Connection
Method Detail

setDbConnection

public void setDbConnection(java.sql.Connection p_db_conn)
                     throws SSOEnablerException
Initializes Oracle Single Sign-On enabler object, with a database connection
Throws:
SSOEnablerException - if the database connection lost
See Also:
Connection

generateRedirect

public java.lang.String generateRedirect(java.lang.String p_listenerToken,
                                         java.lang.String p_requestedUrl,
                                         java.lang.String p_onCancelUrl,
                                         boolean p_forcedAuth)
                                  throws SSOEnablerException
It generates a redirect URL from requested URL and cancel URL. When a partner application wants to authenticate a user, it redirects the user (browser) to the Oracle Single Sign-On server with this URL. The requested URL string is the URL which the user wants to access, and the cancel URL string is the URL where Oracle Single Sign-On server will redirect the user if the user dosen't want to authenticate at that moment.
Returns:
Redirect URL
Throws:
SSOEnablerException - if there is an error in constructing redirect URL

getSSOUserInfo

public SSOUserInfo getSSOUserInfo(java.lang.String p_listenerToken,
                                  java.lang.String p_urlcToken,
                                  java.net.InetAddress p_clientIp)
                           throws SSOEnablerException
It parses a redirect URL token from Oracle Single Sign-On server that contains user information.
Returns:
SSOUserInfo object that contains user information
Throws:
SSOEnablerException - if there is an error in parsing
See Also:
SSOUserInfo

encryptCookie

public java.lang.String encryptCookie(java.lang.String p_listenerToken,
                                      java.lang.String p_appCookie)
                               throws SSOEnablerException
This method will encrypt the application cookie The return value will be encrypted application cookie
Parameters:
p_listenerToken - Listener token for the specific SSO Server
p_appCookie - Application cookie
Returns:
Encrypted application cookie
Throws:
SSOEnablerException - If the database connection lost or any other error occurs

decryptCookie

public java.lang.String decryptCookie(java.lang.String p_listenerToken,
                                      java.lang.String p_encryptedCookie)
                               throws SSOEnablerException
This method will decrypt the encrypted application cookie The return value will be decrypted application cookie
Parameters:
p_listenerToken - Listener token for the specific SSO Server
p_encryptedCookie - Decrypted application cookie
Returns:
Decrypted application cookie
Throws:
SSOEnablerException - if the database connection is lost or any other error occurs

Oracle Corporation