com.netegrity.sdk.imspolicyapi
Class SmImsPolicyApiImpl

java.lang.Object
  |
  +--com.netegrity.sdk.policyapi.SmPolicyApiImpl
        |
        +--com.netegrity.sdk.imspolicyapi.SmImsPolicyApiImpl

All Implemented Interfaces:

SmImsPolicyApi, SmPolicyApi

public class SmImsPolicyApiImpl

extends SmPolicyApiImpl

implements SmImsPolicyApi

This is the implementation class of the interface SmImsPolicyApi. It provides all the IMS Policy Management API calls.

Use this class as the starting point for the IMS Policy Management API. For background information, see IMS Policy Management API in the Java Developer's Guide

Before creating an object of this class, you need to have a valid SmApiSession object.

Since:

SDK 2.0

Field Summary

Fields inherited from interface com.netegrity.sdk.policyapi.SmPolicyApi

SMPOLICYAPI_VERSION_20

Constructor Summary

SmImsPolicyApiImpl(SmApiSession apiSession)
Constructs an SmImsPolicyApiImpl object with a specified session (SmApiSession).

SmImsPolicyApiImpl(SmApiSession apiSession, int version)
Constructs an SmImsPolicyApiImpl object with a specified session (SmApiSession) and Policy API version compliance level.

Method Summary

SmApiResult	addIMSEnvToDomain(java.lang.String szIMSEnvName, java.lang.String szDomainName) Adds IMS Environment to Domain.
SmApiResult	getIMSEnv(java.lang.String szIMSEnvName, SmIMSEnvironment imsenv) Get IMS Environment.
SmApiResult	removeIMSEnvFromDomain(java.lang.String szIMSEnvName, java.lang.String szDomainName) Removes IMS Environment from Domain.

Methods inherited from class com.netegrity.sdk.policyapi.SmPolicyApiImpl

addAdmin, addAdminToDomain, addAgent, addAgentConfig, addAgentType, addAgentTypeAttr, addAuthAzMap, addAuthValidateMap, addCertMap, addDomain, addGroup, addHostConfig, addODBCQuery, addPasswordPolicy, addPolicy, addPolicy, addPolicyLink, addPolicyLink, addRealm, addRegularExpressionToPasswordPolicy, addResponse, addResponse, addResponseAttr, addResponseAttr, addRootConfig, addRule, addRule, addScheme, addSelfReg, addToGroup, addTrustedHost, addUserDirectory, addUserDirToDomain, addUserPolicy, addVariable, changeDynamicKey, changePersistentKey, changeSessionKey, changeSharedSecretKey, deleteAdmin, deleteAgent, deleteAgentConfig, deleteAgentType, deleteAgentTypeAttr, deleteAuthAzMap, deleteAuthValidateMap, deleteCertMap, deleteDomain, deleteGroup, deleteHostConfig, deleteODBCQuery, deletePasswordPolicy, deletePolicy, deletePolicyLink, deleteRealm, deleteResponse, deleteResponseAttr, deleteRootConfig, deleteRule, deleteScheme, deleteSelfReg, deleteTrustedHost, deleteUserDirectory, deleteUserPolicy, deleteVariable, doExport, doImport, flushAll, flushRealm, flushRealms, flushUser, flushUsers, getAdmin, getAdminDomains, getAdminUserDirs, getAgent, getAgentConfig, getAgentType, getAgentTypeAttr, getAgentTypeAttrs, getAuthAzMap, getAuthValidateMap, getCertMap, getChildren, getConfigObject, getDirectoryContents, getDomain, getDomainObject, getDomainObjectNames, getDomainVariables, getGlobalObjectNames, getGroup, getGroupMembers, getHostConfig, getKeyManagement, getObject, getODBCQuery, getPasswordPolicy, getPasswordState, getPolicy, getPolicyLinks, getPolicyStoreVersion, getRealm, getRealmRealms, getRealmRules, getRealmUserPolicies, getRegularExpressions, getResponse, getResponseAttrs, getResponseAttrs, getRootConfig, getRule, getScheme, getSelfReg, getSharedSecretPolicy, getUserContext, getUserDirectory, getUserDirSearchOrder, getUserGroups, getUserPolicies, getUserState, getVariable, getVariableType, getVersion, IsGroup, lookupDirectory, modifyAdmin, modifyAgent, modifyAgentConfig, modifyAgentType, modifyAgentTypeAttr, modifyAuthAzMap, modifyAuthValidateMap, modifyCertMap, modifyDomain, modifyGroup, modifyHostConfig, modifyKeyManagement, modifyODBCQuery, modifyPasswordPolicy, modifyPolicy, modifyPolicyLink, modifyRealm, modifyResponse, modifyResponseAttr, modifyRootConfig, modifyRule, modifyScheme, modifySelfReg, modifySharedSecretPolicy, modifyUserDirectory, modifyVariable, removeAdminFromDomain, removeFromGroup, removeRegularExpressionFromPasswordPolicy, removeUserDirFromDomain, renameObject, search, setApiSession, setPasswordState, setResponseInPolicyLink, setUserDirSearchOrder, setUserState

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netegrity.sdk.policyapi.SmPolicyApi

addAdmin, addAdminToDomain, addAgent, addAgentConfig, addAgentType, addAgentTypeAttr, addAuthAzMap, addAuthValidateMap, addCertMap, addDomain, addGroup, addHostConfig, addODBCQuery, addPasswordPolicy, addPolicy, addPolicy, addPolicyLink, addPolicyLink, addRealm, addRegularExpressionToPasswordPolicy, addResponse, addResponse, addResponseAttr, addResponseAttr, addRootConfig, addRule, addRule, addScheme, addSelfReg, addToGroup, addTrustedHost, addUserDirectory, addUserDirToDomain, addUserPolicy, addVariable, changeDynamicKey, changePersistentKey, changeSessionKey, changeSharedSecretKey, deleteAdmin, deleteAgent, deleteAgentConfig, deleteAgentType, deleteAgentTypeAttr, deleteAuthAzMap, deleteAuthValidateMap, deleteCertMap, deleteDomain, deleteGroup, deleteHostConfig, deleteODBCQuery, deletePasswordPolicy, deletePolicy, deletePolicyLink, deleteRealm, deleteResponse, deleteResponseAttr, deleteRootConfig, deleteRule, deleteScheme, deleteSelfReg, deleteTrustedHost, deleteUserDirectory, deleteUserPolicy, deleteVariable, doExport, doImport, flushAll, flushRealm, flushRealms, flushUser, flushUsers, getAdmin, getAdminDomains, getAdminUserDirs, getAgent, getAgentConfig, getAgentType, getAgentTypeAttr, getAgentTypeAttrs, getAuthAzMap, getAuthValidateMap, getCertMap, getChildren, getDirectoryContents, getDomain, getDomainObject, getDomainObjectNames, getDomainVariables, getGlobalObjectNames, getGroup, getGroupMembers, getHostConfig, getKeyManagement, getObject, getODBCQuery, getPasswordPolicy, getPasswordState, getPolicy, getPolicyLinks, getPolicyStoreVersion, getRealm, getRealmRealms, getRealmRules, getRealmUserPolicies, getRegularExpressions, getResponse, getResponseAttrs, getResponseAttrs, getRootConfig, getRule, getScheme, getSelfReg, getSharedSecretPolicy, getUserContext, getUserDirectory, getUserDirSearchOrder, getUserGroups, getUserPolicies, getUserState, getVariable, getVariableType, getVersion, IsGroup, lookupDirectory, modifyAdmin, modifyAgent, modifyAgentConfig, modifyAgentType, modifyAgentTypeAttr, modifyAuthAzMap, modifyAuthValidateMap, modifyCertMap, modifyDomain, modifyGroup, modifyHostConfig, modifyKeyManagement, modifyODBCQuery, modifyPasswordPolicy, modifyPolicy, modifyPolicyLink, modifyRealm, modifyResponse, modifyResponseAttr, modifyRootConfig, modifyRule, modifyScheme, modifySelfReg, modifySharedSecretPolicy, modifyUserDirectory, modifyVariable, removeAdminFromDomain, removeFromGroup, removeRegularExpressionFromPasswordPolicy, removeUserDirFromDomain, renameObject, search, setApiSession, setPasswordState, setResponseInPolicyLink, setUserDirSearchOrder, setUserState

Constructor Detail

SmImsPolicyApiImpl

public SmImsPolicyApiImpl(SmApiSession apiSession)

Constructs an SmImsPolicyApiImpl object with a specified session (SmApiSession).

This constructor chooses the default Policy API version SMPOLICYAPI_VERSION_20.

Parameters:

apiSession - SiteMinder API session object.

SmImsPolicyApiImpl

public SmImsPolicyApiImpl(SmApiSession apiSession,
                          int version)

Constructs an SmImsPolicyApiImpl object with a specified session (SmApiSession) and Policy API version compliance level.

Parameters:

apiSession - SiteMinder API session object.

version - The client's Policy API version compliance level. Valid Policy API compliance level constants are defined in the SmPolicyApi interface. These constants are prefixed with SMPOLICYAPI_VERSION_.

Method Detail

getIMSEnv

public SmApiResult getIMSEnv(java.lang.String szIMSEnvName,
                             SmIMSEnvironment imsenv)
                      throws SmApiException

Description copied from interface: SmImsPolicyApi

Get IMS Environment.

Specified by:

getIMSEnv in interface SmImsPolicyApi

Parameters:

szIMSEnvName - The IMS Environment to retrieve.

imsenv - This object will be populated with the properties of the IMS Environment.

Returns:

The result of the request.

SmApiException

addIMSEnvToDomain

public SmApiResult addIMSEnvToDomain(java.lang.String szIMSEnvName,
                                     java.lang.String szDomainName)
                              throws SmApiException

Description copied from interface: SmImsPolicyApi

Adds IMS Environment to Domain.

Specified by:

addIMSEnvToDomain in interface SmImsPolicyApi

Parameters:

szIMSEnvName - The IMS Environment name.

szDomainName - The domain to associate with the IMS Environment.

Returns:

The result of the request.

SmApiException

removeIMSEnvFromDomain

public SmApiResult removeIMSEnvFromDomain(java.lang.String szIMSEnvName,
                                          java.lang.String szDomainName)
                                   throws SmApiException

Description copied from interface: SmImsPolicyApi

Removes IMS Environment from Domain.

Specified by:

removeIMSEnvFromDomain in interface SmImsPolicyApi

Parameters:

szIMSEnvName - The IMS Environment name.

szDomainName - The domain to disassociate from the IMS Environment.

Returns:

The result of the request.

SmApiException