Package com.netegrity.policyserver.smapi

Contains the Java Authentication API and the Java Authorization API, plus classes common to both APIs.

See:
Description

Interface Summary

ActiveExpression	The base interface in the Java Authorization API that each class providing custom authorization functionality must implement.
AssertionGeneratorCacheObject	This class is for internal use only.
AssertionGeneratorPlugin	The base interface for objects that customize the default SAML assertion or SAML response generated by SiteMinder.
MessageConsumerPlugin	The base interface for providing Message Consumer Extension functionality.
SmApiNty	This interface is for internal use only.
SmAuthScheme	The base interface in the Java Authentication API that each custom authentication scheme class must implement.
TunnelService	This interface is for internal use only.

Class Summary

ActiveExpressionContext	Contains the various context classes passed to the method invoke() in the custom authorization class.
AffiliatePropertyContext	This class is for internal use only.
APIContext	Allows logging, tracing, and error messages to be sent to the Policy Server.
APIContextLogger	This class is a wrapper for the SmLogger class from common/smerrlog-java, which provides logging and tracing access to the common C++ logging facility.
AppSpecificContext	Provides methods that allow custom authentication and authorization objects to share information associated with the current request.
AuditLoggingAssertionData
FedNIDContext	The FedNIDContext class facilitates manipulation of Name Identifiers through the Name Identifier API (NID API).
RequestContext	Provides information about the user's access request-- for example, the server or resource portion of the request.
SAMLConfig	The SAMLConfig class facilitates getting Service Provider and Identity Provider properties through Policy Server native implementation.
SamlDataContext	This class is for internal use only.
SessionInfoContext	This class is for internal use only.
SessionVariableContext	This class is for internal use only.
SmAPIContextLogger	This class is a wrapper for the SmLogger class from common/smerrlog-java, which provides logging and tracing access to the common C++ logging facility.
SMAPIFactory	This class is for internal use only.
SmAuthenticationContext	Contains the various context classes passed to the method authenticate() in the custom authentication scheme class, and provides set... methods that let the authentication scheme pass status and error messages to SiteMinder.
SmAuthenticationResult	Contains reason codes and status codes returned from the method authenticate() in the custom authentication scheme class.
SmAuthQueryCode	Contains the type of request that SiteMinder is making of the authentication scheme (version number and description, or information about the credentials that SiteMinder must collect).
SmAuthQueryResponse	Contains constants that specify the kind of credentials, if any, that are required for authentication.
SmAuthStatus	Contains Authentication API status codes such as SMAUTH_ACCEPT and SMAUTH_REJECT.
SmSessionServer	This class implements the Java Session Server API.
TransactionIdContext	This class is for internal use only.
TunnelContext	This class is for internal use only.
TunnelServiceContext	This class is for internal use only.
UserContext	Allows a custom object to set and retrieve information about a user in a user directory.
UserCredentialsContext	Contains credentials information and other information from the user directory where user context was established.
WSFedAffiliatePropertyContext
WSFEDConfig	The WSFEDConfig class facilitates getting Resource Partner and Account Partner properties through Policy Server native implementation.

Exception Summary

SmJavaApiException	Exception thrown by SiteMinder Java API.
UserAuthenticationException	This class is for internal use only.

Error Summary

NativeCallbackError

This class is for internal use only.

Package com.netegrity.policyserver.smapi Description

Contains the Java Authentication API and the Java Authorization API, plus classes common to both APIs.

The base interface you must implement in each API is as follows:

• Implement SmAuthScheme when you are creating a class for a custom authentication scheme.
  
  
• Implement ActiveExpression when you are creating a class for custom authorization functionality.

This package also contains the base interface AssertionGeneratorPlugin. Objects that customize the default SAML assertions generated by SiteMinder must implement this interface.