|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISSOIntegration
Interface for classes which integrate Plumtree with SSO products. Classes
implementing this interface must include a default constructor in order for
Plumtree to instantiate them.
Methods can return null
if they are unimplemented, encounter an
error, or have no return value.
Implementations are used in the following manner: first, a single static
instance is instantiated using reflection. Initialize
is called
on this instance, passing in settings from the SSOSettings
section of x_config.xml
. GetSecureHeaders
,
GetSecureCookies
, and GetSSOProductName
are each
called once on the static instance, and the results cached.
Each time a user logs in, GetLoginInfo
is called on the static
instance to produce a SSOLoginInfo
instance with information
about the current user. GetLoginInfo
may be called concurrently
by several threads, so it must be thread safe.
When a user clicks logout, OnLogout
is called to end the SSO
session. Note that this method is not called every time a session ends, for
instance if a user closes the browser window or a session times out. This
method may also be called concurrently by various threads, so it must also be
thread safe.
SSOLoginInfo
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. |
Method Detail |
---|
boolean Initialize(XPHashtable mapSettings)
sso.xml
config
file. The map is from String
to XPArrayList
.
mapSettings
- an XPHashtable
of settings
boolean
indicating successjava.lang.String GetSSOProductName()
java.lang.String[] GetSecureCookies()
String[]
array of cookie namesjava.lang.String[] GetSecureHeaders()
String[]
array of header namesSSOLoginInfo GetLoginInfo(IXPRequest request)
request
- an IXPRequest
value
SSOLoginInfo
valueSSOLoginInfo
boolean OnLogout(IXPResponse response, java.lang.String sReturnURL)
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.
response
- an IXPResponse
value
true
if a redirect is required, false
otherwise
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |