com.netegrity.policyserver.smapi
Class APIContext

java.lang.Object
  com.netegrity.policyserver.smapi.APIContext

Direct Known Subclasses:

APIContextLogger

public class APIContext
extends java.lang.Object

Allows logging, tracing, and error messages to be sent to the Policy Server. Also provides access to the applicable SiteMinder API version number and to the context object AppSpecificContext.

Since:

SDK 6.0

Field Summary

static int	SM_API_VERSION_V3 Siteminder API version 3.
static int	SM_API_VERSION_V4 Siteminder API version 4.
static int	SM_API_VERSION_V4_1 Siteminder API version 4.1.

Method Summary

void	error(java.lang.String msg) Sends an error message to the Policy Server authorization log.
AppSpecificContext	getAppSpecificContext() Retrieves the AppSpecificContext for this APIContext.
java.util.Map	getAttrMap() Returns a Map of additional parameters that were passed to the Single Sign On Service for SAML 2.0 or WS-Federation.
int	getVersion() Retrieves the SiteMinder API version number.
void	log(java.lang.String msg) Sends a log message to the Policy Server authorization log.
void	trace(java.lang.String checkpoint, java.lang.String msg) Sends a trace message to the Policy Server authorization log.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SM_API_VERSION_V3

public static final int SM_API_VERSION_V3

Siteminder API version 3.

See Also:

Constant Field Values

SM_API_VERSION_V4

public static final int SM_API_VERSION_V4

Siteminder API version 4.

See Also:

Constant Field Values

SM_API_VERSION_V4_1

public static final int SM_API_VERSION_V4_1

Siteminder API version 4.1.

See Also:

Constant Field Values

Method Detail

getVersion

public int getVersion()

Retrieves the SiteMinder API version number.

Returns:

The SiteMinder API version number.

log

public void log(java.lang.String msg)

Sends a log message to the Policy Server authorization log. The SiteMinder logging facility must be enabled.

Parameters:

msg - The log message.

trace

public void trace(java.lang.String checkpoint,
                  java.lang.String msg)

Sends a trace message to the Policy Server authorization log. The SiteMinder tracing facility must be enabled.

Parameters:

checkpoint - The checkpoint for this trace (usually a module or library).

msg - The trace message.

error

public void error(java.lang.String msg)

Sends an error message to the Policy Server authorization log. The SiteMinder logging facility must be enabled.

Parameters:

msg - The error message.

getAttrMap

public java.util.Map getAttrMap()

Returns a Map of additional parameters that were passed to the Single Sign On Service for SAML 2.0 or WS-Federation. The Map excludes SiteMinder and SAML specific parameters such as Protocol Binding and SAML Request.

Returns:

Map of additional parameters.

getAppSpecificContext

public AppSpecificContext getAppSpecificContext()

Retrieves the AppSpecificContext for this APIContext.

Returns:

The AppSpecificContext.