Oracle9iAS Single Sign-On Application Developer's Guide Release 3.0.9 Part Number A90343-01 |
|
The Java package, oracle.security.sso.enabler,
contains information about how application developers can use Java classes and methods to enable web users to access partner applications by means of Oracle9iAS Single Sign-On. This chapter should be used as a reference and assumes that the reader is familiar with PL/SQL functions and procedures for using Oracle9iAS Single Sign-On.
This chapter contains these topics:
public class SSOConfigException
extends SSOEnablerException
java.lang.Object | +--java.lang.Throwable | +--java.lang.Exception | +--SSOEnablerException | +--oracle.security.sso.enabler.SSOConfigException
java.io.Serializable
This exception is raised when SSO enabler configuration is missing or have wrong parameter.
This class is subclass of SSOEnablerException
.
Member Summary | |
---|---|
Constructors |
|
|
Constructs a |
|
Constructs a |
public SSOConfigException()
Constructs a SSOConfigException
object with out error message.
public SSOConfigException(java.lang.String p_str)
Constructs a SSOConfigException
object with a error message.
public class SSOEnabler extends java.lang.Object java.lang.Object | +--oracle.security.sso.enabler.SSOEnabler
This class implements the enabler stack of the Oracle9iAS Single Sign-On service for partner application development.
1.0
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public SSOEnabler()
Creates an Oracle9iAS Single Sign-On enabler object, with no database connection
public SSOEnabler(java.sql.Connection p_db_conn)
Creates an Oracle9iAS Single Sign-On enabler object, with database connection
public java.lang.String generateRedirect(java.lang.String p_listenerToken, java.lang.String p_requestedUrl, java.lang.String p_onCancelUrl)
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 Oracle9iAS Single Sign-On server with this URL. The requested URL string is the URL which user want to access and the cancel URL string is the URL where Oracle9iAS Single Sign-On server will redirect the user, if user dosen't want to authenticate at that moment.
Redirect URL
SSOEnablerException
- if there is an error in constructing redirect URL
public SSOUserInfo getSSOUserInfo(java.lang.String p_listenerToken, java.lang.String p_cookieStr, java.net.InetAddress p_clientIp)
It parses a redirect URL from Oracle9iAS Single Sign-On server which contains user information.
SSOUserInfo
object which will contain user information
SSOEnablerException
- if there is an error in parsing
public void setDbConnection(java.sql.Connection p_db_conn)
Initializes Oracle9iAS Single Sign-On enabler object, with a database connection
SSOEnablerException
- if the database connection lost
public class SSOEnablerConfig extends java.lang.Object java.lang.Object | +--oracle.security.sso.enabler.SSOEnablerConfig
This class is used with SSOEnabler
class for configutation parameters setup
1.0
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public SSOEnablerConfig()
Constructor that sets none of the properties.
public SSOEnablerConfig(java.lang.String p_listenerToken, java.lang.String p_ siteToken, java.lang.String p_siteID, java.lang.String p_loginURL, java.lang.String p_urlCookieVersion, java.lang.String p_encryptionKey, java.lang.String p_encryptionMaskPre, java.lang.String p_encryptionMaskPost, java.lang.String p_urlCookieIPCheck)
Constructor that sets all of the propeties
public java.lang.String getEncryptionKey()
Returns the encryption key.
The encryption key.
public java.lang.String getEncryptionMaskPost()
Returns the post encryption mask
The post encryption mask
public java.lang.String getEncryptionMaskPre()
Returns the pre encryption mask
The encryption mask pre.
public java.lang.String getListnerToken()
Returns the listner token.
The listner token.
public java.lang.String getLoginUrl()
Returns the login URL.
The login URL.
public java.lang.String getSiteID()
Returns the site ID.
The site ID.
public java.lang.String getSiteToken()
Returns the site token.
The site token.
public java.lang.String getUrlCookieIPCheck()
Returns the url cookie IP check.
The url cookie IP check.
public java.lang.String getUrlCookieVersion()
Returns the URL cookie version.
The URL cookie version.
public void setEncryptionKey(java.lang.String p_encryptionKey)
Sets the encryption key.
encryptionKey - The encryption key.
public void setEncryptionMaskPost(java.lang.String p_encryptionMaskPost)
Sets the post encryption mask
encryptionMaskPost - The post encryption mask
public void setEncryptionMaskPre(java.lang.String p_encryptionMaskPre)
Sets the pre encryption mask
encryptionMaskPre - The encryption mask pre.
public void setListnerToken(java.lang.String p_listnerToken)
Sets the listner token.
listnerToken - The listner token.
public void setLoginUrl(java.lang.String p_loginURL)
Sets the login URL.
loginURL - The login URL.
public void setSiteID(java.lang.String p_siteID)
Sets the site ID.
siteID - The site ID.
public void setSiteToken(java.lang.String p_siteToken)
Sets the site token.
siteToken - The site token.
public void setUrlCookieIPCheck(java.lang.String p_urlCookieIPCheck)
Sets the url cookie IP check.
urlCookieIPCheck - The url cookie IP check.
public void setUrlCookieVersion(java.lang.String p_urlCookieVersion)
Sets the URL cookie version.
urlCookieVersion - The URL cookie version.
public class SSOEnablerConfigMgr extends java.lang.Object java.lang.Object | +--oracle.security.sso.enabler.SSOEnablerConfigMgr
This class implements the enabler stack of Oracle9iAS Single Sign-On service for partner application development.
1.0
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public SSOEnablerConfigMgr()
Creates an Oracle9iAS Single Sign-On enabler object, with no database connection
public SSOEnablerConfigMgr(java.sql.Connection p_db_conn)
Creates an Oracle9iAS Single Sign-On enabler object, with database connection
public void createEnablerConfig(SSOEnablerConfig p_configuration)
Creates configuration parameters of the SSO enabler specified by the listner token.
p_configuration - The configuration for the SSO enabler to be added. All the members of this class must be filled in except for encryptionMaskPre and encryptionMaskPost which must be empty strings ("").
SSOEnablerException
- Raised if database connection is lost, the database is not configured properly, or invalid data is passed into this procedure.
public void deleteEnablerConfig(java.lang.String p_listenerToken)
Deletes the configuration parameters of the SSO enabler specified by the listner token.
p_listenerToken - The listner token of the SSO enabler p_configuration that is to be deleted.
SSOEnablerException
- Raised if database connection is lost, the database is not configured properly, or invalid data is passed into this procedure.
public SSOEnablerConfig getEnablerConfig(java.lang.String p_listenerToken)
Returns the configuration parameters of the SSO enabler specified by the listner token.
p_listenerToken - The listner token of the SSO enabler p_configuration that is to be selected.
An instance of SSOEnablerConfig
containing the p_configuration of the SSO enabler specified by the listner token.
SSOEnablerException
- Raised if database connection is lost, the database is not configured properly, or the listner token is invalid.
public void setDbConnection(java.sql.Connection p_db_conn)
Initializes Oracle9iAS Single Sign-On enabler object, with a database connection
SSOEnablerException
- if the database connection lost
public void setEnablerConfig(java.lang.String p_listenerToken,SSOEnablerConfig (p_configuration)
Updates the configuration parameters of the SSO enabler specified by the listner token.
p_listenerToken - The listner token of the SSO enabler p_configuration that is to be updated.
p_configuration - The configuration for the SSO enabler to be updated. All the members of this class must be filled in.
SSOEnablerException
- Raised if database connection is lost, the database is not configured properly, or invalid data is passed into this procedure.
public class SSOEnablerException extends java.lang.Exception java.lang.Object | +--java.lang.Throwable | +--java.lang.Exception | +--oracle.security.sso.enabler.SSOEnablerException
SSOConfigException, SSOIpCheckException, SSOTokenExpiredException, SSOVersionException
java.io.Serializable
Generic exception class for Login Server SSO SDK This class is subclass of java.lang.Exception
public SSOEnablerException()
Constructs a SSOEnablerException
object with out error message.
public SSOEnablerException(java.lang.String p_str)
Constructs a SSOEnablerException
object with a error message.
public class SSOEnablerUtil extends java.lang.Object java.lang.Object | +--oracle.security.sso.enabler.SSOEnablerUtil
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public SSOEnablerUtil()
Creates a utility object for application cookie baking/unbaking, with no database connection
public SSOEnablerUtil(java.sql.Connection p_db_conn)
Creates a utility object for application cookie baking/unbaking, with database connection
public java.lang.String bakeAppCookie(java.lang.String p_listenerToken, java.lang.String p_appCookie)
This method will bake the input application cookie for encryption and hashing The return string will be encrypted along with hashed application cookie
p_listenerToken - Listener token for the specific login server
p_appCookie - Application cookie
Baked application cookie
SSOEnablerException
- if the database connection lost or any other error occurs
public static java.lang.String genHtmlPostForm(java.lang.String p_ genRedirectUrl)
This method will generate a html post form to the login server url from generate redirect url
p_genRedirectUrl - generate redirect url
html redirect url
IllegalArgumentException - if the input url is incorrect
public static java.lang.String genRedirect(java.lang.String p_redirectUrl)
This method will generate a html redirect to the specified url
p_redirectUrl - generate redirect url
html post form for login server
IllegalArgumentException - if the input url is incorrect
public void setDbConnection(java.sql.Connection p_db_conn)
Initializes utility object for application cookie baking/unbaking, with a database connection
SSOEnablerException
- if the database connection lost
public java.lang.String unbakeAppCookie(java.lang.String p_listenerToken, java.lang.String p_bakedAppCookie)
This method will unbake the input baked application cookie The return string will be decrypted application cookie
p_listenerToken - Listener token for the specific login server
p_bakedAppCookie - Unbaked application cookie
Unbaked application cookie
SSOEnablerException
- if the database connection is lost or any other error occurs
public class SSOIpCheckException extendsSSOEnablerException
java.lang.Object | +--java.lang.Throwable | +--java.lang.Exception | +--SSOEnablerException
| +--oracle.security.sso.enabler.SSOIpCheckException
java.io.Serializable
This exception is raised if the IP address of the original requested URL do not match. If the request came through a proxy server which may not have fixed IP then this exception will be raised. This exception can be disabled by disabling IP check while entering registration information to the enabler configuration table.
This class is subclass of SSOEnablerException
public SSOIpCheckException()
Constructs a SSOIpCheckException
object with out error message.
public SSOIpCheckException(java.lang.String p_str)
Constructs a SSOIpCheckException
object with a error message.
public class SSOTokenExpiredException extends SSOEnablerException
java.lang.Object
|
+--java.lang.Throwable
|
+--java.lang.Exception
|
+-- SSOEnablerException
|
+--oracle.security.sso.enabler.SSOTokenExpiredExcept
ion
java.io.Serializable
This exception is raised if user takes too long time to enter username and password to the Login Server login page
This class is subclass of SSOEnablerException
public SSOTokenExpiredException()
Constructs a SSOTokenExpiredException
object with out error message.
public SSOTokenExpiredException(java.lang.String p_str)
Constructs a SSOTokenExpiredException
object with a error message.
public class SSOUserInfo extends java.lang.Object java.lang.Object | +--oracle.security.sso.enabler.SSOUserInfo
This class is used for returning user information after parsing redirect url from SSOEnabler
class
1.0
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public java.lang.String getIPAddress()
Returns IP Address
public java.sql.Date getSiteTimeStamp()
Returns the site time stamp
public int getSSOTimeRemaining()
Returns remaining Single Sign-On time in hours
public java.lang.String getSSOUserName()
Returns Single Sign-On user name
public java.lang.String getUrlRequested()
Returns requested url
public class SSOVersionException extendsSSOEnablerException
java.lang.Object | +--java.lang.Throwable | +--java.lang.Exception | +--SSOEnablerException
| +--oracle.security.sso.enabler.SSOVersionException
java.io.Serializable
This exception is raised if the SDK version does not match with Login Server version or the enabler version information is not correct
This class is subclass of SSOEnablerException
public SSOVersionException()
Constructs a SSOVersionException
object with out a error message.
public SSOVersionException(java.lang.String p_str)
Constructs a SSOVersionException
object with a error message.
|
Copyright © 2001 Oracle Corporation. All Rights Reserved. |
|