sapphire.ext

Class BaseWebSSOHandler

java.lang.Object

sapphire.ext.BaseWebSSOHandler

All Implemented Interfaces:

LogonRequestValidator

public class BaseWebSSOHandler
extends java.lang.Object
implements LogonRequestValidator

Created by IntelliJ IDEA. User: cliu Date: 7/24/13 Time: 4:37 PM To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
BaseWebSSOHandler()

Method Summary

Modifier and Type	Method and Description
PropertyList	getSSOAttributes(HttpServletRequest request) Retrieve the SSO attributes in the Request object
java.lang.String	getUserid(HttpServletRequest request) override this method to extract user identity to map to LV a sysuserid or logonname.
java.lang.String	getUseridattributename()
static java.lang.String	getUseridattributename(java.lang.String portalId, java.lang.String databaseId)
java.lang.String	getWebssodatabase()
java.lang.String	getWebssoesigurl()
static java.lang.String	getWebssoesigurl(java.lang.String portalId, java.lang.String databaseId)
java.lang.String	getWebssologoffurl()
void	handleLVLogonError(java.lang.String errorMessage, HttpServletResponse response) allow customized handling LV log on error when a LV user logon fails after Web SSO authentication Default to writing the LV log on error message to the http servlet response in red.
boolean	isAllowHeaderAttributes()
static boolean	isAllowHeaderAttributes(java.lang.String portalId, java.lang.String databaseId)
static boolean	isEnabled(java.lang.String portalId, java.lang.String databaseId)
boolean	isRequireSysuserInfo() System calls validateRequest with Request and DataSet sysuser if this method returns true and with Request only if returns false
void	logoff(HttpServletRequest request, HttpServletResponse response) Called after logout LV Override this method to customize web sso log out after log out LV.
void	setAllowHeaderAttributes(boolean allowHeaderAttributes)
static void	setPortalSSOProps(java.lang.String databaseId, java.lang.String portalId, PropertyList portalProps) Called during system startup and populated.
void	setUseridattributename(java.lang.String useridattributename)
void	setWebssodatabase(java.lang.String webssodatabase)
void	setWebssoesigurl(java.lang.String webssoesigurl)
void	setWebssologoffurl(java.lang.String webssologoffurl)
java.lang.String	validateRequest(HttpServletRequest request) override this method to allow customized validation of request attributes to further determine whether to authorize access to the application after initial authentication return not allow acess message html or empty string if pass validation.
java.lang.String	validateRequest(HttpServletRequest request, DataSet sysuser) override this method to allow customized validation of request attributes to further determine whether to authorize access to the application after initial authentication return not allow acess message html or empty string if pass validation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseWebSSOHandler

public BaseWebSSOHandler()

Method Detail

setPortalSSOProps

public static void setPortalSSOProps(java.lang.String databaseId,
                                     java.lang.String portalId,
                                     PropertyList portalProps)

Called during system startup and populated.

Parameters:

databaseId -

portalId -

portalProps -

isEnabled

public static boolean isEnabled(java.lang.String portalId,
                                java.lang.String databaseId)

getWebssoesigurl

public static java.lang.String getWebssoesigurl(java.lang.String portalId,
                                                java.lang.String databaseId)

getUseridattributename

public static java.lang.String getUseridattributename(java.lang.String portalId,
                                                      java.lang.String databaseId)

isAllowHeaderAttributes

public static boolean isAllowHeaderAttributes(java.lang.String portalId,
                                              java.lang.String databaseId)

isRequireSysuserInfo

public boolean isRequireSysuserInfo()

Description copied from interface: LogonRequestValidator

System calls validateRequest with Request and DataSet sysuser if this method returns true and with Request only if returns false

Specified by:

isRequireSysuserInfo in interface LogonRequestValidator

Returns:

boolean

getWebssodatabase

public java.lang.String getWebssodatabase()

setWebssodatabase

public void setWebssodatabase(java.lang.String webssodatabase)

getWebssologoffurl

public java.lang.String getWebssologoffurl()

setWebssologoffurl

public void setWebssologoffurl(java.lang.String webssologoffurl)

getWebssoesigurl

public java.lang.String getWebssoesigurl()

setWebssoesigurl

public void setWebssoesigurl(java.lang.String webssoesigurl)

getUseridattributename

public java.lang.String getUseridattributename()

setUseridattributename

public void setUseridattributename(java.lang.String useridattributename)

isAllowHeaderAttributes

public boolean isAllowHeaderAttributes()

setAllowHeaderAttributes

public void setAllowHeaderAttributes(boolean allowHeaderAttributes)

getUserid

public java.lang.String getUserid(HttpServletRequest request)

override this method to extract user identity to map to LV a sysuserid or logonname. Default implementation calls request.getRemoteUser() API

Parameters:

request -

Returns:

String

getSSOAttributes

public PropertyList getSSOAttributes(HttpServletRequest request)

Retrieve the SSO attributes in the Request object

Parameters:

request -

Returns:

validateRequest

public java.lang.String validateRequest(HttpServletRequest request)

override this method to allow customized validation of request attributes to further determine whether to authorize access to the application after initial authentication return not allow acess message html or empty string if pass validation. Default return empty string.

Specified by:

validateRequest in interface LogonRequestValidator

Parameters:

request -

Returns:

String

validateRequest

public java.lang.String validateRequest(HttpServletRequest request,
                                        DataSet sysuser)

override this method to allow customized validation of request attributes to further determine whether to authorize access to the application after initial authentication return not allow acess message html or empty string if pass validation. Default return empty string.

Specified by:

validateRequest in interface LogonRequestValidator

Parameters:

request -

sysuser -

Returns:

String

handleLVLogonError

public void handleLVLogonError(java.lang.String errorMessage,
                               HttpServletResponse response)

allow customized handling LV log on error when a LV user logon fails after Web SSO authentication Default to writing the LV log on error message to the http servlet response in red.

Parameters:

errorMessage -

response -

logoff

public void logoff(HttpServletRequest request,
                   HttpServletResponse response)

Called after logout LV Override this method to customize web sso log out after log out LV. Default implementation redirects to configured webssologoffurl or to the logoffmessage.jsp

Parameters:

request -

response -