Programming Guides › CA SiteMinder® Web Services Security Programming Guide for Java › Using the Java XML Agent Content Helper API › Implement the Java XML Agent Content Helper API

Implement the Java XML Agent Content Helper API

Note: For a list of operating systems, Java environments, and platforms that the XML Agent Content Helper API for Java supports, see the CA SiteMinder® Web Services Security Platform Matrix on the Technical Support site at http://ca.com/support.

Code an XML-Enabled Java Agent

To write the source code for a custom XML-enabled agent using the XML Agent Content Helper API for Java

1. Review the required software as listed in the accompanying release notes.
2. Review the sample code.
3. Write source code for your client application.

More information:

SDK Samples

Java XML-Enabled Agent Functional Flow

Before You Compile an XML-Enabled Agent

Before you compile your agent application, ensure the following:

• Your system can find the JNI support library when the Java Virtual Machine (JVM) is invoked, as follows:
  • On Windows: Change PATH to include the following, so that smjavaagentapi.dll can be found:

    install_path\sdk\bin\win32

  • On Solaris: Change LD_LIBRARY_PATH to include the following, so that libsmjavaagentapi.so can be found:

    install_path/sdk/bin/solaris

  • On AIX: Change LIBPATH to include the following, so that libsmjavaagentapi.so can be found:

    install_path/sdk/bin/aix

  • On Linux: Change LD_LIBRARY_PATH to include the following, so that libsmjavaagentapi.so can be found:

    install_path/sdk/bin/Linux

    Note: Java agents on Linux require Java SDK v 1.3.1.

  • On HP-UX 11: Change SHLIB_PATH to include the following, so that libsmjavaagentapi.so can be found:

    install_path/sdk/bin/hpux/hpux11

    Note: The Java Agent API is not available for HP10.

• The CA SiteMinder Agent API JAR file (smjavaagentapi.jar) is available by adding it to your CLASSPATH setting. When compiling, you can use the -classpath switch. smjavaagentapi.jar, is stored in the following locations:
  • Windows platforms:

    install_path\sdk\java

  • UNIX platforms:

    install_path/sdk/java

• The XML Agent Content Helper API JAR file is available whenever you compile or run an agent that uses the Java Agent API. The JAR file, soasmapi.jar, is stored in the following locations:
  • Windows platforms:

    Agent_install_location\Java

  • UNIX platforms:

    Agent_install_location\Java

  Add soasmapi.jar to your CLASSPATH setting. When compiling, you can use the -classpath switch.

Compile an XML-Enabled Java Agent

Compile the custom XML-enabled agent application using javac.

For an example, see java-build.bat or java-build.sh in the sample directory smjavaagentapi.

Deploy an XML-Enabled Java Agent

To deploy a custom XML-enabled Java Agent:

1. Do one of the following:
   • Install a Web Agent on systems where the custom XML-enabled agent will run.
   • Copy the following files from a system on which a Web Agent is installed into the same location on the system where the custom agent will run:

     On Windows

     Agent_inst_dir\Java\soasmapi.jar

     Agent_inst_dir\Java\smjavaagentapi.jar

     Agent_inst_dir\Java\XmlSdkConfig.properties

     Agent_inst_dir\Java\JSAMLAssertionStrings.properties

     Agent_inst_dir\Java\thirdparty\*

     Agent_inst_dir\Bin\smjavaagent.dll

     Agent_inst_dir\Bin\smreghost.exe

     On UNIX

     Agent_inst_dir/Java/soasmapi.jar

     Agent_inst_dir/Java/smjavaagentapi.jar

     Agent_inst_dir/Java/XmlSdkConfig.properties

     Agent_inst_dir/Java/JSAMLAssertionStrings.properties

     Agent_inst_dir/Java/thirdparty/*

     Agent_inst_dir/Bin/smjavaagent.so

     Agent_inst_dir/Bin/smreghost

   Agent_inst_dir

   Is the installed location of a Web Agent (for example, C:\Program Files\CA\SOA Security Manager\webagent).

2. Copy your custom agent JAR file to Agent_inst_dir\bin.
3. Set the NETE_TXM_ROOT environment variable to specify the path to Agent_inst_dir\bin, the directory in which you placed your custom agent JAR file.
4. Configure the Policy Server to use the custom XML-enabled agent application.

   Note: For detailed information about configuring agents, see the Web Agent Configuration Guide.

5. Run the custom XML-enabled agent Application.

   For an example, see java-run.bat or java-run.sh in the sample directory smjavaagentapi.