com.netegrity.policyserver.smapi
Interface AssertionGeneratorCacheObject

All Known Subinterfaces:

AssertionGeneratorPlugin

public interface AssertionGeneratorCacheObject

This class is for internal use only. This interface is used to support the framework's cache mechanism.

Since:

SDK 6.0 SP3

Method Summary

boolean	init(APIContext context) Performs any initialization procedures that the custom object requires.
boolean	release(APIContext context) Performs any rundown procedures that the custom object requires.

Method Detail

init

boolean init(APIContext context)
             throws java.lang.Exception

Performs any initialization procedures that the custom object requires.

The SiteMinder SAML Assertion Generator Framework calls this method once per instance of an AssertionGeneratorPlugin class, when the object is loaded.

SiteMinder maintains a cache for all the plug-ins. Only one instance of a plug-in will exist per Policy Server, and each plug-in is intialized only once.

Parameters:

context - An APIContext object that provides methods for sending log, trace, and error messages to the Policy Server.

Returns:

true if initialization succeeded, or false if an error occurred.

Throws:

java.lang.Exception - Throws an exception if anything happens unexpectedly. If so, it is treated as if an error occurred.

release

boolean release(APIContext context)
                throws java.lang.Exception

Performs any rundown procedures that the custom object requires.

The SiteMinder SAML Assertion Generator Framework calls this method once per instance of an AssertionGeneratorPlugin class, when the object unloaded or when SiteMinder is shutting down.

SiteMinder maintains a cache for all the plug-ins. Only one instance of a plug-in will exist per Policy Server, and each plug-in is released only once.

Parameters:

context - An APIContext object that provides methods for sending log, trace, and error messages to the Policy Server.

Returns:

true if shutdown succeeded, or false if an error occurred.

Throws:

java.lang.Exception - Throws an exception if anything happens unexpectedly. If so, it is treated as if an error occurred.