4
Java Oracle9iAS Single Sign-On Application Programming Interface

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:

• Package
  • SSOConfigException

  • SSOEnabler

  • SSOEnablerConfig

  • SSOEnablerConfigMgr

  • SSOEnablerException

  • SSOEnablerUtil

  • SSOIpCheckException

  • SSOTokenExpiredException

  • SSOUserInfo

  • SSOVersionException

    See Also: Chapter 3, "PL/SQL Single Sign-On Application Programming Interface"

Package

oracle.security.sso.enabler

Description

Class Summary
Classes
SSOEnabler	This class implements the enabler stack of the Oracle9iAS Single Sign-On service for partner application development.
SSOEnablerConfig	This class is used with SSOEnabler class for configutation parameters setup
SSOEnablerConfigMgr	This class implements the enabler stack of Oracle9iAS Single Sign-On service for partner application development.
SSOEnablerUtil
SSOUserInfo	This class is used for returning user information after parsing redirect url from SSOEnabler class
Exceptions
SSOConfigException	This exception is raised when SSO enabler configuration is missing or have wrong parameter
SSOEnablerException	Generic exception class for Login Server SSO SDK This class is subclass of java.lang.Exception
SSOIpCheckException	This exception is raised if the IP address of the original requested URL do not match.
SSOTokenExpiredException	This exception is raised if user takes too long time to enter username and password to the Login Server login page
SSOVersionException	This exception is raised if the SDK version does not match with Login Server version or the enabler version information is not correct

oracle.security.sso.enabler

SSOConfigException

Syntax:

public class SSOConfigException extends SSOEnablerException

 
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--SSOEnablerException
                    |
                    +--oracle.security.sso.enabler.SSOConfigException

All Implemented Interfaces:

java.io.Serializable

Description:

This exception is raised when SSO enabler configuration is missing or have wrong parameter.

This class is subclass of SSOEnablerException.

Member Summary
Constructors
SSOConfigException()	Constructs a SSOConfigException object with out error message.
SSOConfigException(String)	Constructs a SSOConfigException object with a error message.

Inherited Member Summary
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructors

SSOConfigException()

Syntax:

public  SSOConfigException()

Description:

Constructs a SSOConfigException object with out error message.

SSOConfigException(String)

Syntax:

public  SSOConfigException(java.lang.String p_str)

Description:

Constructs a SSOConfigException object with a error message.

oracle.security.sso.enabler

SSOEnabler

Syntax:

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

Description:

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

Since:

1.0

Member Summary
Constructors
SSOEnabler()	Creates an Oracle9iAS Single Sign-On enabler object, with no database connection
SSOEnabler(Connection)	Creates an Oracle9iAS Single Sign-On enabler object, with database connection
Methods
generateRedirect(String, String, String)	It generates a redirect URL from requested URL and cancel URL.
getSSOUserInfo(String, String, InetAddress)	It parses a redirect URL from Oracle9iAS Single Sign-On server which contains user information.
setDbConnection(Connection)	Initializes Oracle9iAS Single Sign-On enabler object, with a database connection

Inherited Member Summary
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

SSOEnabler()

Syntax:

public  SSOEnabler()

Description:

Creates an Oracle9iAS Single Sign-On enabler object, with no database connection

SSOEnabler(Connection)

Syntax:

public  SSOEnabler(java.sql.Connection p_db_conn)

Description:

Creates an Oracle9iAS Single Sign-On enabler object, with database connection

Methods

generateRedirect(String, String, String)

Syntax:

public java.lang.String generateRedirect(java.lang.String p_listenerToken, 
java.lang.String p_requestedUrl, java.lang.String p_onCancelUrl)

Description:

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.

Returns:

Redirect URL

Throws:

SSOEnablerException - if there is an error in constructing redirect URL

getSSOUserInfo(String, String, InetAddress)

Syntax:

public SSOUserInfo getSSOUserInfo(java.lang.String p_listenerToken, 
java.lang.String p_cookieStr, java.net.InetAddress p_clientIp)

Description:

It parses a redirect URL from Oracle9iAS Single Sign-On server which contains user information.

Returns:

SSOUserInfo object which will contain user information

Throws:

SSOEnablerException - if there is an error in parsing

setDbConnection(Connection)

Syntax:

public void setDbConnection(java.sql.Connection p_db_conn)

Description:

Initializes Oracle9iAS Single Sign-On enabler object, with a database connection

Throws:

SSOEnablerException - if the database connection lost

oracle.security.sso.enabler

SSOEnablerConfig

Syntax:

public class SSOEnablerConfig extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.security.sso.enabler.SSOEnablerConfig

Description:

This class is used with SSOEnabler class for configutation parameters setup

Since:

1.0

Member Summary
Constructors
SSOEnablerConfig()	Constructor that sets none of the properties.
SSOEnablerConfig(String, String, String, String, String, String, String, String, String)	Constructor that sets all of the propeties
Methods
getEncryptionKey()	Returns the encryption key.
getEncryptionMaskPost()	Returns the post encryption mask
getEncryptionMaskPre()	Returns the pre encryption mask
getListnerToken()	Returns the listner token.
getLoginUrl()	Returns the login URL.
getSiteID()	Returns the site ID.
getSiteToken()	Returns the site token.
getUrlCookieIPCheck()	Returns the url cookie IP check.
getUrlCookieVersion()	Returns the URL cookie version.
setEncryptionKey(String)	Sets the encryption key.
setEncryptionMaskPost(String)	Sets the post encryption mask
setEncryptionMaskPre(String)	Sets the pre encryption mask
setListnerToken(String)	Sets the listner token.
setLoginUrl(String)	Sets the login URL.
setSiteID(String)	Sets the site ID.
setSiteToken(String)	Sets the site token.
setUrlCookieIPCheck(String)	Sets the url cookie IP check.
setUrlCookieVersion(String)	Sets the URL cookie version.

Inherited Member Summary
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

SSOEnablerConfig()

Syntax:

public  SSOEnablerConfig()

Description:

Constructor that sets none of the properties.

SSOEnablerConfig(String, String, String, String, String, String, String, String, String)

Syntax:

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)

Description:

Constructor that sets all of the propeties

Methods

getEncryptionKey()

Syntax:

public java.lang.String getEncryptionKey()

Description:

Returns the encryption key.

Returns:

The encryption key.

getEncryptionMaskPost()

Syntax:

public java.lang.String getEncryptionMaskPost()

Description:

Returns the post encryption mask

Returns:

The post encryption mask

getEncryptionMaskPre()

Syntax:

public java.lang.String getEncryptionMaskPre()

Description:

Returns the pre encryption mask

Returns:

The encryption mask pre.

getListnerToken()

Syntax:

public java.lang.String getListnerToken()

Description:

Returns the listner token.

Returns:

The listner token.

getLoginUrl()

Syntax:

public java.lang.String getLoginUrl()

Description:

Returns the login URL.

Returns:

The login URL.

getSiteID()

Syntax:

public java.lang.String getSiteID()

Description:

Returns the site ID.

Returns:

The site ID.

getSiteToken()

Syntax:

public java.lang.String getSiteToken()

Description:

Returns the site token.

Returns:

The site token.

getUrlCookieIPCheck()

Syntax:

public java.lang.String getUrlCookieIPCheck()

Description:

Returns the url cookie IP check.

Returns:

The url cookie IP check.

getUrlCookieVersion()

Syntax:

public java.lang.String getUrlCookieVersion()

Description:

Returns the URL cookie version.

Returns:

The URL cookie version.

setEncryptionKey(String)

Syntax:

public void setEncryptionKey(java.lang.String p_encryptionKey)

Description:

Sets the encryption key.

Parameters:

encryptionKey - The encryption key.

setEncryptionMaskPost(String)

Syntax:

public void setEncryptionMaskPost(java.lang.String p_encryptionMaskPost)

Description:

Sets the post encryption mask

Parameters:

encryptionMaskPost - The post encryption mask

setEncryptionMaskPre(String)

Syntax:

public void setEncryptionMaskPre(java.lang.String p_encryptionMaskPre)

Description:

Sets the pre encryption mask

Parameters:

encryptionMaskPre - The encryption mask pre.

setListnerToken(String)

Syntax:

public void setListnerToken(java.lang.String p_listnerToken)

Description:

Sets the listner token.

Parameters:

listnerToken - The listner token.

setLoginUrl(String)

Syntax:

public void setLoginUrl(java.lang.String p_loginURL)

Description:

Sets the login URL.

Parameters:

loginURL - The login URL.

setSiteID(String)

Syntax:

public void setSiteID(java.lang.String p_siteID)

Description:

Sets the site ID.

Parameters:

siteID - The site ID.

setSiteToken(String)

Syntax:

public void setSiteToken(java.lang.String p_siteToken)

Description:

Sets the site token.

Parameters:

siteToken - The site token.

setUrlCookieIPCheck(String)

Syntax:

public void setUrlCookieIPCheck(java.lang.String p_urlCookieIPCheck)

Description:

Sets the url cookie IP check.

Parameters:

urlCookieIPCheck - The url cookie IP check.

setUrlCookieVersion(String)

Syntax:

public void setUrlCookieVersion(java.lang.String p_urlCookieVersion)

Description:

Sets the URL cookie version.

Parameters:

urlCookieVersion - The URL cookie version.

oracle.security.sso.enabler

SSOEnablerConfigMgr

Syntax:

public class SSOEnablerConfigMgr extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.security.sso.enabler.SSOEnablerConfigMgr

Description:

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

Since:

1.0

Member Summary
Constructors
SSOEnablerConfigMgr()	Creates an Oracle9iAS Single Sign-On enabler object, with no database connection
SSOEnablerConfigMgr(Connection)	Creates an Oracle9iAS Single Sign-On enabler object, with database connection
Methods
createEnablerConfig(SSOEnablerConfig)	Creates configuration parameters of the SSO enabler specified by the listner token.
deleteEnablerConfig(String)	Deletes the configuration parameters of the SSO enabler specified by the listner token.
getEnablerConfig(String)	Returns the configuration parameters of the SSO enabler specified by the listner token.
setDbConnection(Connection)	Initializes Oracle9iAS Single Sign-On enabler object, with a database connection
setEnablerConfig(String, SSOEnablerConfig)	Updates the configuration parameters of the SSO enabler specified by the listner token.

Inherited Member Summary
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

SSOEnablerConfigMgr()

Syntax:

public  SSOEnablerConfigMgr()

Description:

Creates an Oracle9iAS Single Sign-On enabler object, with no database connection

SSOEnablerConfigMgr(Connection)

Syntax:

public  SSOEnablerConfigMgr(java.sql.Connection p_db_conn)

Description:

Creates an Oracle9iAS Single Sign-On enabler object, with database connection

Methods

createEnablerConfig(SSOEnablerConfig)

Syntax:

public void createEnablerConfig(SSOEnablerConfig p_configuration)

Description:

Creates configuration parameters of the SSO enabler specified by the listner token.

Parameters:

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 ("").

Throws:

SSOEnablerException- Raised if database connection is lost, the database is not configured properly, or invalid data is passed into this procedure.

deleteEnablerConfig(String)

Syntax:

public void deleteEnablerConfig(java.lang.String p_listenerToken)

Description:

Deletes the configuration parameters of the SSO enabler specified by the listner token.

Parameters:

p_listenerToken - The listner token of the SSO enabler p_configuration that is to be deleted.

Throws:

SSOEnablerException - Raised if database connection is lost, the database is not configured properly, or invalid data is passed into this procedure.

getEnablerConfig(String)

Syntax:

public SSOEnablerConfig getEnablerConfig(java.lang.String p_listenerToken)

Description:

Returns the configuration parameters of the SSO enabler specified by the listner token.

Parameters:

p_listenerToken - The listner token of the SSO enabler p_configuration that is to be selected.

Returns:

An instance of SSOEnablerConfig containing the p_configuration of the SSO enabler specified by the listner token.

Throws:

SSOEnablerException - Raised if database connection is lost, the database is not configured properly, or the listner token is invalid.

setDbConnection(Connection)

Syntax:

public void setDbConnection(java.sql.Connection p_db_conn)

Description:

Initializes Oracle9iAS Single Sign-On enabler object, with a database connection

Throws:

SSOEnablerException - if the database connection lost

setEnablerConfig(String, SSOEnablerConfig)

Syntax:

public void setEnablerConfig(java.lang.String p_listenerToken,SSOEnablerConfig 
(p_configuration)

Description:

Updates the configuration parameters of the SSO enabler specified by the listner token.

Parameters:

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.

Throws:

SSOEnablerException - Raised if database connection is lost, the database is not configured properly, or invalid data is passed into this procedure.

oracle.security.sso.enabler

SSOEnablerException

Syntax:

public class SSOEnablerException extends java.lang.Exception
 
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--oracle.security.sso.enabler.SSOEnablerException

Direct Known Subclasses:

SSOConfigException, SSOIpCheckException, SSOTokenExpiredException, SSOVersionException

All Implemented Interfaces:

java.io.Serializable

Description:

Generic exception class for Login Server SSO SDK This class is subclass of java.lang.Exception

Member Summary
Constructors
SSOEnablerException()	Constructs a SSOEnablerException object with out error message.
SSOEnablerException(String)	Constructs a SSOEnablerException object with a error message.

Inherited Member Summary
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructors

SSOEnablerException()

Syntax:

public  SSOEnablerException()

Description:

Constructs a SSOEnablerException object with out error message.

SSOEnablerException(String)

Syntax:

public  SSOEnablerException(java.lang.String p_str)

Description:

Constructs a SSOEnablerException object with a error message.

oracle.security.sso.enabler

SSOEnablerUtil

Syntax:

public class SSOEnablerUtil extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.security.sso.enabler.SSOEnablerUtil

Description:

Member Summary
Constructors
SSOEnablerUtil()	Creates a utility object for application cookie baking/unbaking, with no database connection
SSOEnablerUtil(Connection)	Creates a utility object for application cookie baking/unbaking, with database connection
Methods
bakeAppCookie(String, String)	This method will bake the input application cookie for encryption and hashing The return string will be encrypted along with hashed application cookie
genHtmlPostForm(String)	This method will generate a html post form to the login server url from generate redirect url
genRedirect(String)	This method will generate a html redirect to the specified url
setDbConnection(Connection)	Initializes utility object for application cookie baking/unbaking, with a database connection
unbakeAppCookie(String, String)	This method will unbake the input baked application cookie The return string will be decrypted application cookie

Inherited Member Summary
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

SSOEnablerUtil()

Syntax:

public  SSOEnablerUtil()

Description:

Creates a utility object for application cookie baking/unbaking, with no database connection

SSOEnablerUtil(Connection)

Syntax:

public  SSOEnablerUtil(java.sql.Connection p_db_conn)

Description:

Creates a utility object for application cookie baking/unbaking, with database connection

Methods

bakeAppCookie(String, String)

Syntax:

public java.lang.String bakeAppCookie(java.lang.String p_listenerToken, 
java.lang.String p_appCookie)

Description:

This method will bake the input application cookie for encryption and hashing The return string will be encrypted along with hashed application cookie

Parameters:

p_listenerToken - Listener token for the specific login server

p_appCookie - Application cookie

Returns:

Baked application cookie

Throws:

SSOEnablerException - if the database connection lost or any other error occurs

genHtmlPostForm(String)

Syntax:

public static java.lang.String genHtmlPostForm(java.lang.String p_
genRedirectUrl)

Description:

This method will generate a html post form to the login server url from generate redirect url

Parameters:

p_genRedirectUrl - generate redirect url

Returns:

html redirect url

Throws:

IllegalArgumentException - if the input url is incorrect

genRedirect(String)

Syntax:

public static java.lang.String genRedirect(java.lang.String p_redirectUrl)

Description:

This method will generate a html redirect to the specified url

Parameters:

p_redirectUrl - generate redirect url

Returns:

html post form for login server

Throws:

IllegalArgumentException - if the input url is incorrect

setDbConnection(Connection)

Syntax:

public void setDbConnection(java.sql.Connection p_db_conn)

Description:

Initializes utility object for application cookie baking/unbaking, with a database connection

Throws:

SSOEnablerException - if the database connection lost

unbakeAppCookie(String, String)

Syntax:

public java.lang.String unbakeAppCookie(java.lang.String p_listenerToken, 
java.lang.String p_bakedAppCookie)

Description:

This method will unbake the input baked application cookie The return string will be decrypted application cookie

Parameters:

p_listenerToken - Listener token for the specific login server

p_bakedAppCookie - Unbaked application cookie

Returns:

Unbaked application cookie

Throws:

SSOEnablerException - if the database connection is lost or any other error occurs

oracle.security.sso.enabler

SSOIpCheckException

Syntax:

public class SSOIpCheckException extends SSOEnablerException
 
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +-- SSOEnablerException
                    |
                    +--oracle.security.sso.enabler.SSOIpCheckException

All Implemented Interfaces:

java.io.Serializable

Description

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

Member Summary
Constructors
SSOIpCheckException()	Constructs a SSOIpCheckException object with out error message.
SSOIpCheckException(String)	Constructs a SSOIpCheckException object with a error message.

Inherited Member Summary
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructors

SSOIpCheckException()

Syntax:

public  SSOIpCheckException()

Description:

Constructs a SSOIpCheckException object with out error message.

SSOIpCheckException(String)

Syntax:

public  SSOIpCheckException(java.lang.String p_str)

Description:

Constructs a SSOIpCheckException object with a error message.

oracle.security.sso.enabler

SSOTokenExpiredException

Syntax:

public class SSOTokenExpiredException extends SSOEnablerException
 
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +-- SSOEnablerException
                    |
                    +--oracle.security.sso.enabler.SSOTokenExpiredExcept
ion

All Implemented Interfaces:

java.io.Serializable

Description:

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

Member Summary
Constructors
SSOTokenExpiredException()	Constructs a SSOTokenExpiredException object with out error message.
SSOTokenExpiredException(String)	Constructs a SSOTokenExpiredException object with a error message.

Inherited Member Summary
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructors

SSOTokenExpiredException()

Syntax:

public  SSOTokenExpiredException()

Description:

Constructs a SSOTokenExpiredException object with out error message.

SSOTokenExpiredException(String)

Syntax:

public  SSOTokenExpiredException(java.lang.String p_str)

Description:

Constructs a SSOTokenExpiredException object with a error message.

oracle.security.sso.enabler

SSOUserInfo

Syntax:

public class SSOUserInfo extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.security.sso.enabler.SSOUserInfo

Description:

This class is used for returning user information after parsing redirect url from SSOEnabler class

Since:

1.0

Member Summary
Methods
getIPAddress()	Returns IP Address
getSiteTimeStamp()	Returns the site time stamp
getSSOTimeRemaining()	Returns remaining Single Sign-On time in hours
getSSOUserName()	Returns Single Sign-On user name
getUrlRequested()	Returns requested url

Inherited Member Summary
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods

getIPAddress()

Syntax:

public java.lang.String getIPAddress()

Description:

Returns IP Address

getSiteTimeStamp()

Syntax:

public java.sql.Date getSiteTimeStamp()

Description:

Returns the site time stamp

getSSOTimeRemaining()

Syntax:

public int getSSOTimeRemaining()

Description:

Returns remaining Single Sign-On time in hours

getSSOUserName()

Syntax:

public java.lang.String getSSOUserName()

Description:

Returns Single Sign-On user name

getUrlRequested()

Syntax:

public java.lang.String getUrlRequested()

Description:

Returns requested url

oracle.security.sso.enabler

SSOVersionException

Syntax:

public class SSOVersionException extends  SSOEnablerException
 
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +-- SSOEnablerException
                    |
                    +--oracle.security.sso.enabler.SSOVersionException

All Implemented Interfaces:

java.io.Serializable

Description

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

Member Summary
Constructors
SSOVersionException()	Constructs a SSOVersionException object with out a error message.
SSOVersionException(String)	Constructs a SSOVersionException object with a error message.

Inherited Member Summary
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructors

SSOVersionException()

Syntax:

public  SSOVersionException()

Description:

Constructs a SSOVersionException object with out a error message.

SSOVersionException(String)

Syntax:

public  SSOVersionException(java.lang.String p_str)

Description:

Constructs a SSOVersionException object with a error message.