Sun OpenSSO Enterprise 8.0 Developer's Guide

Using the SAML v2 SDK

The SAML v2 framework provides interfaces that can be used to construct and process assertions, requests, and responses. The SDK is designed to be pluggable although it can also be run as a standalone application (outside of an instance of OpenSSO Enterprise).

Exploring the SAML v2 Packages

The SAML v2 SDK includes the following packages:

For more detailed information, see the Sun OpenSSO Enterprise 8.0 Java API Reference.

com.sun.identity.saml2.assertion Package

This package provides interfaces to construct and process SAML v2 assertions. It also contains the AssertionFactory, a factory class used to obtain instances of the objects defined in the assertion schema.

com.sun.identity.saml2.common Package

This package provides interfaces and classes used to define common SAML v2 utilities and constants.

com.sun.identity.saml2.plugins Package

This package provides service provider interfaces to implement for plug-ins.

com.sun.identity.saml2.protocol Package

This package provides interfaces used to construct and process the SAML v2 request/response protocol. It also contains the ProtocolFactory, a factory class used to obtain object instances for concrete elements in the protocol schema.

Setting a Customized Class

There are two ways you can set a customized implementation class:

  1. Add a customized mapper as a value for the Advanced Properties of the appropriate server using the OpenSSO Enterprise console.

    1. Login to the OpenSSO Enterprise console as the administrator.

    2. Click the Configuration tab.

    3. Click Servers & Sites and select the server.

    4. Click the Advanced tab.

    5. Click Add and enter the full interface name as the Property Name and the implemented class name as the Property Value.

      For example, com.sun.identity.saml2.sdk.mapping.Assertion and com.ourcompany.saml2.AssertionImpl, respectively.

  2. Set an environment variable for the Virtual Machine for the Java™ platform (JVM™). For example, you can add the following environment variable when starting the application: