com.googlecode.fascinator.portal.sso

Class USQSSO

java.lang.Object

com.googlecode.fascinator.portal.sso.USQSSO

All Implemented Interfaces:

SSOInterface

public class USQSSO
extends java.lang.Object
implements SSOInterface

Fascinator and Single Sign-On integration for USQ.

Author:

Greg Pendlebury Most of this work originally comes from other USQ authors:, Kyaw Htay Aung, Jonathon Fowler

Constructor Summary

Constructors

Constructor and Description
USQSSO()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId() Return the USQSSO ID.
java.lang.String	getInterface(java.lang.String ssoUrl) Return the HTML snippet to use in the interface.
java.lang.String	getLabel() Return the on-screen label to describing this implementation.
java.util.List<java.lang.String>	getRolesList(JsonSessionState session) Get a list of roles possessed by the current user from the SSO Service.
com.googlecode.fascinator.api.authentication.User	getUserObject(JsonSessionState session) Get the current user details in a User object.
void	logout(JsonSessionState session) We cannot log the user out of UConnect, but we can clear Fascinator session data regarding this user.
void	ssoCheckUserDetails(JsonSessionState session) Get user details from the SSO Service and set them in the user session.
java.lang.String	ssoGetRemoteLogonURL(JsonSessionState session) Retrieve the login URL for redirection.
void	ssoInit(JsonSessionState session, javax.servlet.http.HttpServletRequest request) Initialize the SSO Service
void	ssoPrepareLogin(JsonSessionState session, java.lang.String returnAddress, java.lang.String server) Prepare the SSO Service to receive a login from the user

Methods inherited from class java.lang.Object

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

Constructor Detail

USQSSO

public USQSSO()

Method Detail

getId

public java.lang.String getId()

Return the USQSSO ID. Must match configuration at instantiation.

Specified by:

getId in interface SSOInterface

Returns:

String The SSO implementation ID.

getLabel

public java.lang.String getLabel()

Return the on-screen label to describing this implementation.

Specified by:

getLabel in interface SSOInterface

Returns:

String The SSO implementation label.

getInterface

public java.lang.String getInterface(java.lang.String ssoUrl)

Return the HTML snippet to use in the interface. Implementations can append additional params to URLs. Like so: "?ssoId=OpenID&{customString}" eg: "?ssoId=OpenID&provider=Google"

Specified by:

getInterface in interface SSOInterface

Parameters:

ssoUrl - The basic ssoUrl for the server.

Returns:

String The string to display as link text.

getUserObject

public com.googlecode.fascinator.api.authentication.User getUserObject(JsonSessionState session)

Get the current user details in a User object.

Specified by:

getUserObject in interface SSOInterface

Returns:

User A user object containing the current user.

logout

public void logout(JsonSessionState session)

We cannot log the user out of UConnect, but we can clear Fascinator session data regarding this user.

Specified by:

logout in interface SSOInterface

ssoInit

public void ssoInit(JsonSessionState session,
           javax.servlet.http.HttpServletRequest request)
             throws java.lang.Exception

Initialize the SSO Service

Specified by:

ssoInit in interface SSOInterface

Parameters:

session - The server session data

request - The incoming servlet request

Throws:

java.lang.Exception - if any errors occur

ssoPrepareLogin

public void ssoPrepareLogin(JsonSessionState session,
                   java.lang.String returnAddress,
                   java.lang.String server)
                     throws java.lang.Exception

Prepare the SSO Service to receive a login from the user

Specified by:

ssoPrepareLogin in interface SSOInterface

Parameters:

returnAddress - The address to come back to after the login

server - The server domain

Throws:

java.lang.Exception - if any errors occur

ssoGetRemoteLogonURL

public java.lang.String ssoGetRemoteLogonURL(JsonSessionState session)

Retrieve the login URL for redirection.

Specified by:

ssoGetRemoteLogonURL in interface SSOInterface

Returns:

String The URL used by the SSO Service for logins

ssoCheckUserDetails

public void ssoCheckUserDetails(JsonSessionState session)

Get user details from the SSO Service and set them in the user session.

Specified by:

ssoCheckUserDetails in interface SSOInterface

getRolesList

public java.util.List<java.lang.String> getRolesList(JsonSessionState session)

Get a list of roles possessed by the current user from the SSO Service.

Specified by:

getRolesList in interface SSOInterface

Returns:

List Array of roles.