Package com.netegrity.sdk.policyapi

Contains classes to create and manage policy objects within a SiteMinder installation.

See:
Description

Interface Summary

SmDomainObject	The root interface for domain-based SiteMinder objects.
SmGroup	The root interface for domain-based SiteMinder group objects.
SmObject	SmObject is the root of the Policy API interfaces.
SmPolicyApi	Provides methods for creating and managing SiteMinder policy store objects.

Class Summary

SmAdmin	Represents a SiteMinder Administrator object.
SmAgent	Represents a SiteMinder Agent object.
SmAgentConfig	Represents a SiteMinder Agent Configuration object.
SmAgentGroup	Represents a SiteMinder Agent group object.
SmAgentType	Represents a SiteMinder Agent type.
SmAgentTypeAttr	Represents a SiteMinder Agent Type Attribute.
SmAuthAzMap	Represents a SiteMinder authentication and authorization directory mapping object.
SmAuthValidateMap	Represents a SiteMinder authentication and validation directory mapping object.
SmCertMap	Represents a SiteMinder certificate mapping object.
SmDomain	Represents a SiteMinder Domain object.
SmDomainObjectImpl	Represents SiteMinder Domain-based objects.
SmExport	For internal use only.
SmExportAttr	This class provides set and get methods for attributes that are required for policy data export using SmPolicyApi.doExport().
SmHostConfig	Represents a SiteMinder Host Configuration Object.
SmImport	For internal use only.
SmImportAttr	This class provides set and get methods to write and read attributes required for policy data import using SmPolicyApi.doImport().
SmIPAddress	Specifies the Internet Protocol (IP) address that must be in use for a rule or policy to fire.
SmKeyManagement	Represents a SiteMinder Key Management object.
SmMigrationBase	For internal use only.
SmObjectImpl	The root of the Policy API object hierarchy.
SmObjId	Represents the object identifier of Policy API objects.
SmODBCQuery	Represents the SiteMinder ODBC Query Scheme.
SmPasswordPolicy	Represents SiteMinder Password Policy object.
SmPolicy	Represents a SiteMinder Policy object.
SmPolicyApiImpl	This is the implementation class of the interface SmPolicyApi.
SmPolicyLink	Represents a SiteMinder Policy Link object.
SmPwdPolicyRegularExpression	Represents a SiteMinder Regular Expression Object for Password Policy object.
SmRealm	Represents a SiteMinder Realm object.
SmResponse	Represents a SiteMinder Response object.
SmResponseAttr	Represents SiteMinder Response attribute.
SmResponseGroup	Represents a SiteMinder Response group object.
SmRootConfig	Represents a SiteMinder Root Configuration object.
SmRule	Represents a SiteMinder Rule object.
SmRuleGroup	Represents a SiteMinder Rule group.
SmScheme	Represents a SiteMinder authentication scheme.
SmSelfReg	Represents a SiteMinder Self-Registration scheme.
SmSharedSecretPolicy	Represents a SiteMinder Shared Secret Policy object.
SmTime	Represents time restrictions on rules and policies.
SmTrustedHost	Defines a Trusted Host object.
SmUserContext	Allows to set and retrieve information about a user in a user directory.
SmUserDirectory	Represents a SiteMinder User Directory.
SmUserPolicy	Represents a SiteMinder User Policy.
SmVariable	Represents a SiteMinder Variable object.
SmVariableType	Represents a SiteMinder Variable Type object.

Package com.netegrity.sdk.policyapi Description

Contains classes to create and manage policy objects within a SiteMinder installation.

Using this API, you can perform most of the data manipulations that are provided by the native SiteMinder User Interface.

The SmPolicyApiImpl class is the starting point for this package.

Policy API Reason Codes

If a Policy API method returns a result of SERVER_POLICY_API (status code 36), you can call getReason() to determine the reason code for the result.

The Policy API reason codes are as follows:

• 0. Success.
• -1. Failure.
• -2. Invalid handle.
• -3. Login error.
• -4. No privileges.
• -5. Invalid password syntax.
• -6. Invalid password.
• -7. Duplicate entry.
• -8. Does not exist.
• -9. Not found.
• -10. Bad argument.
• -11. Wrong number of elements.
• -12. User directory is not part of the domain.
• -13. Invalid user directory.
• -14. User directory error.
• -15. Agent not found.
• -16. Agent type not found.
• -17. Agent type attribute not found.
• -18. Agent type mismatch.
• -19. ODBC query scheme not found.
• -20. User directory not found.
• -21. Domain not found.
• -22. Administrator not found.
• -23. Scheme not found.
• -24. Registration scheme not found.
• -25. Password policy not found.
• -26. Scheme is required.
• -27. Password policy configuration.
• -28. Realm not found.
• -29. No children.
• -30. Rule not found.
• -31. Response not found.
• -32. Response attribute not found.
• -33. Policy not found.
• -34. Policy link not found.
• -35. User policy not found
• -36. Bad group.
• -37. Group not found.
• -38. Invalid.
• -39. Invalid handle version.
• -100. Invalid Oid.
• -101. Not implemented.
• -102. Not searchable.
• -103. Not storable.
• -104. Not a collection.
• -105. Not unique.
• -106. Invalid property.
• -107. Not initiazlized.
• -108. No session.
• -109. Oid is un use by realm.
• -110. Oid is in use by rule.
• -111. Oid is in use by administrator.
• -112. Missing property.
• -113. Group member name.
• -114. Radius IpAddress is not unique.
• -115. Group agent type.
• -116. Radius realm is not unique.
• -117. Realm filter is not unique
• -118. Invalid characters.
• -119. Agent type can't be deleted.
• -120. Provider is not implemented.
• -121. Provider is not unique.
• -122. Realm can't be used in rule.
• -123. Oid is in use by certificate map.
• -124. Oid is in use by self registration.
• -125. Oid is in use by user directory.
• -126. Scheme can't be deleted.
• -127. Basic scheme update.
• -128. Non HTML form.
• -129. Illegal realm operation.
• -130. Name is not unique.