com.sun.liberty
Class LibertyManager

java.lang.Object
  com.sun.liberty.LibertyManager

public class LibertyManager

extends java.lang.Object

LibertyManager forms the basis of the Public APIs. It has all the methods which the JSPs etc. need to use for federation/termination/logout etc.

Constructor Summary

LibertyManager()

Method Summary

static boolean	checkNonce(java.lang.String nonce, java.lang.String user) Deprecated. This method has been deprecated. Please use other means to verify nounce.
static java.lang.String	cleanQueryString(javax.servlet.http.HttpServletRequest request)
static java.lang.String	getAuthnRequestEnvelope(javax.servlet.http.HttpServletRequest request) Gets Authentication Request Envelope from a HTTP servlet request.
static java.lang.String	getConsentHandlerURL(javax.servlet.http.HttpServletRequest request) Returns the ConsentHandler.
static java.lang.String	getCOTKey() Returns the COT key from IFSConstants.
static java.util.List	getDiscoveryBootStrapCredentials(javax.servlet.http.HttpServletRequest request, java.lang.String providerID) Deprecated. This method has been deprecated. Use getDiscoveryBootStrapCredentials( HttpServletRequest request, String providerID, String providerRole)
static java.util.List	getDiscoveryBootStrapCredentials(javax.servlet.http.HttpServletRequest request, java.lang.String providerID, java.lang.String providerRole) Gets the Discovery Service Credentials in the Advice element.
static org.w3c.dom.NodeList	getDiscoveryBootStrapResourceOfferings(javax.servlet.http.HttpServletRequest request, java.lang.String providerID) Deprecated. This method has been deprecated. Use getDiscoveryBootStrapResourceOfferings( HttpServletRequest request, String providerID, String providerRole)
static org.w3c.dom.NodeList	getDiscoveryBootStrapResourceOfferings(javax.servlet.http.HttpServletRequest request, java.lang.String providerID, java.lang.String providerRole) Gets the Discovery Service Resource Offerings nodes in an attribute statement.
static java.lang.String	getErrorPageURL(java.lang.String providerId, javax.servlet.http.HttpServletRequest request) Deprecated. This method has been deprecated. Use getErrorPageURL(String providerID, String providerRole, HttpServletRequest request)
static java.lang.String	getErrorPageURL(java.lang.String providerId, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request) Returns the provider's error page.
static java.util.Set	getFederatedProviders(java.lang.String userName) Returns the set of federated providers for this userName using Account Management API.
static java.lang.String	getFederationDonePageURL(java.lang.String providerID, javax.servlet.http.HttpServletRequest request) Deprecated. This method has been deprecated. Use getFederationDonePageURL(String providerID, String providerRole, HttpServletRequest request)
static java.lang.String	getFederationDonePageURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request) Returns the FederationDonePageURL from the provider ID.
static java.lang.String	getFederationHandlerURL(javax.servlet.http.HttpServletRequest request) Returns the FederationHandler.
static java.lang.String	getFedErrorKey() Returns Federation Error Key
static java.lang.String	getFedRemarkKey() Returns FederationRemark Key
static java.lang.String	getHomeURL(java.lang.String providerID) Deprecated. This method has been deprecated. Use getHomeURL(String providerID, String providerRole)
static java.lang.String	getHomeURL(java.lang.String providerID, java.lang.String providerRole) Returns Provider's HomePageURL.
static boolean	getIDPFederationStatus(java.lang.String user, java.lang.String provider) Gets the federation status of a user name with an Identity Provider.
static java.util.Iterator	getIDPList() Returns a list of all trusted Identity Providers.
static java.util.Iterator	getIDPList(java.lang.String hostedProviderID) Returns a list of all trusted Identity Providers for a given hosted provider IDs.
static java.lang.String	getInterSiteURL(javax.servlet.http.HttpServletRequest request) Returns the interSiteURL from IFSConstants.
static java.lang.String	getIntroducedProvider(javax.servlet.http.HttpServletRequest request) Gets the ID of the provider discovered via the introduction protocol.
static java.lang.String	getLECPContentType() Gets Liberty-enabled client and proxy profile HTTP content type
static java.lang.String	getLECPHeaderName() Gets Liberty-enabled client and proxy profile HTTP header name.
static java.util.Set	getListOfCOTs(java.lang.String providerId) Deprecated. This method has been deprecated. Use getListOfCOTs(String providerID, String providerRole)
static java.util.Set	getListOfCOTs(java.lang.String providerId, java.lang.String providerRole) Returns the List of COTs for the given Provider.
static java.lang.String	getLoginURL(javax.servlet.http.HttpServletRequest request) Returns the LoginURL from IFSConstants
static java.lang.String	getLRURLKey() Returns the LRURLKey from IFSConstants.
static NameIdentifier	getMappedNameIdentifier(java.lang.String hostedSPMetaAlias, SSOToken ssoToken, java.lang.String remoteSPEntityID) Returns NameIdentifier between the IDP and the other SP for the same principal.
static java.lang.String	getMetaAlias(java.lang.String providerID) Deprecated. This method has been deprecated. Use getMetaAlias(String providerID, String providerRole)
static java.lang.String	getMetaAlias(java.lang.String providerID, java.lang.String providerRole) Returns metaAlias from provider ID
static java.lang.String	getMetaAliasKey() Returns the metaAliasKey from IFSConstants.
static java.lang.String	getNameRegistrationDonePageURL(java.lang.String providerID, javax.servlet.http.HttpServletRequest request) Deprecated. This method has been deprecated. Use getNameRegistrationDonePageURL(String providerID, String providerRole, HttpServletRequest request)
static java.lang.String	getNameRegistrationDonePageURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request) Returns the Name RegistrationDonePageURL from the providerID.
static java.lang.String	getNameRegistrationProviderIDKey() Returns name registration provider ID key.
static java.lang.String	getNameRegistrationURL(java.lang.String providerID, javax.servlet.http.HttpServletRequest request) Deprecated. This method has been deprecated. Use getNameRegistrationURL(String providerID, String providerRole, HttpServletRequest request)
static java.lang.String	getNameRegistrationURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request) Returns NameRegistrationURL.
static java.lang.String	getNewRequest(javax.servlet.http.HttpServletRequest request) Creates New Request ID from the HttpRequestServlet.
static java.lang.String	getNonce(java.lang.String user) Deprecated. This method has been deprecated. Please use other means to generate nounce.
static java.lang.String	getPreLoginServletURL(java.lang.String providerID, javax.servlet.http.HttpServletRequest request) Deprecated. This method has been deprecated. Use getPreLoginServletURL(String providerID, String providerRole, HttpServletRequest request)
static java.lang.String	getPreLoginServletURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request) Returns PreLoginServlet URL and appends metaAlias to it.
static java.lang.String	getProviderID(java.lang.String metaAlias) Returns providerID from the ProviderAlias using AllianceMgmt calls.
static java.lang.String	getProviderIDKey() Returns the providerIDKey from IFSConstants.
static java.lang.String	getProviderRole(java.lang.String metaAlias) Returns providerRole from the ProviderAlias using AllianceMgmt calls.
static java.util.Set	getProvidersToFederate(java.lang.String providerID, java.lang.String userName) Returns the list of all Trusted Identity Providers of this user not already federated with.
static java.util.Set	getRegisteredProviders(java.lang.String userName) Returns registered providers of an user.
static java.lang.String	getRequestIDKey() Returns the requestIDKey from IFSConstants.
static java.lang.String	getSelectedProviderKey() Returns the selectedProviderKey from IFSConstants.
static boolean	getSPFederationStatus(java.lang.String user, java.lang.String provider) Gets the federations status of a user with an Service Provider (This method assumes that the user is already federated with the provider).
static java.util.Iterator	getSPList() Returns a list of all trusted Service Providers
static java.util.Iterator	getSPList(java.lang.String hostedProviderID) Returns a list of all trusted Service Providers for this Hosted Provider.
static java.lang.String	getSuccintID(java.lang.String providerID) Deprecated. This method has been deprecated. Use #getSuccinctID(String providerID, String providerRole )
static java.lang.String	getSuccintID(java.lang.String providerID, java.lang.String providerRole) Returns succinct ID of a provider.
static java.lang.String	getTerminationDonePageURL(java.lang.String providerID, javax.servlet.http.HttpServletRequest request) Deprecated. This method has been deprecated. Use getTerminationDonePageURL(String providerID, String providerRole, HttpServletRequest request)
static java.lang.String	getTerminationDonePageURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request) Returns the TerminationDonePageURL from the provider ID.
static java.lang.String	getTerminationProviderIDKey() Returns the termination providerIDKey from IFSConstants.
static java.lang.String	getTerminationURL(java.lang.String providerID, javax.servlet.http.HttpServletRequest request) Deprecated. This method has been deprecated. Use getTerminationURL(String providerID, String providerRole, HttpServletRequest request)
static java.lang.String	getTerminationURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request) Returns Termination URL.
static java.lang.String	getUser(javax.servlet.http.HttpServletRequest request) Returns the user from HttpServletRequest.
static boolean	isFederationCancelled(javax.servlet.http.HttpServletRequest request) Returns true if Federation is cancelled.
static boolean	isLECPProfile(javax.servlet.http.HttpServletRequest request) Determines if a HTTP servlet request is Liberty-enabled client and proxy profile.
static boolean	isLogoutSuccess(javax.servlet.http.HttpServletRequest request) Returns true if logout succeeded.
static boolean	isNameRegistrationCancelled(javax.servlet.http.HttpServletRequest request) Returns true if name registration is cancelled.
static boolean	isNameRegistrationSuccess(javax.servlet.http.HttpServletRequest request) Returns true if name registration succeeds.
static boolean	isTerminationCancelled(javax.servlet.http.HttpServletRequest request) Returns true if termination is cancelled.
static boolean	isTerminationSuccess(javax.servlet.http.HttpServletRequest request) Returns true if Termination succeeds.

Methods inherited from class java.lang.Object

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

Constructor Detail

LibertyManager

public LibertyManager()

Method Detail

getIDPList

public static java.util.Iterator getIDPList()

Returns a list of all trusted Identity Providers.

Returns:

an iterator to a list of strings, each containing the provider ID of Identity Providers.

getIDPList

public static java.util.Iterator getIDPList(java.lang.String hostedProviderID)

Returns a list of all trusted Identity Providers for a given hosted provider IDs.

Parameters:

hostedProviderID - hosted provider IDs.

Returns:

an iterator to a list of strings, each containing the provider ID of an trusted Identity Providers for this hosted provider ID.

getSPList

public static java.util.Iterator getSPList()

Returns a list of all trusted Service Providers

Returns:

an iterator to a list of strings, each containing the provider ID of an Service Provider.

getSPList

public static java.util.Iterator getSPList(java.lang.String hostedProviderID)

Returns a list of all trusted Service Providers for this Hosted Provider.

Parameters:

hostedProviderID - hosted provider IDs.

Returns:

an iterator to a list of strings, each containing the provider ID of an Service Provider for the given Hosted Provider.

getIDPFederationStatus

public static boolean getIDPFederationStatus(java.lang.String user,
                                             java.lang.String provider)

Gets the federation status of a user name with an Identity Provider. (This method assumes that the user is already federated with the provider)

Parameters:

user - The user name obtained by calling getUser() on a Liberty-authenticated HttpServletRequest from the user

provider - The provider ID of the Identity Provider.

Returns:

The federation status of a user with an Identity Provider.

getSPFederationStatus

public static boolean getSPFederationStatus(java.lang.String user,
                                            java.lang.String provider)

Gets the federations status of a user with an Service Provider (This method assumes that the user is already federated with the provider).

Parameters:

user - The user name obtained by calling getRemoteUser() on a Liberty-authenticated HttpServletRequest from the user.

provider - The provider ID of the Service Provider.

Returns:

The federation status of a user with an Service Provider.

getNonce

public static java.lang.String getNonce(java.lang.String user)

Deprecated. This method has been deprecated. Please use other means to generate nounce.

Gets a nonce for use in forms to be posted to well known servlets. Avoids cross site scripting type attacks.

Parameters:

user - The user name obtained by calling getRemoteUser() on a Liberty-authenticated HttpServletRequestfrom the user.

Returns:

A string to be put in a hidden form field called "nonce".

checkNonce

public static boolean checkNonce(java.lang.String nonce,
                                 java.lang.String user)

Deprecated. This method has been deprecated. Please use other means to verify nounce.

Checks that the given nonce is the same as the last one returned via getNonce(), and invalidates it.

Parameters:

nonce - String containing nonce.

user - User name passed to getNonce to obtain nonce.

Returns:

true is nonce is the same as the last one returned by getNonce method.

getIntroducedProvider

public static java.lang.String getIntroducedProvider(javax.servlet.http.HttpServletRequest request)

Gets the ID of the provider discovered via the introduction protocol. If null, no provider was discovered. Can be passed to LoginServlet if null.

Parameters:

request - HTTP servlet request.

Returns:

the provider ID

getMetaAliasKey

public static java.lang.String getMetaAliasKey()

Returns the metaAliasKey from IFSConstants.

Returns:

the metaAliasKey from IFSConstants.

getTerminationProviderIDKey

public static java.lang.String getTerminationProviderIDKey()

Returns the termination providerIDKey from IFSConstants.

Returns:

the termination providerIDKey from IFSConstants.

getRequestIDKey

public static java.lang.String getRequestIDKey()

Returns the requestIDKey from IFSConstants.

Returns:

the requestIDKey from IFSConstants.

getProviderIDKey

public static java.lang.String getProviderIDKey()

Returns the providerIDKey from IFSConstants.

Returns:

the providerIDKey from IFSConstants.

getLRURLKey

public static java.lang.String getLRURLKey()

Returns the LRURLKey from IFSConstants.

Returns:

the LRURLKey from IFSConstants.

getCOTKey

public static java.lang.String getCOTKey()

Returns the COT key from IFSConstants.

Returns:

the COT key from IFSConstants.

getSelectedProviderKey

public static java.lang.String getSelectedProviderKey()

Returns the selectedProviderKey from IFSConstants.

Returns:

the selectedProviderKey from IFSConstants.

getFedErrorKey

public static java.lang.String getFedErrorKey()

Returns Federation Error Key

Returns:

Federation Error Key

getFedRemarkKey

public static java.lang.String getFedRemarkKey()

Returns FederationRemark Key

Returns:

FederationRemark Key

getUser

public static java.lang.String getUser(javax.servlet.http.HttpServletRequest request)

Returns the user from HttpServletRequest.

Parameters:

request - HTTP servlet request.

Returns:

the user from HttpServletRequest.

getHomeURL

public static java.lang.String getHomeURL(java.lang.String providerID)

Deprecated. This method has been deprecated. Use getHomeURL(String providerID, String providerRole)

Returns Provider's HomePageURL.

Parameters:

providerID - Provider ID.

Returns:

Provider's HomePageURL.

getHomeURL

public static java.lang.String getHomeURL(java.lang.String providerID,
                                          java.lang.String providerRole)

Returns Provider's HomePageURL.

Parameters:

providerID - Provider ID.

providerRole - Provider Role.

Returns:

Provider's HomePageURL.

getPreLoginServletURL

public static java.lang.String getPreLoginServletURL(java.lang.String providerID,
                                                     javax.servlet.http.HttpServletRequest request)

Deprecated. This method has been deprecated. Use getPreLoginServletURL(String providerID, String providerRole, HttpServletRequest request)

Returns PreLoginServlet URL and appends metaAlias to it.

Parameters:

providerID - Provider ID.

request - HTTP servlet request.

Returns:

PreLoginServlet URL and appends metaAlias to it.

getPreLoginServletURL

public static java.lang.String getPreLoginServletURL(java.lang.String providerID,
                                                     java.lang.String providerRole,
                                                     javax.servlet.http.HttpServletRequest request)

Returns PreLoginServlet URL and appends metaAlias to it.

Parameters:

providerID - Provider ID.

request - HTTP servlet request.

Returns:

PreLoginServlet URL and appends metaAlias to it.

getLoginURL

public static java.lang.String getLoginURL(javax.servlet.http.HttpServletRequest request)

Returns the LoginURL from IFSConstants

Parameters:

request - HTTP servlet request.

Returns:

the LoginURL from IFSConstants

getInterSiteURL

public static java.lang.String getInterSiteURL(javax.servlet.http.HttpServletRequest request)

Returns the interSiteURL from IFSConstants.

Parameters:

request - HTTP servlet request.

Returns:

the interSiteURL from IFSConstants.

getProviderID

public static java.lang.String getProviderID(java.lang.String metaAlias)

Returns providerID from the ProviderAlias using AllianceMgmt calls.

Parameters:

metaAlias - The metaAlias of the provider

Returns:

providerID corresponding to the metaAlias.

getProvidersToFederate

public static java.util.Set getProvidersToFederate(java.lang.String providerID,
                                                   java.lang.String userName)

Returns the list of all Trusted Identity Providers of this user not already federated with. This is a subset of the Set returned by getIDPList(). This method is is used to show the drop-down menu consisting of all the Identity Providers that the user is not already federated with.

Parameters:

providerID - provider IDs.

userName - name of user.

Returns:

Set containing all the Identity Provider IDs which the user is not already federated with.

getFederatedProviders

public static java.util.Set getFederatedProviders(java.lang.String userName)

Returns the set of federated providers for this userName using Account Management API.

Parameters:

userName - for which the federated providers are to be returned.

Returns:

federated providers a Set containing the provider IDs of federated providers for the given userName.

getListOfCOTs

public static java.util.Set getListOfCOTs(java.lang.String providerId)

Deprecated. This method has been deprecated. Use getListOfCOTs(String providerID, String providerRole)

Returns the List of COTs for the given Provider.

Parameters:

providerId - The ID of the provider whose COTList is to be found

Returns:

The set containing the authentication domains for the given provider.

getListOfCOTs

public static java.util.Set getListOfCOTs(java.lang.String providerId,
                                          java.lang.String providerRole)

Returns the List of COTs for the given Provider.

Parameters:

providerId - The ID of the provider whose COTList is to be found

providerRole - The Role of the provider whose COTList is to be found

Returns:

The set containing the authentication domains for the given provider.

getMetaAlias

public static java.lang.String getMetaAlias(java.lang.String providerID)

Deprecated. This method has been deprecated. Use getMetaAlias(String providerID, String providerRole)

Returns metaAlias from provider ID

Parameters:

providerID - Provider ID.

Returns:

metaAlias from provider ID

getMetaAlias

public static java.lang.String getMetaAlias(java.lang.String providerID,
                                            java.lang.String providerRole)

Returns metaAlias from provider ID

Parameters:

providerID - Provider ID.

providerRole - Provider Role.

Returns:

metaAlias from provider ID

getFederationDonePageURL

public static java.lang.String getFederationDonePageURL(java.lang.String providerID,
                                                        javax.servlet.http.HttpServletRequest request)

Deprecated. This method has been deprecated. Use getFederationDonePageURL(String providerID, String providerRole, HttpServletRequest request)

Returns the FederationDonePageURL from the provider ID.

Parameters:

providerID - Provider ID.

request - HTTP servlet request.

Returns:

the FederationDonePageURL from the provider ID.

getFederationDonePageURL

public static java.lang.String getFederationDonePageURL(java.lang.String providerID,
                                                        java.lang.String providerRole,
                                                        javax.servlet.http.HttpServletRequest request)

Returns the FederationDonePageURL from the provider ID.

Parameters:

providerID - Provider ID.

providerRole - Provider Role.

request - HTTP servlet request.

Returns:

the FederationDonePageURL from the provider ID.

getTerminationDonePageURL

public static java.lang.String getTerminationDonePageURL(java.lang.String providerID,
                                                         javax.servlet.http.HttpServletRequest request)

Deprecated. This method has been deprecated. Use getTerminationDonePageURL(String providerID, String providerRole, HttpServletRequest request)

Returns the TerminationDonePageURL from the provider ID.

Parameters:

providerID - Provider ID.

request - HTTP servlet request.

Returns:

the TerminationDonePageURL from the provider ID.

getTerminationDonePageURL

public static java.lang.String getTerminationDonePageURL(java.lang.String providerID,
                                                         java.lang.String providerRole,
                                                         javax.servlet.http.HttpServletRequest request)

Returns the TerminationDonePageURL from the provider ID.

Parameters:

providerID - Provider ID.

providerRole - Provider Role.

request - HTTP servlet request.

Returns:

the TerminationDonePageURL from the provider ID.

getTerminationURL

public static java.lang.String getTerminationURL(java.lang.String providerID,
                                                 javax.servlet.http.HttpServletRequest request)

Deprecated. This method has been deprecated. Use getTerminationURL(String providerID, String providerRole, HttpServletRequest request)

Returns Termination URL.

Parameters:

providerID - Provider ID.

request - HTTP servlet request.

Returns:

Termination URL.

getTerminationURL

public static java.lang.String getTerminationURL(java.lang.String providerID,
                                                 java.lang.String providerRole,
                                                 javax.servlet.http.HttpServletRequest request)

Returns Termination URL.

Parameters:

providerID - Provider ID.

providerRole - Provider Role.

request - HTTP servlet request.

Returns:

Termination URL.

getNameRegistrationURL

public static java.lang.String getNameRegistrationURL(java.lang.String providerID,
                                                      javax.servlet.http.HttpServletRequest request)

Deprecated. This method has been deprecated. Use getNameRegistrationURL(String providerID, String providerRole, HttpServletRequest request)

Returns NameRegistrationURL.

Parameters:

providerID - Provider ID.

request - HTTP servlet request.

Returns:

NameRegistrationURL.

getNameRegistrationURL

public static java.lang.String getNameRegistrationURL(java.lang.String providerID,
                                                      java.lang.String providerRole,
                                                      javax.servlet.http.HttpServletRequest request)

Returns NameRegistrationURL.

Parameters:

providerID - Provider ID.

providerRole - Provider Role.

request - HTTP servlet request.

Returns:

NameRegistrationURL.

getErrorPageURL

public static java.lang.String getErrorPageURL(java.lang.String providerId,
                                               javax.servlet.http.HttpServletRequest request)

Deprecated. This method has been deprecated. Use getErrorPageURL(String providerID, String providerRole, HttpServletRequest request)

Returns the provider's error page.

Parameters:

providerId - Provider ID.

request - HTTP servlet request.

Returns:

the provider's error page.

getErrorPageURL

public static java.lang.String getErrorPageURL(java.lang.String providerId,
                                               java.lang.String providerRole,
                                               javax.servlet.http.HttpServletRequest request)

Returns the provider's error page.

Parameters:

providerId - Provider ID.

request - HTTP servlet request.

Returns:

the provider's error page.

getFederationHandlerURL

public static java.lang.String getFederationHandlerURL(javax.servlet.http.HttpServletRequest request)

Returns the FederationHandler.

Parameters:

request - HTTP servlet request

Returns:

the FederationHandler.

getConsentHandlerURL

public static java.lang.String getConsentHandlerURL(javax.servlet.http.HttpServletRequest request)

Returns the ConsentHandler.

Parameters:

request - HTTP servlet request.

Returns:

the ConsentHandler.

isLogoutSuccess

public static boolean isLogoutSuccess(javax.servlet.http.HttpServletRequest request)

Returns true if logout succeeded.

Parameters:

request - HTTP servlet request.

Returns:

true if logout succeeded.

isTerminationSuccess

public static boolean isTerminationSuccess(javax.servlet.http.HttpServletRequest request)

Returns true if Termination succeeds.

Parameters:

request - HTTP servlet request.

Returns:

true if Termination succeeds.

isFederationCancelled

public static boolean isFederationCancelled(javax.servlet.http.HttpServletRequest request)

Returns true if Federation is cancelled.

Parameters:

request - HTTP servlet request.

Returns:

true if Federation is cancelled.

isTerminationCancelled

public static boolean isTerminationCancelled(javax.servlet.http.HttpServletRequest request)

Returns true if termination is cancelled.

Parameters:

request - HTTP servlet request.

Returns:

true if termination is cancelled.

getNewRequest

public static java.lang.String getNewRequest(javax.servlet.http.HttpServletRequest request)

Creates New Request ID from the HttpRequestServlet.

Parameters:

request - HTTP servlet request.

Returns:

New Request ID from the HttpRequestServlet.

cleanQueryString

public static java.lang.String cleanQueryString(javax.servlet.http.HttpServletRequest request)

getSuccintID

public static java.lang.String getSuccintID(java.lang.String providerID)

Deprecated. This method has been deprecated. Use #getSuccinctID(String providerID, String providerRole )

Returns succinct ID of a provider.

Parameters:

providerID - provider ID.

Returns:

succinct ID of a provider.

getSuccintID

public static java.lang.String getSuccintID(java.lang.String providerID,
                                            java.lang.String providerRole)

Returns succinct ID of a provider.

Parameters:

providerID - provider ID.

providerRole - provider Role.

Returns:

succinct ID of a provider.

getRegisteredProviders

public static java.util.Set getRegisteredProviders(java.lang.String userName)

Returns registered providers of an user.

Parameters:

userName - user ID.

Returns:

registered providers.

getNameRegistrationProviderIDKey

public static java.lang.String getNameRegistrationProviderIDKey()

Returns name registration provider ID key.

Returns:

name registration provider ID key.

isNameRegistrationCancelled

public static boolean isNameRegistrationCancelled(javax.servlet.http.HttpServletRequest request)

Returns true if name registration is cancelled.

Parameters:

request - HTTP servlet request.

Returns:

true if name registration is cancelled.

isNameRegistrationSuccess

public static boolean isNameRegistrationSuccess(javax.servlet.http.HttpServletRequest request)

Returns true if name registration succeeds.

Parameters:

request - HTTP servlet request.

Returns:

true if name registration succeeds.

getNameRegistrationDonePageURL

public static java.lang.String getNameRegistrationDonePageURL(java.lang.String providerID,
                                                              javax.servlet.http.HttpServletRequest request)

Deprecated. This method has been deprecated. Use getNameRegistrationDonePageURL(String providerID, String providerRole, HttpServletRequest request)

Returns the Name RegistrationDonePageURL from the providerID.

Parameters:

providerID - provider ID.

request - HTTP servlet request.

Returns:

the Name RegistrationDonePageURL from the providerID.

getNameRegistrationDonePageURL

public static java.lang.String getNameRegistrationDonePageURL(java.lang.String providerID,
                                                              java.lang.String providerRole,
                                                              javax.servlet.http.HttpServletRequest request)

Returns the Name RegistrationDonePageURL from the providerID.

Parameters:

providerID - provider ID.

providerRole - provider Role.

request - HTTP servlet request.

Returns:

the Name RegistrationDonePageURL from the providerID.

getAuthnRequestEnvelope

public static java.lang.String getAuthnRequestEnvelope(javax.servlet.http.HttpServletRequest request)

Gets Authentication Request Envelope from a HTTP servlet request.

Parameters:

request - a HTTP servlet request

Returns:

Authentication Request Envelope in String

isLECPProfile

public static boolean isLECPProfile(javax.servlet.http.HttpServletRequest request)

Determines if a HTTP servlet request is Liberty-enabled client and proxy profile.

Parameters:

request - a HTTP servlet request

Returns:

true if it is Liberty-enabled client and proxy profile

getLECPHeaderName

public static java.lang.String getLECPHeaderName()

Gets Liberty-enabled client and proxy profile HTTP header name.

Returns:

header name

getLECPContentType

public static java.lang.String getLECPContentType()

Gets Liberty-enabled client and proxy profile HTTP content type

Returns:

content type

getDiscoveryBootStrapResourceOfferings

public static org.w3c.dom.NodeList getDiscoveryBootStrapResourceOfferings(javax.servlet.http.HttpServletRequest request,
                                                                          java.lang.String providerID)

Deprecated. This method has been deprecated. Use getDiscoveryBootStrapResourceOfferings( HttpServletRequest request, String providerID, String providerRole)

Gets the Discovery Service Resource Offerings nodes in an attribute statement. After a single sign-on with an Identity Provider, a service provider may get Discovery Service Resource Offerings through a SAML assertion. This APIs helps in retrieving the resource offerings if the user has been authenticated through the liberty SSO. It will need to have a valid single sign on token (generated through the liberty SSO).

Parameters:

request - HttpServletRequest associated with a user session.

providerID - Hosted Provider ID

Returns:

NodeList Discovery Resource Offering Nodes, null if there is any failure or if there is not one

getDiscoveryBootStrapResourceOfferings

public static org.w3c.dom.NodeList getDiscoveryBootStrapResourceOfferings(javax.servlet.http.HttpServletRequest request,
                                                                          java.lang.String providerID,
                                                                          java.lang.String providerRole)

Gets the Discovery Service Resource Offerings nodes in an attribute statement. After a single sign-on with an Identity Provider, a service provider may get Discovery Service Resource Offerings through a SAML assertion. This APIs helps in retrieving the resource offerings if the user has been authenticated through the liberty SSO. It will need to have a valid single sign on token (generated through the liberty SSO).

Parameters:

request - HttpServletRequest associated with a user session.

providerID - Hosted Provider ID

providerRole - Hosted Provider Role

Returns:

NodeList Discovery Resource Offering Nodes, null if there is any failure or if there is not one

getDiscoveryBootStrapCredentials

public static java.util.List getDiscoveryBootStrapCredentials(javax.servlet.http.HttpServletRequest request,
                                                              java.lang.String providerID)

Deprecated. This method has been deprecated. Use getDiscoveryBootStrapCredentials( HttpServletRequest request, String providerID, String providerRole)

Gets the Discovery Service Credentials in the Advice element. After a single sign-on with an Identity Provider, a service provider may get Discovery Service Resource Offerings and Credentials through a SAML assertion. This APIs helps in retrieving the Credentials if the user has been authenticated through the liberty SSO. It will need to have a valid single sign on token (generated through the liberty SSO).

Parameters:

request - HttpServletRequest associated with a user session.

providerID - Hosted Provider ID

Returns:

List of SecurityAssertions, null if there is any failure or if there is not one

getDiscoveryBootStrapCredentials

public static java.util.List getDiscoveryBootStrapCredentials(javax.servlet.http.HttpServletRequest request,
                                                              java.lang.String providerID,
                                                              java.lang.String providerRole)

Gets the Discovery Service Credentials in the Advice element. After a single sign-on with an Identity Provider, a service provider may get Discovery Service Resource Offerings and Credentials through a SAML assertion. This APIs helps in retrieving the Credentials if the user has been authenticated through the liberty SSO. It will need to have a valid single sign on token (generated through the liberty SSO).

Parameters:

request - HttpServletRequest associated with a user session.

providerID - Hosted Provider ID

providerRole - Hosted Provider Role

Returns:

List of SecurityAssertions, null if there is any failure or if there is not one

getProviderRole

public static java.lang.String getProviderRole(java.lang.String metaAlias)

Returns providerRole from the ProviderAlias using AllianceMgmt calls.

Parameters:

metaAlias - The metaAlias of the provider

Returns:

providerRole corresponding to the metaAlias.

getMappedNameIdentifier

public static NameIdentifier getMappedNameIdentifier(java.lang.String hostedSPMetaAlias,
                                                     SSOToken ssoToken,
                                                     java.lang.String remoteSPEntityID)

Returns NameIdentifier between the IDP and the other SP for the same principal. This method should be used by the code on the hosted SP, where the user has logged in, and has an account linking with the IDP. Futhermore, the same principal has an account linking between his/her other (remote) SP account and the IDP account.

Parameters:

hostedSPMetaAlias - The metaAlias of the local service provider.

ssoToken - The SSOToken of the logged- in user on the local service provider.

remoteSPEntityID - The entity ID of the remote service provider. In other words, it is the targeted name space for the returned name identifier.

Returns:

NameIdentifier of the same principal but original established between the remote SP and the IDP