Programming Guides › Programming Guide for Java › Java API Overview

Java API Overview

This section contains the following topics:

Purpose of the Java APIs

Installation Path

Code Samples

Policy Server Prerequisite

Java Components of the SiteMinder SDK

Java Agent API

Policy Management API

Authentication API

Authorization API

Delegated Management Services API

Utilities Package

How Java Components Fit Together

Network Architecture

Java API Flow

Log Trace Information

Javadoc Reference

Support for Custom Code

Purpose of the Java APIs

The SiteMinder SDK provides Java APIs for performing the following tasks:

• Creating SiteMinder Agents
• Creating Policy Management applications
• Creating Delegated Management Services (DMS) applications

Installation Path

The Java APIs, documentation, and samples are installed to the following location:

• UNIX platforms: <install_path>/sdk
• Windows platforms: <install_path>\sdk

<install_path> refers to the installation path where you installed the SDK software.

Code Samples

The SiteMinder SDK includes tested samples of SiteMinder client applications. The source files for these samples are located as follows:

• UNIX platforms:

  <install_path>/sdk/samples/<api-name>

• Windows platforms:

  <install_path>\sdk\samples\<api-name>

Notes on the Java samples:

• The samples use properties defined in smjsdksample.properties, located in /sdk/properties. Before you run the Java samples, modify this file with settings for your environment.
• The smjsdksample.properties file also externalizes literal strings used for logging.
• The samples smjavaagentapi and javadmsapi use the policy store created by the sample javapolicyapi. Run smjavapolicyapi before running smjavaagentapi or javadmsapi.
• All the samples use the same logging options and output format.
• When executing the Java samples on a 64-bit UNIX operating environment, note the following:
  • Use a 64-bit JVM. Running the 64-bit samples using a 32-bit JVM is not supported.
  • If you are using the file java-run.sh (in the samples/smjavaagentapi folder) remove the comment indicator before the -d64 flag. Leave this flag commented out when on a 32-bit operating environment.

Policy Server Prerequisite

You must have the SiteMinder Policy Server to run the applications and Policy Server plug-ins that you develop with the SiteMinder SDK.However, in most cases, you do not use the Policy Server to build those applications and plug-ins. The application runtime files can either be local or remote to the Policy Server.

Java Components of the SiteMinder SDK

The Java components of the SiteMinder SDK are listed in the following table: