Class actuate.AuthenticationException

Description

AuthenticationException provides an object to pass to a error callback function when an authentication exception occurs. The AuthenticationException object contains references to the URL, the UserId, and the request options used in the authentication attempt.

Constructor

The AuthenticationException object is constructed when actuate.Authenticate( ) fails.

Function summary

Table 4-3 lists actuate.AuthenticationException functions.

Table 4-3

actuate.AuthenticationException functions

Function	Description
getIportalUrl( )	Returns the web service URL
getRequestOptions( )	Returns the request options
getUserId( )	Returns the user ID

actuate.AuthenticationException.getIportalUrl

Syntax

string AuthenticationException.getIportalUrl( )

Returns the Deployment Kit for BIRT reports or Information Console URL.

Returns

String.

Example

The following sample code retrieves the URL from an exception:

return AuthenticationException.getIportalUrl( );

actuate.AuthenticationException.getRequestOptions

Syntax

actuate.RequestOptions AuthenticationException.getRequestOptions( )

Returns an instance of the requestOptions that modified the URL that caused the exception, if applicable.

Returns

actuate.RequestOptions object. A RequestOptions object defines URL parameters sent in the authentication request, such as the iServer URL, Encyclopedia volume, or repository type. The RequestOptions object can also add custom parameters to the URL.

Example

The following sample code retrieves the RequestOptions object that caused the exception:

var exceptReqOpts = AuthenticationException.getRequestOptions( );

actuate.AuthenticationException.getUserId

Syntax

string AuthenticationException.getUserId( )

Returns the UserId used in the failed authentication attempt.

Returns

String.

Example

The following sample code retrieves the UserId from an exception:

return AuthenticationException.getUserId( );

Copyright Actuate Corporation 2012