com.cleo.lexicom.external

Interface IPortalUserAuthentication

public interface IPortalUserAuthentication

Establishes an interface for custom VersaLex portal user authentication. If authentication has already occurred prior to invoking the portal servlet, the expectation is that the HTTP request can be used to confirm the authentication and return the username; otherwise the HTTP response can be used to redirect the user to a different login page. If null is returned, the default VersaLex portal login dialog is displayed. Refer to IListenerController.setPortalUserAuthentication(IPortalUserAuthentication).

A custom VersaLex portal user authentication implementation can also be set via the JVM parameter -Dcleo.iportaluserauthentication.class=fully qualified class name. Jar containing implementation should be placed in the VersaLexHome\lib\api folder.

Method Summary

Modifier and Type	Method and Description
java.lang.String	authenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Initial authentication of a new portal session
default java.lang.String	getExternalSessionId(javax.servlet.http.HttpServletRequest request) Returns an ID that should be associated with the current session, or null to forgo this association.

Method Detail

authenticate

java.lang.String authenticate(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception

Initial authentication of a new portal session

Parameters:

request - the HTTP portal servlet request

response - the HTTP portal servlet response; response can be redirected to a different login page

Returns:

the authenticated username or null if not authenticated

Throws:

java.lang.Exception

getExternalSessionId

default java.lang.String getExternalSessionId(javax.servlet.http.HttpServletRequest request)

Returns an ID that should be associated with the current session, or null to forgo this association. If a different ID is returned for a previously authenticated portal session than in the initial authentication, this will trigger re-authentication. Re-authentication will only be triggered when visiting the portal entry point.

Parameters:

request - the HTTP portal servlet request

Returns:

the ID to associate with this session, or null not to associate any ID