Previous Topic: Sample Web Service Client API Java ApplicationNext Topic: Implement the Java XML Agent Content Helper API


Using the Java XML Agent Content Helper API

This section contains the following topics:

XML Agent Content Help API Overview

Interfaces and Classes in the Java XML Agent Content Helper API

Implement the Java XML Agent Content Helper API

Java XML-Enabled Agent Functional Flow

XML Agent Content Help API Overview

The XML Agent Content Helper API for Java supplements the CA SiteMinder Agent API for Java. A custom agent that is built using these two APIs can protect any URL-bound application (such as a Web service), performing the following functions on XML messages posted to that application:

To build custom XML-enabled agents you need to intersperse functions from the two APIs to provide the necessary functionality.

Interfaces and Classes in the Java XML Agent Content Helper API

This section provides brief information about the classes in the Java XML Agent API. Reference information on all the classes and methods can be found in the Javadoc.

The primary point of access to the Java Agent API is the IContentHelper interface, implemented by ContentHelperService and contained in the package com.netegrity.tm.contenthelper.api.

The following table lists all the classes and interfaces in the XML Agent Content Helper API.

Interface/Class

Description

IContentHelper

Provides the primary methods for XML-enabling custom agents

IContentHelperReturnCodes

Provides possible return codes for methods in implementing XML Agent Content Helper API classes.

ContentHelperService

The boot strap for the XML Agent Content Helper API system. Use it to generate instances of the IContentHelper interface.

ServerVariablesResolver

Provides methods for setting and resolving XML Agent variables (which provide information about the web server whose resources the XML-enabled agent is protecting) during authorization.

AgentKeys

Container class for CA SiteMinder agent keys (returned by the CA SiteMinder Agent API doManagement() method).

AgentApiService

Provides the XML Agent Content Helper API’s connection to the Policy Server.