Understanding a security adapter class
Implement the security manager by writing a class that extends com.actuate.iportal.security.iPortalSecurityAdapter. This class contains the following methods.
authenticate( )
Syntax
boolean authenticate( javax.servlet.http.HttpServletRequest request )
Description
Required method that evaluates the current user’s security credentials. The Login module calls authenticate( ) to validate the current user’s security credentials. If authenticate( ) returns false, the user is redirected to the login page.
Returns
True for successful credential evaluation and false otherwise.
Throws
An AuthenticationException indicating the reason for the failure, if credential evaluation is not successful.
getExtendedCredentials( )
Syntax
byte[ ] getExtendedCredentials( )
Description
Retrieves the current user’s extended security credentials.
Returns
A byte array representing any extended credentials for the iServer to use to authenticate the user, or null if there are no extended credentials to evaluate.
getPassword( )
Syntax
String getPassword( )
Description
Required method that retrieves the current user’s password. The Login module calls getPassword( ) and uses the password to establish a connection to the application server and file system.
Returns
A string that is the password to use to establish the connection.
getUserHomeFolder( )
Syntax
String getUserHomeFolder( )
Description
Retrieves the current user’s home folder. The Login module calls getUserHomeFolder( ) to access the user’s files.
Returns
A string that is the user’s home folder. It is null if there is no home folder for the user.
getUserName( )
Syntax
String getUserName( )
Description
Retrieves the current user’s login name. The Login module calls getUserName( ) to establish a connection to the application server and file system.
Returns
A string containing the user name that the application server recognizes.
isEnterprise( )
Syntax
boolean isEnterprise( )
Description
Evaluates whether the user connects to an Encyclopedia volume. The Login module calls isEnterprise( ) to determine whether to use a repository on the file system.
Returns
False.

Additional Links:

Copyright Actuate Corporation 2012