org.picketlink.social.standalone.openid.api

Class OpenIDManager

java.lang.Object

org.picketlink.social.standalone.openid.api.OpenIDManager

public class OpenIDManager
extends Object

OpenID Manager for consumers

Since:

Jul 6, 2009

Author:

Anil.Saldhana@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenIDManager.CONST
static class	OpenIDManager.OpenIDProviderInformation Information about a provider from the discovery process
static class	OpenIDManager.OpenIDProviderList List of OpenID providers

Constructor Summary

Constructors

Constructor and Description
OpenIDManager(OpenIDRequest theReq)

Method Summary

Methods

Modifier and Type	Method and Description
OpenIDManager.OpenIDProviderInformation	associate(OpenIDProtocolAdapter adapter, OpenIDManager.OpenIDProviderList listOfProviders) Associate with a list of open id providers
boolean	authenticate(OpenIDProtocolAdapter adapter, OpenIDManager.OpenIDProviderInformation providerInfo) Authenticate an user with the provider
OpenIDManager.OpenIDProviderList	discoverProviders()
OpenIDRequest	getOpenIDRequest() Get the OpenID Request
void	logout(OpenIDProtocolAdapter adapter) Log an user out from an openid provider
void	setUserString(String userString) Set the user string
boolean	verify(OpenIDProtocolAdapter adapter, Map<String,String> parameterMap, String receivedURL) Verify a previously authenticated user with the provider

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenIDManager

public OpenIDManager(OpenIDRequest theReq)

Method Detail

setUserString

public void setUserString(String userString)

Set the user string

Parameters:

userString -

getOpenIDRequest

public OpenIDRequest getOpenIDRequest()

Get the OpenID Request

Returns:

discoverProviders

public OpenIDManager.OpenIDProviderList discoverProviders()
                                                   throws OpenIDDiscoveryException,
                                                          OpenIDConsumerException

Throws:

OpenIDDiscoveryException

OpenIDConsumerException

associate

public OpenIDManager.OpenIDProviderInformation associate(OpenIDProtocolAdapter adapter,
                                                OpenIDManager.OpenIDProviderList listOfProviders)
                                                  throws OpenIDConsumerException,
                                                         OpenIDLifeCycleException

Associate with a list of open id providers

Parameters:

adapter - Protocol adapter (such as http)

listOfProviders - (a list of providers from discovery)

Returns:

Throws:

OpenIDConsumerException

OpenIDLifeCycleException

authenticate

public boolean authenticate(OpenIDProtocolAdapter adapter,
                   OpenIDManager.OpenIDProviderInformation providerInfo)
                     throws OpenIDDiscoveryException,
                            OpenIDConsumerException,
                            OpenIDMessageException,
                            OpenIDProtocolException

Authenticate an user with the provider

Parameters:

adapter - protocol adapter

providerInfo - Information about a provider derived from discovery process

Returns:

Throws:

OpenIDDiscoveryException

OpenIDConsumerException

OpenIDMessageException

OpenIDProtocolException

verify

public boolean verify(OpenIDProtocolAdapter adapter,
             Map<String,String> parameterMap,
             String receivedURL)
               throws OpenIDMessageException,
                      OpenIDDiscoveryException,
                      OpenIDAssociationException,
                      OpenIDLifeCycleException

Verify a previously authenticated user with the provider

Parameters:

adapter - protocol adapter

parameterMap - request parameters

receivedURL - url where the response will be received

Returns:

Throws:

OpenIDMessageException

OpenIDDiscoveryException

OpenIDAssociationException

OpenIDLifeCycleException

logout

public void logout(OpenIDProtocolAdapter adapter)
            throws OpenIDLifeCycleException

Log an user out from an openid provider

Parameters:

adapter - protocol adapter

Throws:

OpenIDLifeCycleException