com.plumtree.portaluiinfrastructure.sso
Class SSOIntegrator

java.lang.Object
  com.plumtree.portaluiinfrastructure.sso.SSOIntegrator

All Implemented Interfaces:

ISSOHelper

public final class SSOIntegrator
extends java.lang.Object
implements ISSOHelper

Helper class which handles integration with SSO products.

Author:

Mike Jahr

Field Summary

static java.lang.String	REQUEST_URL_BEFORE_SSO_LOGIN This is the name of the session attribute that holds the GW URL that was accessed before the session was established.
static int	SSOSTATE_ATTEMPTING SSOSTATEATTRIBUTE constant indicating that an sso user is attempting to log in.
static int	SSOSTATE_LOGGEDIN SSOSTATEATTRIBUTE constant indicating that an sso user is logged in.
static int	SSOSTATE_LOGGEDOUT SSOSTATEATTRIBUTE constant indicating that no sso user is logged in or attempting to log in.
static java.lang.String	SSOSTATEATTRIBUTE Attribute on the subsession indicating whether sso login has been attempted.
static int	SSOVENDOR_BASIC Config.xml SSOVENDOR constant: Basic SSO
static int	SSOVENDOR_CUSTOM Config.xml SSOVENDOR constant: custom integration
static int	SSOVENDOR_NETEGRITY Config.xml SSOVENDOR constant: Netegrity Siteminder
static int	SSOVENDOR_NONE Config.xml SSOVENDOR constant: SSO disabled.
static int	SSOVENDOR_OBLIX Config.xml SSOVENDOR constant: Oblix NetPoint
static int	SSOVENDOR_OSSO Config.xml SSOVENDOR constant: Oracle Application Server Single-Sign On
static int	SSOVENDOR_WINDOWS Config.xml SSOVENDOR constant: Windows Integrated Auth (aka NTLM)

Constructor Summary

SSOIntegrator()

Method Summary

Redirect	DoLoginRedirect(RequestData tempData, java.lang.String sQueryString) Performs a redirect to the SSO login page, unless SSO login has previously failed.
boolean	DoLogoutRedirect(RequestData tempData) Calls the SSO logout code and performs an SSO logout redirect if necessary.
static java.lang.String	GetDefaultPrefix() Returns the default auth source prefix.
static SSOLoginInfo	GetLoginInfo(IXPRequest request) Returns login info from the given request.
static IPTSSOInfo	GetSSOInfo(IXPRequest request, SSOLoginInfo info) Returns a PTSSOInfo object with the correct values.
static boolean	IsCaptureBasicAuthEnabled() Indicates whether capture basic auth is enabled.
boolean	IsSSOEnabled() Indicates whether SSO is enabled at the portal level.
static void	StaticInitConfig(PTConfigVarPack vpConfig) Initializes global SSO settings using the given settings from x_config.xml.
static void	StaticInitSSO(PTSSOVarPack vpSSO) Initializes SSO settings using the config settings.
static void	UpdateSSOCookieHeader(AActivitySpace _asOwner)

Methods inherited from class java.lang.Object

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

Field Detail

SSOVENDOR_NONE

public static final int SSOVENDOR_NONE

Config.xml SSOVENDOR constant: SSO disabled.

See Also:

Constant Field Values

SSOVENDOR_NETEGRITY

public static final int SSOVENDOR_NETEGRITY

Config.xml SSOVENDOR constant: Netegrity Siteminder

See Also:

Constant Field Values

SSOVENDOR_OBLIX

public static final int SSOVENDOR_OBLIX

Config.xml SSOVENDOR constant: Oblix NetPoint

See Also:

Constant Field Values

SSOVENDOR_WINDOWS

public static final int SSOVENDOR_WINDOWS

Config.xml SSOVENDOR constant: Windows Integrated Auth (aka NTLM)

See Also:

Constant Field Values

SSOVENDOR_OSSO

public static final int SSOVENDOR_OSSO

Config.xml SSOVENDOR constant: Oracle Application Server Single-Sign On

See Also:

Constant Field Values

SSOVENDOR_BASIC

public static final int SSOVENDOR_BASIC

Config.xml SSOVENDOR constant: Basic SSO

See Also:

Constant Field Values

SSOVENDOR_CUSTOM

public static final int SSOVENDOR_CUSTOM

Config.xml SSOVENDOR constant: custom integration

See Also:

Constant Field Values

REQUEST_URL_BEFORE_SSO_LOGIN

public static final java.lang.String REQUEST_URL_BEFORE_SSO_LOGIN

This is the name of the session attribute that holds the GW URL that was accessed before the session was established. -- moose

See Also:

Constant Field Values

SSOSTATEATTRIBUTE

public static final java.lang.String SSOSTATEATTRIBUTE

Attribute on the subsession indicating whether sso login has been attempted.

See Also:

Constant Field Values

SSOSTATE_LOGGEDOUT

public static final int SSOSTATE_LOGGEDOUT

SSOSTATEATTRIBUTE constant indicating that no sso user is logged in or attempting to log in.

See Also:

Constant Field Values

SSOSTATE_ATTEMPTING

public static final int SSOSTATE_ATTEMPTING

SSOSTATEATTRIBUTE constant indicating that an sso user is attempting to log in.

See Also:

Constant Field Values

SSOSTATE_LOGGEDIN

public static final int SSOSTATE_LOGGEDIN

SSOSTATEATTRIBUTE constant indicating that an sso user is logged in.

See Also:

Constant Field Values

Constructor Detail

SSOIntegrator

public SSOIntegrator()

Method Detail

GetLoginInfo

public static SSOLoginInfo GetLoginInfo(IXPRequest request)

Returns login info from the given request.

Parameters:

request - an IXPRequest value

Returns:

the default prefix

GetSSOInfo

public static IPTSSOInfo GetSSOInfo(IXPRequest request,
                                    SSOLoginInfo info)

Returns a PTSSOInfo object with the correct values.

Parameters:

request - an IXPRequest value

info - a SSOLoginInfo value

Returns:

an IPTSSOInfo value

GetDefaultPrefix

public static java.lang.String GetDefaultPrefix()

Returns the default auth source prefix.

Returns:

the default prefix

DoLogoutRedirect

public boolean DoLogoutRedirect(RequestData tempData)

Calls the SSO logout code and performs an SSO logout redirect if necessary.

Specified by:

DoLogoutRedirect in interface ISSOHelper

Parameters:

tempData - a RequestData value

Returns:

a boolean value

DoLoginRedirect

public Redirect DoLoginRedirect(RequestData tempData,
                                java.lang.String sQueryString)

Performs a redirect to the SSO login page, unless SSO login has previously failed.

Specified by:

DoLoginRedirect in interface ISSOHelper

Parameters:

tempData - a RequestData value

sQueryString - a String value

Returns:

boolean true if we are redirecting, false otherwise

IsSSOEnabled

public boolean IsSSOEnabled()

Indicates whether SSO is enabled at the portal level.

Specified by:

IsSSOEnabled in interface ISSOHelper

Returns:

a boolean value

See Also:

ISSOHelper.IsSSOEnabled()

IsCaptureBasicAuthEnabled

public static boolean IsCaptureBasicAuthEnabled()

Indicates whether capture basic auth is enabled.

Returns:

a boolean value

StaticInitConfig

public static void StaticInitConfig(PTConfigVarPack vpConfig)

Initializes global SSO settings using the given settings from x_config.xml. Note that only StaticInitSSO actually enables SSO.

Parameters:

vpConfig - a PTConfigVarPack value

StaticInitSSO

public static void StaticInitSSO(PTSSOVarPack vpSSO)

Initializes SSO settings using the config settings. Can only be called once globally.

Parameters:

vpSSO - a PTSSOVarPack value

UpdateSSOCookieHeader

public static void UpdateSSOCookieHeader(AActivitySpace _asOwner)