Package org.jivesoftware.admin

Class SiteMinderServletRequestAuthenticator

java.lang.Object

org.jivesoftware.admin.SiteMinderServletRequestAuthenticator

All Implemented Interfaces:

ServletRequestAuthenticator

public class SiteMinderServletRequestAuthenticator
extends Object
implements ServletRequestAuthenticator

Enables CA SiteMinder/Single Sign-On authentication to the admin console - https://www.ca.com/gb/products/ca-single-sign-on.html

To enable, set the system property adminConsole.servlet-request-authenticator = org.jivesoftware.admin.SiteMinderServletRequestAuthenticator and restart Openfire.

Field Summary

Fields

Modifier and Type	Field	Description
static final SystemProperty<String>	SITE_MINDER_HEADER

Constructor Summary

Constructors

Constructor	Description
SiteMinderServletRequestAuthenticator()

Method Summary

Modifier and Type	Method	Description
String	authenticateRequest(javax.servlet.http.HttpServletRequest request)	Attempts to authenticate an HTTP request to a page on the admin console.
static boolean	isEnabled()	Indicates if this ServletRequestAuthenticator is enabled or not

Methods inherited from class java.lang.Object

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

Field Details

SITE_MINDER_HEADER

public static final SystemProperty<String> SITE_MINDER_HEADER

Constructor Details

SiteMinderServletRequestAuthenticator

public SiteMinderServletRequestAuthenticator()

Method Details

isEnabled

public static boolean isEnabled()

Indicates if this ServletRequestAuthenticator is enabled or not

Returns:

true if enabled, otherwise false

authenticateRequest

public String authenticateRequest(javax.servlet.http.HttpServletRequest request)

Description copied from interface: ServletRequestAuthenticator

Attempts to authenticate an HTTP request to a page on the admin console.

Specified by:

authenticateRequest in interface ServletRequestAuthenticator

Parameters:

request - the request to authenticate

Returns:

the username if it was possible to determine from the request, otherwise null