|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.liberty.LibertyManager
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 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,
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,
java.lang.String providerRole)
Gets the Discovery Service Resource Offerings nodes in an attribute statement. |
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,
java.lang.String hostProviderId,
java.lang.String hostProviderRole)
Returns the set of federated providers for this userName
using Account Management API. |
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,
java.lang.String providerRole)
Returns Provider's HomePageURL . |
static boolean |
getIDPFederationStatus(java.lang.String user,
java.lang.String remoteProviderId,
java.lang.String hostedProviderId,
java.lang.String hostedProviderRole)
Gets the federation status of a user name with an Identity Provider. |
static java.util.Set |
getIDPList()
Returns the set of all active Identity Providers. |
static java.util.Set |
getIDPList(java.lang.String hostedProviderID)
Returns a set of all trusted Identity Providers for a given hosted SP provider. |
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,
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,
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,
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,
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 |
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 providerRole,
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,
java.lang.String hostProviderId,
java.lang.String providerRole)
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 remoteProviderId,
java.lang.String hostedProviderId,
java.lang.String hostedProviderRole)
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.Set |
getSPList()
Returns a list of all active Service Providers |
static java.util.Set |
getSPList(java.lang.String hostedProviderID)
Returns a list of all trusted Service Providers for this Hosted IDP Provider. |
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,
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,
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. |
static FSAuthnRequest |
newAuthnRequest(javax.servlet.http.HttpServletRequest request,
java.lang.String hostedProviderID)
creates new authentication request, this method can only be used inside the same FM web application. |
static void |
sendAuthnRequest(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
FSAuthnRequest authnRequest,
java.lang.String remoteIDPProviderID)
sends the authentication request to the IDP, user will be redirected to the single-sign-on URL on the IDP side. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public LibertyManager()
Method Detail |
public static java.util.Set getIDPList()
public static java.util.Set getIDPList(java.lang.String hostedProviderID)
hostedProviderID
- hosted provider ID.
public static java.util.Set getSPList()
public static java.util.Set getSPList(java.lang.String hostedProviderID)
hostedProviderID
- hosted provider IDs.
public static boolean getIDPFederationStatus(java.lang.String user, java.lang.String remoteProviderId, java.lang.String hostedProviderId, java.lang.String hostedProviderRole)
user
- The user name obtained by calling getUser()
on a
Liberty-authenticated HttpServletRequest
from the userremoteProviderId
- Provider ID of the Remote Identity Provider.hostedProviderId
- Hosted Provider ID.hostedProviderRole
- Hosted Provider Role.
public static boolean getSPFederationStatus(java.lang.String user, java.lang.String remoteProviderId, java.lang.String hostedProviderId, java.lang.String hostedProviderRole)
user
- The user name obtained by calling
getRemoteUser()
on a Liberty-authenticated
HttpServletRequest
from the user.remoteProviderId
- The provider ID of the Remote Service Provider.hostedProviderId
- Hosted provider ID.hostedProviderRole
- Hosted Provider Role.
public static java.lang.String getIntroducedProvider(javax.servlet.http.HttpServletRequest request)
LoginServlet
if null.
request
- HTTP servlet request.
public static java.lang.String getMetaAliasKey()
metaAliasKey
from IFSConstants
.
metaAliasKey
from IFSConstants
.public static java.lang.String getTerminationProviderIDKey()
providerIDKey
from
IFSConstants
.
providerIDKey
from
IFSConstants
.public static java.lang.String getRequestIDKey()
requestIDKey
from IFSConstants
.
requestIDKey
from IFSConstants
.public static java.lang.String getProviderIDKey()
providerIDKey
from IFSConstants
.
providerIDKey
from IFSConstants
.public static java.lang.String getLRURLKey()
LRURLKey
from IFSConstants
.
LRURLKey
from IFSConstants
.public static java.lang.String getCOTKey()
COT
key from IFSConstants
.
COT
key from IFSConstants
.public static java.lang.String getSelectedProviderKey()
selectedProviderKey
from
IFSConstants
.
selectedProviderKey
from
IFSConstants
.public static java.lang.String getFedErrorKey()
public static java.lang.String getFedRemarkKey()
FederationRemark
Key
FederationRemark
Keypublic static java.lang.String getUser(javax.servlet.http.HttpServletRequest request)
HttpServletRequest
.
request
- HTTP servlet request.
HttpServletRequest
.public static java.lang.String getHomeURL(java.lang.String providerID, java.lang.String providerRole)
HomePageURL
.
providerID
- Provider ID.providerRole
- Provider Role.
HomePageURL
.public static java.lang.String getPreLoginServletURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request)
PreLoginServlet
URL and appends
metaAlias
to it.
providerID
- Provider ID.providerRole
- Provider Role.request
- HTTP servlet request.
PreLoginServlet
URL and appends
metaAlias
to it.public static java.lang.String getLoginURL(javax.servlet.http.HttpServletRequest request)
LoginURL
from IFSConstants
request
- HTTP servlet request.
LoginURL
from IFSConstants
public static java.lang.String getInterSiteURL(javax.servlet.http.HttpServletRequest request)
interSiteURL
from IFSConstants
.
request
- HTTP servlet request.
interSiteURL
from IFSConstants
.public static java.lang.String getProviderID(java.lang.String metaAlias)
providerID
from the ProviderAlias
using AllianceMgmt
calls.
metaAlias
- The metaAlias
of the provider
providerID
corresponding to the metaAlias
.public static java.lang.String getProviderRole(java.lang.String metaAlias)
providerRole
from the ProviderAlias
using AllianceMgmt
calls.
metaAlias
- The metaAlias
of the provider
providerRole
corresponding to the
metaAlias
.public static NameIdentifier getMappedNameIdentifier(java.lang.String hostedSPMetaAlias, SSOToken ssoToken, java.lang.String remoteSPEntityID)
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.
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.
NameIdentifier
of the same principal
but original established between the remote SP and
the IDPpublic static java.util.Set getProvidersToFederate(java.lang.String providerID, java.lang.String providerRole, java.lang.String userName)
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.
providerID
- provider IDs.userName
- name of user.providerRole
- provider Role.
public static java.util.Set getFederatedProviders(java.lang.String userName, java.lang.String hostProviderId, java.lang.String hostProviderRole)
userName
using Account Management API.
userName
- for which the federated providers are to be returned.hostProviderId
- Hosted provider ID.hostProviderRole
- Hosted Provider Role.
userName
.public static java.util.Set getListOfCOTs(java.lang.String providerId, java.lang.String providerRole)
providerId
- The ID of the provider whose COTList
is to be foundproviderRole
- Provider Role.
public static java.lang.String getMetaAlias(java.lang.String providerID, java.lang.String providerRole)
metaAlias
from provider ID
providerID
- Provider ID.providerRole
- Provider Role.
metaAlias
from provider IDpublic static java.lang.String getFederationDonePageURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request)
FederationDonePageURL
from the provider ID.
providerID
- Provider ID.providerRole
- Provider Role.request
- HTTP servlet request.
FederationDonePageURL
from the provider ID.public static java.lang.String getTerminationDonePageURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request)
TerminationDonePageURL
from the provider ID.
providerID
- Provider ID.providerRole
- Provider Role.request
- HTTP servlet request.
TerminationDonePageURL
from the provider ID.public static java.lang.String getTerminationURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request)
providerID
- Provider ID.providerRole
- Provider Role.request
- HTTP servlet request.
public static java.lang.String getNameRegistrationURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request)
NameRegistrationURL
.
providerID
- Provider ID.providerRole
- Provider Role.request
- HTTP servlet request.
NameRegistrationURL
.public static java.lang.String getErrorPageURL(java.lang.String providerId, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request)
providerId
- Provider ID.providerRole
- Provider Role.request
- HTTP servlet request.
public static java.lang.String getFederationHandlerURL(javax.servlet.http.HttpServletRequest request)
FederationHandler
.
request
- HTTP servlet request
FederationHandler
.public static java.lang.String getConsentHandlerURL(javax.servlet.http.HttpServletRequest request)
ConsentHandler
.
request
- HTTP servlet request.
ConsentHandler
.public static boolean isLogoutSuccess(javax.servlet.http.HttpServletRequest request)
request
- HTTP servlet request.
public static boolean isTerminationSuccess(javax.servlet.http.HttpServletRequest request)
request
- HTTP servlet request.
public static boolean isFederationCancelled(javax.servlet.http.HttpServletRequest request)
request
- HTTP servlet request.
public static boolean isTerminationCancelled(javax.servlet.http.HttpServletRequest request)
request
- HTTP servlet request.
public static java.lang.String getNewRequest(javax.servlet.http.HttpServletRequest request)
HttpRequestServlet
.
request
- HTTP servlet request.
HttpRequestServlet
.public static FSAuthnRequest newAuthnRequest(javax.servlet.http.HttpServletRequest request, java.lang.String hostedProviderID)
request
- Http Servlet requesthostedProviderID
- provider ID for this hosted SP
public static void sendAuthnRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSAuthnRequest authnRequest, java.lang.String remoteIDPProviderID) throws FederationException
request
- HttpServletRequestresponse
- HttpServletResponseauthnRequest
- authentication request, this one must be created
using LibertyManager.newAuthnRequest() methodremoteIDPProviderID
- provider ID for the remote IDP
FederationException
- if failed to send the authnRequestpublic static java.lang.String cleanQueryString(javax.servlet.http.HttpServletRequest request)
public static java.lang.String getSuccintID(java.lang.String providerID, java.lang.String providerRole)
providerID
- provider ID.providerRole
- provider role.
public static java.util.Set getRegisteredProviders(java.lang.String userName, java.lang.String hostProviderId, java.lang.String providerRole)
userName
- user ID.hostProviderId
- Hosted provider ID.providerRole
- Hosted Provider Role.
public static java.lang.String getNameRegistrationProviderIDKey()
public static boolean isNameRegistrationCancelled(javax.servlet.http.HttpServletRequest request)
request
- HTTP servlet request.
public static boolean isNameRegistrationSuccess(javax.servlet.http.HttpServletRequest request)
request
- HTTP servlet request.
public static java.lang.String getNameRegistrationDonePageURL(java.lang.String providerID, java.lang.String providerRole, javax.servlet.http.HttpServletRequest request)
RegistrationDonePageURL
from the
providerID
.
providerID
- provider ID.providerRole
- Provider Role.request
- HTTP servlet request.
RegistrationDonePageURL
from the
providerID
.public static java.lang.String getAuthnRequestEnvelope(javax.servlet.http.HttpServletRequest request)
request
- a HTTP servlet request
public static boolean isLECPProfile(javax.servlet.http.HttpServletRequest request)
request
- a HTTP servlet request
public static java.lang.String getLECPHeaderName()
public static java.lang.String getLECPContentType()
public static org.w3c.dom.NodeList getDiscoveryBootStrapResourceOfferings(javax.servlet.http.HttpServletRequest request, java.lang.String providerID, java.lang.String providerRole)
request
- HttpServletRequest
associated with a user
session.providerID
- Hosted Provider IDproviderRole
- Hosted Provider Role
NodeList
Discovery Resource Offering Nodes,
null if there is any failure or if there is not onepublic static java.util.List getDiscoveryBootStrapCredentials(javax.servlet.http.HttpServletRequest request, java.lang.String providerID, java.lang.String providerRole)
request
- HttpServletRequest
associated with a user
session.providerID
- Hosted Provider IDproviderRole
- Hosted Provider Role
List
of SecurityAssertions
,
null if there is any failure or if there is not one
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |