com.plumtree.portaluiinfrastructure.sso.integrations
Class WindowsIntegratedAuth

java.lang.Object
  com.plumtree.portaluiinfrastructure.sso.integrations.WindowsIntegratedAuth

All Implemented Interfaces:

ISSOIntegration

public class WindowsIntegratedAuth
extends java.lang.Object
implements ISSOIntegration

Handles SSO integration with Windows Integrated Authentication, aka NTLM.

Author:

Mike Jahr

Constructor Summary

WindowsIntegratedAuth()
Creates a new WindowsIntegratedAuth object.

Method Summary

SSOLoginInfo	GetLoginInfo(IXPRequest request) Returns login information extracted from the headers of the given request.
java.lang.String[]	GetSecureCookies() Returns the names of secure cookies which should be forwarded to portlets for authentication.
java.lang.String[]	GetSecureHeaders() Returns an array of header prefixes which should not be forwarded in requests to portlets.
java.lang.String	GetSSOProductName() Returns a brief description of the SSO product.
boolean	Initialize(XPHashtable mapSettings) Initializes the object with settings from the sso.xml config file.
boolean	OnLogout(IXPResponse response, java.lang.String sReturnURL) Performs any logout actions required by the SSO product.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowsIntegratedAuth

public WindowsIntegratedAuth()

Creates a new WindowsIntegratedAuth object.

Method Detail

GetLoginInfo

public SSOLoginInfo GetLoginInfo(IXPRequest request)

Description copied from interface: ISSOIntegration

Returns login information extracted from the headers of the given request. This method is called whenever a user logs in to Plumtree. This method must be thread safe.

Specified by:

GetLoginInfo in interface ISSOIntegration

Parameters:

request - an IXPRequest value

Returns:

a SSOLoginInfo value

See Also:

com.plumtree.portaluiinfrastructure.sso.ISSOIntegration#GetLoginInfo()

GetSSOProductName

public java.lang.String GetSSOProductName()

Description copied from interface: ISSOIntegration

Returns a brief description of the SSO product. This method will only be called once, and the result cached.

Specified by:

GetSSOProductName in interface ISSOIntegration

Returns:

a description

See Also:

ISSOIntegration.GetSSOProductName()

GetSecureCookies

public java.lang.String[] GetSecureCookies()

Description copied from interface: ISSOIntegration

Returns the names of secure cookies which should be forwarded to portlets for authentication. This method will only be called once, and the result cached.

Specified by:

GetSecureCookies in interface ISSOIntegration

Returns:

a String[] array of cookie names

See Also:

ISSOIntegration.GetSecureCookies()

GetSecureHeaders

public java.lang.String[] GetSecureHeaders()

Description copied from interface: ISSOIntegration

Returns an array of header prefixes which should not be forwarded in requests to portlets. For example, if "PT_" is in the array, no headers beginning with "PT_" will be included in HTTP requests to portlets. This list is case-sensitive. This method will only be called once, and the result cached.

Specified by:

GetSecureHeaders in interface ISSOIntegration

Returns:

a String[] array of header names

See Also:

ISSOIntegration.GetSecureHeaders()

Initialize

public boolean Initialize(XPHashtable mapSettings)

Description copied from interface: ISSOIntegration

Initializes the object with settings from the sso.xml config file. The map is from String to XPArrayList.

Specified by:

Initialize in interface ISSOIntegration

Parameters:

mapSettings - an XPHashtable of settings

Returns:

a boolean indicating success

See Also:

com.plumtree.portaluiinfrastructure.sso.ISSOIntegration#Initialize()

OnLogout

public boolean OnLogout(IXPResponse response,
                        java.lang.String sReturnURL)

Description copied from interface: ISSOIntegration

Performs any logout actions required by the SSO product. This can include clearing cookies or redirecting to another web page that performs logout actions. If a redirect is performed, the other web page should redirect back to sReturnURL after performing the SSO logout. Note that this function is only called if the user clicks the logout link in the portal, not if their session times out or they close the browser window. This method must be thread safe.

Specified by:

OnLogout in interface ISSOIntegration

Parameters:

response - an IXPResponse value

Returns:

true if a redirect is required, false otherwise

See Also:

com.plumtree.portaluiinfrastructure.sso.ISSOIntegration#Logout()