Sun Java System Access Manager 7.1 Federation and SAML Administration Guide

Federation API

The following packages form the Federation API.

`com.sun.identity.federation.plugins`

The com.sun.identity.federation.plugins package contains the FederationSPAdapter interface which can be implemented to allow applications to customize their actions before and after invoking the federation protocols. For example, a service provider may want to choose to redirect to a specific location after single sign-on. For more detailed information, see the Java API Reference in /AccessManager-base/SUNWam/docs or on Sun Java System Access Manager 7.1 Java API Reference.

`com.sun.identity.federation.services`

The com.sun.identity.federation.services package provides interfaces for writing custom plug-ins that can be used during the federation or single sign-on process. The interfaces are described in the following table. For more detailed information, see the Java API Reference in /AccessManager-base/SUNWam/docs or on Sun Java System Access Manager 7.1 Java API Reference.

Table 3–2 com.sun.identity.federation.services Interfaces


Interface	Description
`FSAttributeMapper`	Plug-in for mapping the attributes passed from the identity provider to local attributes on the service provider side during the single sign-on.
`FSAttributePlugin`	Plug-in for an identity provider to add `AttributeStatements` into a SAML assertion during the single sign-on process.
`FSIDPProxy`	Interface used to find a preferred identity provider to which an authentication request can be proxied.

`com.sun.liberty`

The com.sun.liberty package contains the LibertyManager class which must be instantiated by web applications that want to access the Federation component. It also contains the methods needed for account federation, session termination, log in, log out and other actions. Some of these methods are described in the following table. For more detailed information, see the Java API Reference in /AccessManager-base/SUNWam/docs or on Sun Java System Access Manager 7.1 Java API Reference.

Table 3–3 com.sun.liberty Methods


Method	Description
`getFederatedProviders(String userName)`	Returns a specific user’s federated providers.
`getIDPFederationStatus(String user, String provider)`	Retrieves a user’s federation status with a specified identity provider. This method assumes that the user is already federated with the provider.
`getIDPList()`	Returns a list of all trusted identity providers.
`getIDPList(java.lang.String hostedProviderID)`	Returns a list of all trusted identity providers for the specified hosted provider.
`getProvidersToFederate(java.lang.String providerID, java.lang.String userName)`	Returns a list of all trusted identity providers to which the specified user is not already federated.
`getSPList()`	Returns a list of all trusted service providers.
`getSPList(java.lang.String hostedProviderID)`	Returns a list of all trusted service providers for the specified hosted provider.
`getSPFederationStatus(java.lang.String user, java.lang.String provider)`	Retrieves a user’s federation status with a specified service provider. This method assumes that the user is already federated with the provider.