Overview  Package   Class  Tree  Deprecated  Index  Help 
SiteMinder
Java SDK r12.51
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.netegrity.sdk.policyapi
Class SmPolicyApiImpl

java.lang.Object
  extended by com.netegrity.sdk.policyapi.SmPolicyApiImpl
All Implemented Interfaces:
SmPolicyApi
Direct Known Subclasses:
SmImsPolicyApiImpl
public class SmPolicyApiImpl
extends java.lang.Object
implements SmPolicyApi

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

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

For information about method result reason codes, see Policy API Reason Codes.

Since:
SDK 2.0

Field Summary
 
Fields inherited from interface com.netegrity.sdk.policyapi.SmPolicyApi
SMPOLICYAPI_VERSION_20
 
Constructor Summary
SmPolicyApiImpl(SmApiSession apiSession)
          Constructs an SmPolicyApiImpl object with a specified session (SmApiSession).
SmPolicyApiImpl(SmApiSession apiSession, int version)
          Constructs an SmPolicyApiImpl object with a specified session (SmApiSession) and Policy API version compliance level.
 
Method Summary
 SmApiResult addAdmin(SmAdmin Admin)
          Creates a SiteMinder Administrator.
 SmApiResult addAdminToDomain(java.lang.String szAdminName, java.lang.String szDomainName)
          Associates a SiteMinder Administrator with a domain.
 SmApiResult addAgent(SmAgent Agent)
          Creates an Agent object.
 SmApiResult addAgentConfig(SmAgentConfig AgentConfig)
          Creates an Agent Configuration object.
 SmApiResult addAgentType(SmAgentType agentType)
          Creates an AgentType object.
 SmApiResult addAgentTypeAttr(SmAgentTypeAttr agentTypeAttr)
          Creates an AgentTypeAttr object.
 SmApiResult addAuthAzMap(SmAuthAzMap authAzMap)
          Adds an authentication and authorization directory mapping object.
 SmApiResult addAuthValidateMap(SmAuthValidateMap authValidateMap)
          Adds an authentication and validation directory mapping object.
 SmApiResult addCertMap(SmCertMap certMap)
          Adds a certificate mapping object.
 SmApiResult addDomain(SmDomain Domain)
          Creates a domain.
 SmApiResult addGroup(java.lang.String szDomainName, SmObject group)
          Creates a new group of any type (rule, response, agent).
 SmApiResult addHostConfig(SmHostConfig HostConfig)
          Creates a Host Configuration object.
 SmApiResult addODBCQuery(SmODBCQuery odbcQuery)
          Adds an ODBC query.
 SmApiResult addPasswordPolicy(SmPasswordPolicy passwordPolicy)
          Creates a password policy.
 SmApiResult addPolicy(SmPolicy policy)
          Adds a policy .
 SmApiResult addPolicy(SmPolicy policy, boolean bIsGlobal)
          Adds a policy object.
 SmApiResult addPolicyLink(SmPolicyLink policyLink)
          Adds a policy link to a policy.
 SmApiResult addPolicyLink(SmPolicyLink policyLink, boolean bIsGlobal)
          Adds a global PolicyLink if the boolean passed is true.
 SmApiResult addRealm(SmRealm realm)
          Adds a realm and associates it with a domain.
 SmApiResult addRegularExpressionToPasswordPolicy(SmPwdPolicyRegularExpression regEx)
          Adds the regular expression to password policy.
 SmApiResult addResponse(SmResponse response)
          Creates a response and associates it with a domain.
 SmApiResult addResponse(SmResponse response, boolean bIsGlobal)
          Creates a global response if bIsGlobal is true
 SmApiResult addResponseAttr(SmResponseAttr responseAttr)
          Creates a response attribute and associates it with a response.
 SmApiResult addResponseAttr(SmResponseAttr responseAttr, boolean bIsGlobal)
          Creates a global response attribute if bIsGlobal is true
 SmApiResult addRootConfig(SmRootConfig rootConfig)
          Creates a root configuration.
 SmApiResult addRule(SmRule rule)
          Adds a rule and associates it with the specified realm.
 SmApiResult addRule(SmRule Rule, boolean bIsGlobal)
          Adds a global rule if the boolean passed is true.
 SmApiResult addScheme(SmScheme Scheme)
          Creates an authentication scheme.
 SmApiResult addSelfReg(SmSelfReg SelfReg)
          Creates a self-registration object.
 SmApiResult addToGroup(int groupType, java.lang.String szItemName, java.lang.String szGroupName, java.lang.String szDomainName)
          Adds a group member of any type (rule, response, agent) to the specified group.
 SmApiResult addTrustedHost(SmTrustedHost TrustedHost)
          Registers a trusted host with the Policy Server.
 SmApiResult addUserDirectory(SmUserDirectory UserDir)
          Adds a user directory.
 SmApiResult addUserDirToDomain(java.lang.String szUserDirName, java.lang.String szDomainName)
          Associates a user directory with a domain.
 SmApiResult addUserPolicy(SmUserPolicy userPolicy)
          Adds a user policy to a policy.
 SmApiResult addVariable(SmVariable variable)
          Adds a variable .
 SmApiResult changeDynamicKey()
          Changes a dynamic encryption key.
 SmApiResult changePersistentKey(java.lang.String persistentKey)
          Changes a persistent encryption key.
 SmApiResult changeSessionKey(java.lang.String sessionKey)
          Changes a session encryption key.
 SmApiResult changeSharedSecretKey()
          Changes a shared secret encryption key.
 SmApiResult deleteAdmin(java.lang.String szAdminName)
          Deletes a SiteMinder Administrator.
 SmApiResult deleteAgent(java.lang.String szAgentName)
          Deletes an Agent object.
 SmApiResult deleteAgentConfig(java.lang.String szAgentConfigName)
          Deletes an Agent Configuration object.
 SmApiResult deleteAgentType(java.lang.String szAgentTypeName)
          Deletes an AgentType object.
 SmApiResult deleteAgentTypeAttr(java.lang.String szAgentTypeAttrName)
          Deletes an AgentTypeAttr object.
 SmApiResult deleteAuthAzMap(SmObjId authAzMapId)
          Deletes an authentication and authorization directory mapping object.
 SmApiResult deleteAuthValidateMap(SmObjId authValidateMapOid)
          Deletes an authentication and validation directory mapping object.
 SmApiResult deleteCertMap(SmObjId certMapId)
          Deletes a certificate mapping object.
 SmApiResult deleteDomain(java.lang.String szDomainName)
          Deletes a domain.
 SmApiResult deleteGroup(int groupType, java.lang.String szGroupName, java.lang.String szDomainName)
          Deletes a group of any type (rule, response, agent).
 SmApiResult deleteHostConfig(java.lang.String szHostConfigName)
          Deletes a Host Configuration object.
 SmApiResult deleteODBCQuery(java.lang.String szODBCQueryName)
          Deletes an ODBC query.
 SmApiResult deletePasswordPolicy(java.lang.String szPasswordPolicy)
          Deletes a password policy.
 SmApiResult deletePolicy(SmPolicy policy)
          Deletes a policy.
 SmApiResult deletePolicyLink(SmObjId policyLinkOid, java.lang.String szDomainName)
          Deletes a policy link.
 SmApiResult deleteRealm(SmRealm realm)
          Deletes a realm.
 SmApiResult deleteResponse(SmResponse response)
          Deletes a response.
 SmApiResult deleteResponseAttr(SmObjId responseAttrOid, java.lang.String szDomainName)
          Deletes a response attribute.
 SmApiResult deleteRootConfig(SmObjId rootConfigId)
          Deletes a root configuration.
 SmApiResult deleteRule(SmRule rule)
          Deletes a rule that is associated with the specified realm.
 SmApiResult deleteScheme(java.lang.String szSchemeName)
          Deletes an authentication scheme.
 SmApiResult deleteSelfReg(java.lang.String szSelfRegName)
          Deletes a self-registration object.
 SmApiResult deleteTrustedHost(java.lang.String szTrustedHostName)
          Deletes a Trusted Host object.
 SmApiResult deleteUserDirectory(java.lang.String szUserDirName)
          Deletes a user directory.
 SmApiResult deleteUserPolicy(SmObjId userPolicyOid, java.lang.String szDomainName)
          Deletes a user policy under a given domain.
 SmApiResult deleteVariable(SmVariable variable)
          Deletes a Variable.
 SmApiResult doExport(SmExportAttr objExportAttr)
          Exports policy data from a remote Policy Server.
 SmApiResult doImport(SmImportAttr objImportAttr)
          Imports policy data stored on a local client into remote Policy Server.
 SmApiResult flushAll()
          Flushes all SiteMinder caches.
 SmApiResult flushRealm(java.lang.String realmOid)
          Flushes a realm from the resource cache.
 SmApiResult flushRealms()
          Flushes all realms from the resource cache.
 SmApiResult flushUser(java.lang.String userDirectory, java.lang.String userDn)
          Flushes a user from the user information cache.
 SmApiResult flushUsers()
          Flushs the user information cache.
 SmApiResult getAdmin(java.lang.String szAdminName, SmAdmin Admin)
          Gets the contents of a SiteMinder Administrator.
 SmApiResult getAdminDomains(java.lang.String szAdminName, java.util.Vector adminDomains)
          Gets the all UserDirectory which is added by Domain of the Administrator object
 SmApiResult getAdminUserDirs(java.lang.String adminName, java.util.Vector userDirs)
          Gets a list of user directories that an administrator can manage.
 SmApiResult getAgent(java.lang.String szAgentName, SmAgent Agent)
          Gets the contents of an Agent object.
 SmApiResult getAgentConfig(java.lang.String szAgentConfigName, SmAgentConfig AgentConfig)
          Gets the contents of an Agent Configuration object.
 SmApiResult getAgentType(java.lang.String szAgentTypeName, SmAgentType agentType)
          Gets the contents of an Agent Type object.
 SmApiResult getAgentTypeAttr(java.lang.String szAgentTypeAttr, SmAgentTypeAttr AgentTypeAttr)
          Gets the contents of an Agent Type object.
 SmApiResult getAgentTypeAttrs(java.lang.String szAgentTypeName, java.util.Vector agentTypeAttrs)
          Gets the Oids of all AgentTypeAttr objects of the specified Agent Type
 SmApiResult getAuthAzMap(SmObjId authAzMapId, SmAuthAzMap authAzMap)
          Gets the contents of an authentication and authorization directory mapping object.
 SmApiResult getAuthValidateMap(SmObjId authValidateMapOid, SmAuthValidateMap authValidateMap)
          Gets the contents of an authentication and validation directory mapping object.
 SmApiResult getCertMap(SmObjId certMapId, SmCertMap certMap)
          Gets the properties of a certificate mapping object.
 SmApiResult getChildren(java.lang.String szOid, java.util.Vector Children)
          Gets a list of OIDs of realms under a domain or gets the list of rules and realms under a realm
 SmApiResult getConfigObject(java.lang.String szObjName, SmObject obj)
           
 SmApiResult getDirectoryContents(java.lang.String userDirName, java.util.Hashtable enumerateResult)
          Enumerates a user directory.
 SmApiResult getDomain(java.lang.String szDomainName, SmDomain Domain)
          Gets the contents of a domain object.
 SmApiResult getDomainObject(java.lang.String szObjName, java.lang.String szDomainName, SmDomainObject obj)
          Gets a domain object by name or object identifier (OID).
 SmApiResult getDomainObjectNames(java.lang.String propName, java.lang.String domainName, java.util.Vector ObjectNames)
          Gets a list of domain objects within a domain.
 SmApiResult getDomainVariables(java.lang.String szDomainName, java.util.Vector variables)
          Gets the List of the variables present in a domain.
 SmApiResult getGlobalObjectNames(java.lang.String szPropName, java.util.Vector ObjectNames)
          Gets a list of global objects.
 SmApiResult getGroup(java.lang.String szGroupName, java.lang.String szDomainName, SmObject Group)
          Gets the contents of a group of any type (rule, response, agent).
 SmApiResult getGroupMembers(int groupType, java.lang.String szGroupName, java.lang.String szDomainName, java.util.Vector Names)
          Gets a list of groups of any type (rule, response, and agent).
 SmApiResult getHostConfig(java.lang.String szHostConfigName, SmHostConfig HostConfig)
          Gets the contents of a Host Configuration object.
 SmApiResult getKeyManagement(java.lang.String szOid, SmKeyManagement keyManagement)
          Gets the contents of an SmKeyManagement object.
 SmApiResult getObject(java.lang.String szObjName, SmObject obj)
          Gets a global object by name or object identifier (OID).
 SmApiResult getODBCQuery(java.lang.String szODBCQuery, SmODBCQuery odbcQuery)
          Gets the contents of an ODBC query.
 SmApiResult getPasswordPolicy(java.lang.String szPasswordPolicy, SmPasswordPolicy passwordPolicy)
          Gets the contents of a password policy.
 SmApiResult getPasswordState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState passwordState)
          Gets the password state of the user which includes login failures, disabled time, last login time, last password change and previous login time.
 SmApiResult getPolicy(java.lang.String szPolicyName, java.lang.String szDomainName, SmPolicy Policy)
          Gets the contents of a policy.
 SmApiResult getPolicyLinks(java.lang.String szPolicyName, java.lang.String szDomainName, java.util.Vector PolicyLinks)
          Returns all policy links for the specified policy and domain.
 SmApiResult getPolicyStoreVersion(java.lang.StringBuffer majorVersion, java.lang.StringBuffer minorVersion, java.lang.StringBuffer mode)
           
 SmApiResult getRealm(java.lang.String szRealmName, java.lang.String szDomainName, SmRealm Realm)
          Gets the contents of a realm.
 SmApiResult getRealmRealms(java.lang.String szRealmName, java.lang.String szDomainName, java.util.Vector Realms)
          Returns all of the realms for the specified realm and domain.
 SmApiResult getRealmRules(java.lang.String szRealmName, java.lang.String szDomainName, java.util.Vector Rules)
          Returns all of the rules for the specified realm and domain.
 SmApiResult getRealmUserPolicies(java.lang.String realmOID, java.util.Vector UserPolicyOIDs)
          Gets a list of user policies that can access a realm.
 SmApiResult getRegularExpressions(java.lang.String passwordPolicyName, java.util.Vector regExps)
          Gets the list of regular expression for a password policy object.
 SmApiResult getResponse(java.lang.String szResponseName, java.lang.String szDomainName, SmResponse Response)
          Gets the contents of a response.
 SmApiResult getResponseAttrs(java.lang.String szResponseName, java.lang.String szDomainName, java.util.Map ResponseAttrs)
          Gets a list of response attributes.
 SmApiResult getResponseAttrs(java.lang.String szResponseName, java.lang.String szDomainName, java.util.Vector ResponseAttrs)
          Gets a list of response attributes that belong to a response.
 SmApiResult getRootConfig(SmObjId rootConfigId, SmRootConfig rootConfig)
          Gets the root configuration.
 SmApiResult getRule(java.lang.String szRuleName, java.lang.String szRealmName, java.lang.String szDomainName, SmRule Rule)
          Gets the contents of a rule that is associated with the specified realm.
 SmApiResult getScheme(java.lang.String szSchemeName, SmScheme Scheme)
          Gets the contents of an authentication scheme.
 SmApiResult getSelfReg(java.lang.String szSelfRegName, SmSelfReg SelfReg)
          Gets the contents of a self-registration object.
 SmApiResult getSharedSecretPolicy(java.lang.String szOid, SmSharedSecretPolicy sharedSecretPolicy)
          Gets the contents of an SmSharedSecretPolicy object.
 SmApiResult getUserContext(SmObjId dirOid, java.lang.String userDn, java.lang.String sessionId, SmUserContext userContext)
          Returns contextual information of a given user.
 SmApiResult getUserDirectory(java.lang.String szUserDirName, SmUserDirectory UserDir)
          Gets the contents of a user directory.
 SmApiResult getUserDirSearchOrder(java.lang.String szDomainName, java.util.Vector DirectoryNames)
          Retrieves the search order of user directories for a domain.
 SmApiResult getUserGroups(SmObjId dirOid, java.lang.String userDn, boolean recursive, java.util.Vector groups)
          Returns a list of groups that a user is a member of.
 SmApiResult getUserPolicies(java.lang.String szPolicyName, java.lang.String szDomainName, java.util.Vector UserPolicies)
          Gets all user policies for a given policy.
 SmApiResult getUserState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState userState)
          Gets the user state as enable/disable with the disabled reason for the disabled state, if disabled.
 SmApiResult getVariable(java.lang.String szVariableName, java.lang.String szDomainName, SmVariable variable)
          Gets the contents of a Variable.
 SmApiResult getVariableType(java.lang.String szVariableType, SmVariableType variableType)
          Gets the contents of a VariableType.
 int getVersion()
          Gets the Policy API version compliance level.
 SmApiResult holdUpdatesNotificationsProcessing()
          Disable all SiteMinder cache updates This method disnables cache updates.
 boolean IsGroup(java.lang.String szOid)
          Returns whether the OID passed is of an group or not.
 SmApiResult isUpdatesNotificationsProcessingOnHold(NotificationProcessingStatus processingOnHold)
          Show all Siteminder cache updates status This method Shows cache update status.
 SmApiResult lookupDirectory(java.lang.String userDirName, java.lang.String searchPattern, java.util.Hashtable lookupResult)
          Performs a user directory lookup.
 SmApiResult modifyAdmin(SmAdmin Admin)
          Modifies a SiteMinder Administrator.
 SmApiResult modifyAgent(SmAgent Agent)
          Modifies an Agent object.
 SmApiResult modifyAgentConfig(SmAgentConfig AgentConfig)
          Modifies an Agent Configuration object.
 SmApiResult modifyAgentType(SmAgentType agentType)
          Modifies an AgentType object.
 SmApiResult modifyAgentTypeAttr(SmAgentTypeAttr agentTypeAttr)
          Modifies an AgentTypeAttr object.
 SmApiResult modifyAuthAzMap(SmAuthAzMap authAzMap)
          Modifies an authentication and authorization directory mapping object.
 SmApiResult modifyAuthValidateMap(SmAuthValidateMap authValidateMap)
          Modifies an authentication and validation directory mapping object.
 SmApiResult modifyCertMap(SmCertMap certMap)
          Modifies a certificate mapping object.
 SmApiResult modifyDomain(SmDomain Domain)
          Modifies a domain.
 SmApiResult modifyGroup(java.lang.String szDomainName, SmObject group)
          Modifies a group of any type (rule, response, agent).
 SmApiResult modifyHostConfig(SmHostConfig HostConfig)
          Modifies a Host Configuration object.
 SmApiResult modifyKeyManagement(SmKeyManagement keyManagement)
          Modifies an SmKeyManagement object.
 SmApiResult modifyODBCQuery(SmODBCQuery odbcQuery)
          Modifies an ODBC query.
 SmApiResult modifyPasswordPolicy(SmPasswordPolicy passwordPolicy)
          Modifies a password policy.
 SmApiResult modifyPolicy(SmPolicy policy)
          Modifies a policy.
 SmApiResult modifyPolicyLink(SmPolicyLink policyLink)
          Modifies a policy link.
 SmApiResult modifyRealm(SmRealm realm)
          Modifies a realm.
 SmApiResult modifyResponse(SmResponse response)
          Modifies a response.
 SmApiResult modifyResponseAttr(SmResponseAttr ResponseAttr)
          Sets a response attribute
 SmApiResult modifyRootConfig(SmRootConfig rootConfig)
          Modifies a root configuration.
 SmApiResult modifyRule(SmRule rule)
          Modifies a rule that is associated with the specified realm.
 SmApiResult modifyScheme(SmScheme Scheme)
          Modifies an authentication scheme.
 SmApiResult modifySelfReg(SmSelfReg SelfReg)
          Modifies a self-registration object.
 SmApiResult modifySharedSecretPolicy(SmSharedSecretPolicy sharedSecretPolicy)
          Modifies an SharedSecretPolicy object.
 SmApiResult modifyUserDirectory(SmUserDirectory UserDir)
          Modifies a user directory.
 SmApiResult modifyVariable(SmVariable variable)
          Modifies a variable with the properties of the variable being passed.
 SmApiResult removeAdminFromDomain(java.lang.String szAdminName, java.lang.String szDomainName)
          Disassociates a user directory from a domain.
 SmApiResult removeFromGroup(int groupType, java.lang.String szItemName, java.lang.String szGroupName, java.lang.String szDomainName)
          Removes a group member of any type (rule, response, agent) from the specified group.
 SmApiResult removeRegularExpressionFromPasswordPolicy(SmPwdPolicyRegularExpression regEx)
          Removes the regular expression from password policy.
 SmApiResult removeUserDirFromDomain(java.lang.String szUserDirName, java.lang.String szDomainName)
          Disassociates a user directory from a domain.
 SmApiResult renameObject(SmObjId objId, java.lang.String newName)
          Renames an object.
 SmApiResult resumeUpdatesNotificationsProcessing()
          Enable all SiteMinder cache updates This method enables cache updates.
 SmApiResult search(SmObject searchObj, java.lang.String[] searchProps, java.util.Vector searchResults)
          Searches the policy store for the specified object using the specified search criteria.
 void setApiSession(SmApiSession apiSession)
          Sets the API session object.
 SmApiResult setPasswordState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState passwordState)
          This function sets the password state of the user which includes login failures, disabled time, last login time, empty password history, last password change and previous login time.
 SmApiResult setResponseInPolicyLink(SmPolicyLink policyLink)
          Changes the response for a particular policy link.
 SmApiResult setUserDirSearchOrder(java.lang.String szDomainName, java.util.Vector DirectoryNames)
          Sets the search order of user directories for a domain.
 SmApiResult setUserState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState userState)
          Sets the user state as enable/disable with the disabled reason for the state, if state is disabled.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SmPolicyApiImpl

public SmPolicyApiImpl(SmApiSession apiSession)

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

This constructor chooses the default Policy API version SMPOLICYAPI_VERSION_20.

Parameters:
apiSession - SiteMinder API session object.

SmPolicyApiImpl

public SmPolicyApiImpl(SmApiSession apiSession,
                       int version)

Constructs an SmPolicyApiImpl 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_.

DMS API compliance level constants are defined in the SmDmsApi interface and are prefixed with SMDMSAPI_VERSION_.

Method Detail

setApiSession

public void setApiSession(SmApiSession apiSession)
Description copied from interface: SmPolicyApi
Sets the API session object.

Specified by:
setApiSession in interface SmPolicyApi
Parameters:
apiSession - SiteMinder API session object.

search

public SmApiResult search(SmObject searchObj,
                          java.lang.String[] searchProps,
                          java.util.Vector searchResults)
                   throws SmApiException
Description copied from interface: SmPolicyApi
Searches the policy store for the specified object using the specified search criteria.

Specified by:
search in interface SmPolicyApi
Parameters:
searchObj - The object to search for.

searchProps - One or more search criteria. Valid search criteria values are constants that:

  • Begin with Prop and that are defined in the class of the object you are searching for.

  • Are documented as being searchable properties.

For example, you can use PropPolicy to search for SmUserPolicy objects, and PropIpAddr to search for SmAgent objects.

searchResults - This Vector will be populated with the search results.
Returns:
An SmApiResult object for the search.
Throws:
SmApiException

addRule

public SmApiResult addRule(SmRule rule)
                    throws SmApiException
Description copied from interface: SmPolicyApi
Adds a rule and associates it with the specified realm.

Specified by:
addRule in interface SmPolicyApi
Parameters:
rule - The rule and its properties that are being added.
Returns:
The result of the request.
Throws:
SmApiException

addRule

public SmApiResult addRule(SmRule Rule,
                           boolean bIsGlobal)
                    throws SmApiException
Description copied from interface: SmPolicyApi
Adds a global rule if the boolean passed is true.

Specified by:
addRule in interface SmPolicyApi
bIsGlobal - If bIsGlobal is true, a global rule is created If bIsGlobal is false, a domain rule is created
Returns:
The result of the request.
Throws:
SmApiException

modifyRule

public SmApiResult modifyRule(SmRule rule)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a rule that is associated with the specified realm.

Specified by:
modifyRule in interface SmPolicyApi
Parameters:
rule - The rule and its properties that are being modified.
Returns:
The result of the request.
Throws:
SmApiException

deleteRule

public SmApiResult deleteRule(SmRule rule)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a rule that is associated with the specified realm.

Specified by:
deleteRule in interface SmPolicyApi
Parameters:
rule - The rule to delete.
Throws:
SmApiException

getRule

public SmApiResult getRule(java.lang.String szRuleName,
                           java.lang.String szRealmName,
                           java.lang.String szDomainName,
                           SmRule Rule)
                    throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a rule that is associated with the specified realm.

Specified by:
getRule in interface SmPolicyApi
Parameters:
szRuleName - Name of the rule whose properties are being retrieved.
szRealmName - Object indentifier of the realm that is associated with the rule.
szDomainName - Name of the domain where the rule is located.
Rule - This object will be populated with the properties of the rule.
Returns:
The result of the request.
Throws:
SmApiException

addPolicy

public SmApiResult addPolicy(SmPolicy policy)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Adds a policy .

Specified by:
addPolicy in interface SmPolicyApi
Parameters:
policy - The policy and its properties that are being added.
Returns:
The result of the request.
Throws:
SmApiException

addPolicy

public SmApiResult addPolicy(SmPolicy policy,
                             boolean bIsGlobal)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Adds a policy object.

Specified by:
addPolicy in interface SmPolicyApi
Parameters:
policy - The policy and its properties that are being added.
bIsGlobal - If bIsGlobal is true, a global policy is created If bIsGlobal is false, a domain policy is created
Returns:
The result of the request.
Throws:
SmApiException

addVariable

public SmApiResult addVariable(SmVariable variable)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Adds a variable .

Specified by:
addVariable in interface SmPolicyApi
Parameters:
variable - The variable and its properties that are being added.
Returns:
The result of the request.
Throws:
SmApiException

getVariable

public SmApiResult getVariable(java.lang.String szVariableName,
                               java.lang.String szDomainName,
                               SmVariable variable)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a Variable.

Specified by:
getVariable in interface SmPolicyApi
variable - This object will be populated with the properties of the variable.
Returns:
The result of the request.
Throws:
SmApiException

getDomainVariables

public SmApiResult getDomainVariables(java.lang.String szDomainName,
                                      java.util.Vector variables)
                               throws SmApiException
Description copied from interface: SmPolicyApi
Gets the List of the variables present in a domain.

Specified by:
getDomainVariables in interface SmPolicyApi
Parameters:
szDomainName - The name of the domain
variables - The vector which will be populated by the object variables
Returns:
The result of the request.
Throws:
SmApiException

modifyVariable

public SmApiResult modifyVariable(SmVariable variable)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a variable with the properties of the variable being passed.

Specified by:
modifyVariable in interface SmPolicyApi
Parameters:
variable - The variable and its properties that are being modified.
Returns:
The result of the request.
Throws:
SmApiException

deleteVariable

public SmApiResult deleteVariable(SmVariable variable)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a Variable.

Specified by:
deleteVariable in interface SmPolicyApi
Parameters:
variable - The variable to delete.
Returns:
The result of the request.
Throws:
SmApiException

modifyPolicy

public SmApiResult modifyPolicy(SmPolicy policy)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a policy.

Specified by:
modifyPolicy in interface SmPolicyApi
Parameters:
policy - The policy and its properties that are being modified.
Returns:
The result of the request.
Throws:
SmApiException

deletePolicy

public SmApiResult deletePolicy(SmPolicy policy)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a policy.
Note: This method deletes all related policy links and user policies.

Specified by:
deletePolicy in interface SmPolicyApi
Parameters:
policy - The policy to delete.
Returns:
The result of the request.
Throws:
SmApiException

getPolicy

public SmApiResult getPolicy(java.lang.String szPolicyName,
                             java.lang.String szDomainName,
                             SmPolicy Policy)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a policy.

Specified by:
getPolicy in interface SmPolicyApi
Parameters:
szPolicyName - The policy whose properties are being retrieved.
szDomainName - The domain where the policy is located.
Policy - This object will be populated with the properties of the policy.
Returns:
The result of the request.
Throws:
SmApiException

getVariableType

public SmApiResult getVariableType(java.lang.String szVariableType,
                                   SmVariableType variableType)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a VariableType.

Specified by:
getVariableType in interface SmPolicyApi
Parameters:
szVariableType - The VariableType whose properties are being retrieved.
variableType - This object will be populated with the properties of the variableType.
Returns:
The result of the request.
Throws:
SmApiException

addPolicyLink

public SmApiResult addPolicyLink(SmPolicyLink policyLink)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Adds a policy link to a policy.

Specified by:
addPolicyLink in interface SmPolicyApi
Parameters:
policyLink - The policy link object to add to the policy.
Returns:
The result of the request.
Throws:
SmApiException

addPolicyLink

public SmApiResult addPolicyLink(SmPolicyLink policyLink,
                                 boolean bIsGlobal)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Adds a global PolicyLink if the boolean passed is true.

Specified by:
addPolicyLink in interface SmPolicyApi
Parameters:
policyLink - The policyLink and its properties that are being added.
bIsGlobal - If bIsGlobal is true, a global policyLink is created If bIsGlobal is false, a domain policyLink is created
Returns:
The result of the request.
Throws:
SmApiException

modifyPolicyLink

public SmApiResult modifyPolicyLink(SmPolicyLink policyLink)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a policy link.

Specified by:
modifyPolicyLink in interface SmPolicyApi
Parameters:
policyLink - The policy link object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deletePolicyLink

public SmApiResult deletePolicyLink(SmObjId policyLinkOid,
                                    java.lang.String szDomainName)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a policy link.

Specified by:
deletePolicyLink in interface SmPolicyApi
Parameters:
policyLinkOid - Object identifier of the policy link to delete.
szDomainName - The domain where the policy link is located.
Returns:
The result of the request.
Throws:
SmApiException

getPolicyLinks

public SmApiResult getPolicyLinks(java.lang.String szPolicyName,
                                  java.lang.String szDomainName,
                                  java.util.Vector PolicyLinks)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Returns all policy links for the specified policy and domain.

Specified by:
getPolicyLinks in interface SmPolicyApi
Parameters:
szPolicyName - The policy where the policy links are located.
szDomainName - The domain where the policy links are located.
PolicyLinks - This Vector will be populated with SmPolicyLink objects.
Returns:
The result of the request.
Throws:
SmApiException

setResponseInPolicyLink

public SmApiResult setResponseInPolicyLink(SmPolicyLink policyLink)
                                    throws SmApiException
Description copied from interface: SmPolicyApi
Changes the response for a particular policy link.

Specified by:
setResponseInPolicyLink in interface SmPolicyApi
Parameters:
policyLink - The policy link object containing the response being changed.
Returns:
The result of the request.
Throws:
SmApiException

addUserPolicy

public SmApiResult addUserPolicy(SmUserPolicy userPolicy)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Adds a user policy to a policy.

Specified by:
addUserPolicy in interface SmPolicyApi
Parameters:
userPolicy - The user policy object to add.
Returns:
The result of the request.
Throws:
SmApiException

deleteUserPolicy

public SmApiResult deleteUserPolicy(SmObjId userPolicyOid,
                                    java.lang.String szDomainName)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a user policy under a given domain.

Specified by:
deleteUserPolicy in interface SmPolicyApi
szDomainName - The domain that contains the user policy to delete.
Returns:
The result of the request.
Throws:
SmApiException

getUserPolicies

public SmApiResult getUserPolicies(java.lang.String szPolicyName,
                                   java.lang.String szDomainName,
                                   java.util.Vector UserPolicies)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Gets all user policies for a given policy.

Specified by:
getUserPolicies in interface SmPolicyApi
Parameters:
szPolicyName - The policy where the user policies are located.
szDomainName - The domain where the user policy are located.
Returns:
The result of the request.
Throws:
SmApiException

addRealm

public SmApiResult addRealm(SmRealm realm)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Adds a realm and associates it with a domain.

Specified by:
addRealm in interface SmPolicyApi
Parameters:
realm - The realm to add.
Returns:
The result of the request.
Throws:
SmApiException

modifyRealm

public SmApiResult modifyRealm(SmRealm realm)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a realm.

Specified by:
modifyRealm in interface SmPolicyApi
Parameters:
realm - The realm to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteRealm

public SmApiResult deleteRealm(SmRealm realm)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a realm.
Note: You cannot delete a realm if any existing rules are linked to it.

Specified by:
deleteRealm in interface SmPolicyApi
Parameters:
realm - The realm to delete.
Returns:
The result of the request.
Throws:
SmApiException

getRealm

public SmApiResult getRealm(java.lang.String szRealmName,
                            java.lang.String szDomainName,
                            SmRealm Realm)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a realm.

Specified by:
getRealm in interface SmPolicyApi
Parameters:
szRealmName - The realm name or object identifier.
szDomainName - The domain where the realm is located.
Realm - This object will be populated with the properties of the realm.
Returns:
The result of the request.
Throws:
SmApiException

getRealmRules

public SmApiResult getRealmRules(java.lang.String szRealmName,
                                 java.lang.String szDomainName,
                                 java.util.Vector Rules)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Returns all of the rules for the specified realm and domain.

Specified by:
getRealmRules in interface SmPolicyApi
Parameters:
szRealmName - The realm name or object identifier.
szDomainName - The domain where the realm is located.
Returns:
The result of the request.
Throws:
SmApiException

getRealmRealms

public SmApiResult getRealmRealms(java.lang.String szRealmName,
                                  java.lang.String szDomainName,
                                  java.util.Vector Realms)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Returns all of the realms for the specified realm and domain.

Specified by:
getRealmRealms in interface SmPolicyApi
Parameters:
szRealmName - The realm name or object identifier.
szDomainName - The domain where the realm is located.
Returns:
The result of the request.
Throws:
SmApiException

addResponse

public SmApiResult addResponse(SmResponse response)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Creates a response and associates it with a domain.

Specified by:
addResponse in interface SmPolicyApi
Parameters:
response - The response object to add.
Returns:
The result of the request.
Throws:
SmApiException

addResponse

public SmApiResult addResponse(SmResponse response,
                               boolean bIsGlobal)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Creates a global response if bIsGlobal is true

Specified by:
addResponse in interface SmPolicyApi
Parameters:
response - The response object to add.
bIsGlobal - If bIsGlobal is true, a global response is created. If bIsGlobal is false, a domain rule is created.
Returns:
The result of the request.
Throws:
SmApiException

modifyResponse

public SmApiResult modifyResponse(SmResponse response)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a response.

Specified by:
modifyResponse in interface SmPolicyApi
Parameters:
response - The response object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteResponse

public SmApiResult deleteResponse(SmResponse response)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a response.
Note: This method deletes any related response attributes.

Specified by:
deleteResponse in interface SmPolicyApi
Parameters:
response - The response to delete.
Returns:
The result of the request.
Throws:
SmApiException

getResponse

public SmApiResult getResponse(java.lang.String szResponseName,
                               java.lang.String szDomainName,
                               SmResponse Response)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a response.

Specified by:
getResponse in interface SmPolicyApi
Parameters:
szResponseName - The response to retrieve.
szDomainName - The domain where response is located.
Response - This object will be populated with the properties of the resopnse.
Returns:
The result of the request.
Throws:
SmApiException

addResponseAttr

public SmApiResult addResponseAttr(SmResponseAttr responseAttr)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Creates a response attribute and associates it with a response.

Specified by:
addResponseAttr in interface SmPolicyApi
Parameters:
responseAttr - The response attribute object to create.
Returns:
The result of the request.
Throws:
SmApiException

addResponseAttr

public SmApiResult addResponseAttr(SmResponseAttr responseAttr,
                                   boolean bIsGlobal)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Creates a global response attribute if bIsGlobal is true

Specified by:
addResponseAttr in interface SmPolicyApi
Parameters:
responseAttr - The response attribute object to create.
bIsGlobal - If bIsGlobal is true, a global ResponseAttr is created If bIsGlobal is false, a domain ResponseAttr is created
Returns:
The result of the request.
Throws:
SmApiException

deleteResponseAttr

public SmApiResult deleteResponseAttr(SmObjId responseAttrOid,
                                      java.lang.String szDomainName)
                               throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a response attribute.

Specified by:
deleteResponseAttr in interface SmPolicyApi
Parameters:
responseAttrOid - The object identifier of the response attribute to delete.
szDomainName - The domain where the response attribute is located.
Returns:
The result of the request.
Throws:
SmApiException

getResponseAttrs

public SmApiResult getResponseAttrs(java.lang.String szResponseName,
                                    java.lang.String szDomainName,
                                    java.util.Vector ResponseAttrs)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of response attributes that belong to a response.

Specified by:
getResponseAttrs in interface SmPolicyApi
Parameters:
szResponseName - The response whose atributes are being retrieved.
szDomainName - Name of the domain where the response is located.
ResponseAttrs - This Vector will be populated with the list of response attributes (SmResponseAttr).
Returns:
The result of the request.
Throws:
SmApiException

getResponseAttrs

public SmApiResult getResponseAttrs(java.lang.String szResponseName,
                                    java.lang.String szDomainName,
                                    java.util.Map ResponseAttrs)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of response attributes.

Specified by:
getResponseAttrs in interface SmPolicyApi
Parameters:
szResponseName - The response whose atributes are being retrieved.
ResponseAttrs - This Map will be populated with the list of response attributes OIDs and values (SmResponseAttr).
Returns:
The result of the request.
Throws:
SmApiException

modifyResponseAttr

public SmApiResult modifyResponseAttr(SmResponseAttr ResponseAttr)
                               throws SmApiException
Description copied from interface: SmPolicyApi
Sets a response attribute

Specified by:
modifyResponseAttr in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

addAuthAzMap

public SmApiResult addAuthAzMap(SmAuthAzMap authAzMap)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Adds an authentication and authorization directory mapping object.

Specified by:
addAuthAzMap in interface SmPolicyApi
Parameters:
authAzMap - The authentication and authorization mapping object to add.
Returns:
The result of the request.
Throws:
SmApiException

modifyAuthAzMap

public SmApiResult modifyAuthAzMap(SmAuthAzMap authAzMap)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an authentication and authorization directory mapping object.

Specified by:
modifyAuthAzMap in interface SmPolicyApi
Parameters:
authAzMap - The authentication and authorization mapping object to modify.
Returns:
The result of the request.
Throws:
SmApiException

getAuthAzMap

public SmApiResult getAuthAzMap(SmObjId authAzMapId,
                                SmAuthAzMap authAzMap)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an authentication and authorization directory mapping object.

Specified by:
getAuthAzMap in interface SmPolicyApi
Parameters:
authAzMapId - The object identifier of the authentication and authorization mapping object to retreive.
authAzMap - This object will be populated with the properties of the authentication and authorization mapping object.
Returns:
The result of the request.
Throws:
SmApiException

deleteAuthAzMap

public SmApiResult deleteAuthAzMap(SmObjId authAzMapId)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an authentication and authorization directory mapping object.

Specified by:
deleteAuthAzMap in interface SmPolicyApi
Parameters:
authAzMapId - Object identifier of the authentication and authorization mapping object to delete.
Returns:
The result of the request.
Throws:
SmApiException

addCertMap

public SmApiResult addCertMap(SmCertMap certMap)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Adds a certificate mapping object.

Specified by:
addCertMap in interface SmPolicyApi
Parameters:
certMap - The certificate mapping object to add.
Returns:
The result of the request.
Throws:
SmApiException

modifyCertMap

public SmApiResult modifyCertMap(SmCertMap certMap)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a certificate mapping object.

Specified by:
modifyCertMap in interface SmPolicyApi
Parameters:
certMap - The certificate mapping object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteCertMap

public SmApiResult deleteCertMap(SmObjId certMapId)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a certificate mapping object.

Specified by:
deleteCertMap in interface SmPolicyApi
Parameters:
certMapId - The object identifier of the certificate mapping object to delete.
Returns:
The result of the request.
Throws:
SmApiException

getCertMap

public SmApiResult getCertMap(SmObjId certMapId,
                              SmCertMap certMap)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Gets the properties of a certificate mapping object.

Specified by:
getCertMap in interface SmPolicyApi
Parameters:
certMapId - The object identifier of the certificate mapping object to retrieve.
certMap - This object will be populated with the properties of the certificate mapping object.
Returns:
The result of the request.
Throws:
SmApiException

addODBCQuery

public SmApiResult addODBCQuery(SmODBCQuery odbcQuery)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Adds an ODBC query.

Specified by:
addODBCQuery in interface SmPolicyApi
Parameters:
odbcQuery - The ODBC query object to add.
Returns:
The result of the request.
Throws:
SmApiException

modifyODBCQuery

public SmApiResult modifyODBCQuery(SmODBCQuery odbcQuery)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an ODBC query.

Specified by:
modifyODBCQuery in interface SmPolicyApi
Parameters:
odbcQuery - The ODBC query object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteODBCQuery

public SmApiResult deleteODBCQuery(java.lang.String szODBCQueryName)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an ODBC query.

Specified by:
deleteODBCQuery in interface SmPolicyApi
Parameters:
szODBCQueryName - The ODBC query object to delete.
Returns:
The result of the request.
Throws:
SmApiException

getODBCQuery

public SmApiResult getODBCQuery(java.lang.String szODBCQuery,
                                SmODBCQuery odbcQuery)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an ODBC query.

Specified by:
getODBCQuery in interface SmPolicyApi
Parameters:
szODBCQuery - Name of the ODBC query object to retrieve.
odbcQuery - This object will be populated with the properties of the ODBC query.
Returns:
The result of the request.
Throws:
SmApiException

addUserDirectory

public SmApiResult addUserDirectory(SmUserDirectory UserDir)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Adds a user directory.

Specified by:
addUserDirectory in interface SmPolicyApi
Parameters:
UserDir - The SiteMinder user directory to add.
Returns:
The result of the request.
Throws:
SmApiException

modifyUserDirectory

public SmApiResult modifyUserDirectory(SmUserDirectory UserDir)
                                throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a user directory.

Specified by:
modifyUserDirectory in interface SmPolicyApi
Parameters:
UserDir - The SiteMinder user directory to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteUserDirectory

public SmApiResult deleteUserDirectory(java.lang.String szUserDirName)
                                throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a user directory.
Note: This method also removes directory users from policies.

Specified by:
deleteUserDirectory in interface SmPolicyApi
Parameters:
szUserDirName - The user directory to delete.
Returns:
The result of the request.
Throws:
SmApiException

getUserDirectory

public SmApiResult getUserDirectory(java.lang.String szUserDirName,
                                    SmUserDirectory UserDir)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a user directory.

Specified by:
getUserDirectory in interface SmPolicyApi
Parameters:
szUserDirName - The user directory to retrieve.
UserDir - This object will be populated with the properties of the user directory.
Returns:
The result of the request.
Throws:
SmApiException

addUserDirToDomain

public SmApiResult addUserDirToDomain(java.lang.String szUserDirName,
                                      java.lang.String szDomainName)
                               throws SmApiException
Description copied from interface: SmPolicyApi
Associates a user directory with a domain.

Specified by:
addUserDirToDomain in interface SmPolicyApi
Parameters:
szUserDirName - The user directory to associate with a domain.
szDomainName - The domain to associate with the user directory.
Returns:
The result of the request.
Throws:
SmApiException

removeUserDirFromDomain

public SmApiResult removeUserDirFromDomain(java.lang.String szUserDirName,
                                           java.lang.String szDomainName)
                                    throws SmApiException
Description copied from interface: SmPolicyApi
Disassociates a user directory from a domain.

Specified by:
removeUserDirFromDomain in interface SmPolicyApi
Parameters:
szUserDirName - The user directory to disassociate from the domain.
szDomainName - The domain to disassociate from the user directory.
Returns:
The result of the request.
Throws:
SmApiException

getUserDirSearchOrder

public SmApiResult getUserDirSearchOrder(java.lang.String szDomainName,
                                         java.util.Vector DirectoryNames)
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Retrieves the search order of user directories for a domain.

Specified by:
getUserDirSearchOrder in interface SmPolicyApi
Parameters:
szDomainName - The domain being searched.
DirectoryNames - This Vector will be populated with the list of user directory names. The order of search is determined by the element position of the Vector.
Returns:
The result of the request.
Throws:
SmApiException

setUserDirSearchOrder

public SmApiResult setUserDirSearchOrder(java.lang.String szDomainName,
                                         java.util.Vector DirectoryNames)
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Sets the search order of user directories for a domain.

Specified by:
setUserDirSearchOrder in interface SmPolicyApi
Parameters:
szDomainName - The domain being searched.
DirectoryNames - The list of user directory names. The order of search is determined by the element position of the Vector.
Returns:
The result of the request.
Throws:
SmApiException

getDirectoryContents

public SmApiResult getDirectoryContents(java.lang.String userDirName,
                                        java.util.Hashtable enumerateResult)
                                 throws SmApiException
Description copied from interface: SmPolicyApi
Enumerates a user directory.

Specified by:
getDirectoryContents in interface SmPolicyApi
Parameters:
userDirName - The user directory to enumerate.
enumerateResult - The list of distinguished names (DN) and classes in the directory. The Hashtable key will hold the DN, and the corresponding value will hold the class.
Returns:
The result of the request.
Throws:
SmApiException

lookupDirectory

public SmApiResult lookupDirectory(java.lang.String userDirName,
                                   java.lang.String searchPattern,
                                   java.util.Hashtable lookupResult)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Performs a user directory lookup.

The value of the searchPattern parameter is determined by the directory namespace:


Specified by:
lookupDirectory in interface SmPolicyApi
Parameters:
userDirName - The user directory to search.
searchPattern - The search pattern.
Returns:
The result of the request.
Throws:
SmApiException

getUserGroups

public SmApiResult getUserGroups(SmObjId dirOid,
                                 java.lang.String userDn,
                                 boolean recursive,
                                 java.util.Vector groups)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Returns a list of groups that a user is a member of.

Specified by:
getUserGroups in interface SmPolicyApi
Parameters:
dirOid - The user's directory OID.
userDn - The user's distinguished name.
recursive - Specifies whether to search for groups recursively.
groups - Output parameter for returned groups.
Returns:
The result of the request.
Throws:
SmApiException

getUserContext

public SmApiResult getUserContext(SmObjId dirOid,
                                  java.lang.String userDn,
                                  java.lang.String sessionId,
                                  SmUserContext userContext)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Returns contextual information of a given user.

Specified by:
getUserContext in interface SmPolicyApi
Parameters:
dirOid - The user's directory OID.
userDn - The user's distinguished name.
sessionId - The A unique identifier of the session. After a successful login, the session ID can be extracted from the spec member of the SessionDef class instance. If the session ID is not known, assign null to this parameter.
userContext - The user's context SmUserContext
Returns:
The result of the request.
Throws:
SmApiException

addRootConfig

public SmApiResult addRootConfig(SmRootConfig rootConfig)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Creates a root configuration.

Specified by:
addRootConfig in interface SmPolicyApi
Parameters:
rootConfig - The root configuration to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyRootConfig

public SmApiResult modifyRootConfig(SmRootConfig rootConfig)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a root configuration.

Specified by:
modifyRootConfig in interface SmPolicyApi
Parameters:
rootConfig - The root configuration to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteRootConfig

public SmApiResult deleteRootConfig(SmObjId rootConfigId)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a root configuration.

Specified by:
deleteRootConfig in interface SmPolicyApi
Parameters:
rootConfigId - The object identifier of the root configuration to delete.
Returns:
The result of the request.
Throws:
SmApiException

getRootConfig

public SmApiResult getRootConfig(SmObjId rootConfigId,
                                 SmRootConfig rootConfig)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Gets the root configuration.

Specified by:
getRootConfig in interface SmPolicyApi
Parameters:
rootConfigId - The object identifier of the root configuration to retrieve.
rootConfig - This object will be populated with the properties of the root configuration.
Returns:
result of the request.
Throws:
SmApiException

addAgent

public SmApiResult addAgent(SmAgent Agent)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Creates an Agent object.

Specified by:
addAgent in interface SmPolicyApi
Parameters:
Agent - The Agent object to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyAgent

public SmApiResult modifyAgent(SmAgent Agent)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an Agent object.

Specified by:
modifyAgent in interface SmPolicyApi
Parameters:
Agent - The Agent object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteAgent

public SmApiResult deleteAgent(java.lang.String szAgentName)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an Agent object.
Note: You cannot delete an Agent object if that Agent object is configured as a part of the resource information in a realm.

Specified by:
deleteAgent in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

getAgent

public SmApiResult getAgent(java.lang.String szAgentName,
                            SmAgent Agent)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an Agent object.

Specified by:
getAgent in interface SmPolicyApi
Parameters:
szAgentName - The Agent object name.
Agent - An object that will be populated with the properties of the Agent object.
Returns:
The result of the request.
Throws:
SmApiException

addAgentType

public SmApiResult addAgentType(SmAgentType agentType)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Creates an AgentType object.

Specified by:
addAgentType in interface SmPolicyApi
Parameters:
agentType - The AgentType object to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyAgentType

public SmApiResult modifyAgentType(SmAgentType agentType)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an AgentType object.

Specified by:
modifyAgentType in interface SmPolicyApi
Parameters:
agentType - The AgentType object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteAgentType

public SmApiResult deleteAgentType(java.lang.String szAgentTypeName)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an AgentType object.

Specified by:
deleteAgentType in interface SmPolicyApi
Parameters:
szAgentTypeName - The AgentType object to delete.
Returns:
The result of the request.
Throws:
SmApiException

getAgentType

public SmApiResult getAgentType(java.lang.String szAgentTypeName,
                                SmAgentType agentType)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an Agent Type object.

Specified by:
getAgentType in interface SmPolicyApi
Parameters:
szAgentTypeName - The Agent Type object name.
agentType - An object that will be populated with the properties of AgentType object.
Returns:
The result of the request.
Throws:
SmApiException

addAgentTypeAttr

public SmApiResult addAgentTypeAttr(SmAgentTypeAttr agentTypeAttr)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Creates an AgentTypeAttr object.

Specified by:
addAgentTypeAttr in interface SmPolicyApi
Parameters:
agentTypeAttr - The AgentTypeAttr object to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyAgentTypeAttr

public SmApiResult modifyAgentTypeAttr(SmAgentTypeAttr agentTypeAttr)
                                throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an AgentTypeAttr object.

Specified by:
modifyAgentTypeAttr in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

deleteAgentTypeAttr

public SmApiResult deleteAgentTypeAttr(java.lang.String szAgentTypeAttrName)
                                throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an AgentTypeAttr object.

Specified by:
deleteAgentTypeAttr in interface SmPolicyApi
Parameters:
szAgentTypeAttrName - Name of AgentTypeAttr object to delete.
Returns:
The result of the request.
Throws:
SmApiException

getAgentTypeAttrs

public SmApiResult getAgentTypeAttrs(java.lang.String szAgentTypeName,
                                     java.util.Vector agentTypeAttrs)
                              throws SmApiException
Description copied from interface: SmPolicyApi
Gets the Oids of all AgentTypeAttr objects of the specified Agent Type

Specified by:
getAgentTypeAttrs in interface SmPolicyApi
Parameters:
szAgentTypeName - Name of Agent Type whose Attributes are to be retrieved
agentTypeAttrs - Vector receiving Oids of Agent Type Attributes. attributes of the Agent Type object.
Returns:
The result of the request.
Throws:
SmApiException

getAgentTypeAttr

public SmApiResult getAgentTypeAttr(java.lang.String szAgentTypeAttr,
                                    SmAgentTypeAttr AgentTypeAttr)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an Agent Type object.

Specified by:
getAgentTypeAttr in interface SmPolicyApi
Parameters:
szAgentTypeAttr - The Agent Type object name.
AgentTypeAttr - An object that will be populated with the attributes of the Agent Type object.
Returns:
The result of the request.
Throws:
SmApiException

addAgentConfig

public SmApiResult addAgentConfig(SmAgentConfig AgentConfig)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Creates an Agent Configuration object.

Specified by:
addAgentConfig in interface SmPolicyApi
Parameters:
AgentConfig - The Agent Configuration object to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyAgentConfig

public SmApiResult modifyAgentConfig(SmAgentConfig AgentConfig)
                              throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an Agent Configuration object.

Specified by:
modifyAgentConfig in interface SmPolicyApi
Parameters:
AgentConfig - The Agent Configuration object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteAgentConfig

public SmApiResult deleteAgentConfig(java.lang.String szAgentConfigName)
                              throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an Agent Configuration object.

Specified by:
deleteAgentConfig in interface SmPolicyApi
Parameters:
szAgentConfigName - The Agent Configuration object to delete.
Returns:
The result of the request.
Throws:
SmApiException

getAgentConfig

public SmApiResult getAgentConfig(java.lang.String szAgentConfigName,
                                  SmAgentConfig AgentConfig)
                           throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an Agent Configuration object.

Specified by:
getAgentConfig in interface SmPolicyApi
Parameters:
szAgentConfigName - The Agent Configuration object name.
AgentConfig - An object that will be populated with the properties of the Agent Configuration object.
Returns:
The result of the request.
Throws:
SmApiException

addHostConfig

public SmApiResult addHostConfig(SmHostConfig HostConfig)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Creates a Host Configuration object.

Specified by:
addHostConfig in interface SmPolicyApi
Parameters:
HostConfig - The Host Configuration object to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyHostConfig

public SmApiResult modifyHostConfig(SmHostConfig HostConfig)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a Host Configuration object.

Specified by:
modifyHostConfig in interface SmPolicyApi
Parameters:
HostConfig - The Host Configuration object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteHostConfig

public SmApiResult deleteHostConfig(java.lang.String szHostConfigName)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a Host Configuration object.

Specified by:
deleteHostConfig in interface SmPolicyApi
Parameters:
szHostConfigName - The Host Configuration object to delete.
Returns:
The result of the request.
Throws:
SmApiException

getHostConfig

public SmApiResult getHostConfig(java.lang.String szHostConfigName,
                                 SmHostConfig HostConfig)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a Host Configuration object.

Specified by:
getHostConfig in interface SmPolicyApi
Parameters:
szHostConfigName - The Host Configuration object name.
HostConfig - An object that will be populated with the properties of the Host Configuration object.
Returns:
The result of the request.
Throws:
SmApiException

addTrustedHost

public SmApiResult addTrustedHost(SmTrustedHost TrustedHost)
                           throws SmApiException,
                                  java.io.IOException,
                                  java.lang.InterruptedException
Description copied from interface: SmPolicyApi
Registers a trusted host with the Policy Server. Use this function to register the client as trusted host. After registration is complete, the registration tool creates the SmHost.conf file on the client and a corresponding Trusted Host object on the Policy Server.

Specified by:
addTrustedHost in interface SmPolicyApi
Parameters:
TrustedHost - The Trusted Host object to create.
Returns:
The result of the request.
Throws:
SmApiException
java.io.IOException
java.lang.InterruptedException

deleteTrustedHost

public SmApiResult deleteTrustedHost(java.lang.String szTrustedHostName)
                              throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a Trusted Host object.

Specified by:
deleteTrustedHost in interface SmPolicyApi
Parameters:
szTrustedHostName - The Trusted Host object to delete.
Returns:
The result of the request.
Throws:
SmApiException

addDomain

public SmApiResult addDomain(SmDomain Domain)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Creates a domain.

Specified by:
addDomain in interface SmPolicyApi
Parameters:
Domain - The domain to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyDomain

public SmApiResult modifyDomain(SmDomain Domain)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a domain.

Specified by:
modifyDomain in interface SmPolicyApi
Parameters:
Domain - The domain to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteDomain

public SmApiResult deleteDomain(java.lang.String szDomainName)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a domain.
Note: Also deletes the domain's children (rules, responses, realms, policies).

Specified by:
deleteDomain in interface SmPolicyApi
Parameters:
szDomainName - The domain to delete.
Returns:
The result of the request.
Throws:
SmApiException

getDomain

public SmApiResult getDomain(java.lang.String szDomainName,
                             SmDomain Domain)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a domain object.

Specified by:
getDomain in interface SmPolicyApi
Parameters:
szDomainName - The name of the domain.
Domain - This object will be populated with the properties of the domain.
Returns:
The result of the request.
Throws:
SmApiException

addScheme

public SmApiResult addScheme(SmScheme Scheme)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Creates an authentication scheme.

Specified by:
addScheme in interface SmPolicyApi
Parameters:
Scheme - The authentication scheme to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyScheme

public SmApiResult modifyScheme(SmScheme Scheme)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an authentication scheme.

Specified by:
modifyScheme in interface SmPolicyApi
Parameters:
Scheme - The authentication scheme to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteScheme

public SmApiResult deleteScheme(java.lang.String szSchemeName)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an authentication scheme.

Specified by:
deleteScheme in interface SmPolicyApi
Parameters:
szSchemeName - The authentication scheme to delete.
Returns:
The result of the request.
Throws:
SmApiException

getScheme

public SmApiResult getScheme(java.lang.String szSchemeName,
                             SmScheme Scheme)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an authentication scheme.

Specified by:
getScheme in interface SmPolicyApi
Parameters:
szSchemeName - The authentication scheme to retrieve.
Scheme - This object will be populated with the properties of the authentication scheme.
Returns:
The result of the request.
Throws:
SmApiException

addPasswordPolicy

public SmApiResult addPasswordPolicy(SmPasswordPolicy passwordPolicy)
                              throws SmApiException
Description copied from interface: SmPolicyApi
Creates a password policy.

Specified by:
addPasswordPolicy in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

modifyPasswordPolicy

public SmApiResult modifyPasswordPolicy(SmPasswordPolicy passwordPolicy)
                                 throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a password policy.

Specified by:
modifyPasswordPolicy in interface SmPolicyApi
Parameters:
passwordPolicy - The password policy to modify.
Returns:
The result of the request.
Throws:
SmApiException

deletePasswordPolicy

public SmApiResult deletePasswordPolicy(java.lang.String szPasswordPolicy)
                                 throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a password policy.

Specified by:
deletePasswordPolicy in interface SmPolicyApi
Parameters:
szPasswordPolicy - The password policy to delete.
Returns:
The result of the request.
Throws:
SmApiException

getPasswordPolicy

public SmApiResult getPasswordPolicy(java.lang.String szPasswordPolicy,
                                     SmPasswordPolicy passwordPolicy)
                              throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a password policy.

Specified by:
getPasswordPolicy in interface SmPolicyApi
Parameters:
szPasswordPolicy - The password policy to retrieve.
passwordPolicy - This object will be populated with the properties of the password policy.
Returns:
The result of the request.
Throws:
SmApiException

addRegularExpressionToPasswordPolicy

public SmApiResult addRegularExpressionToPasswordPolicy(SmPwdPolicyRegularExpression regEx)
                                                 throws SmApiException
Description copied from interface: SmPolicyApi
Adds the regular expression to password policy.

Specified by:
addRegularExpressionToPasswordPolicy in interface SmPolicyApi
Returns:
The result of the request
Throws:
SmApiException

removeRegularExpressionFromPasswordPolicy

public SmApiResult removeRegularExpressionFromPasswordPolicy(SmPwdPolicyRegularExpression regEx)
                                                      throws SmApiException
Description copied from interface: SmPolicyApi
Removes the regular expression from password policy.

Specified by:
removeRegularExpressionFromPasswordPolicy in interface SmPolicyApi
Parameters:
regEx - The regular expression object to remove
Returns:
The result of the request.
Throws:
SmApiException

getRegularExpressions

public SmApiResult getRegularExpressions(java.lang.String passwordPolicyName,
                                         java.util.Vector regExps)
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Gets the list of regular expression for a password policy object.

Specified by:
getRegularExpressions in interface SmPolicyApi
Parameters:
passwordPolicyName - The password policy whose regular expressions are retrieved.
regExps - This vector will be populated with the list of regular expressions.
Returns:
The result of the request.
Throws:
SmApiException

getUserState

public SmApiResult getUserState(SmObjId userDirOid,
                                java.lang.String userDn,
                                SmUserPasswordState userState)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Gets the user state as enable/disable with the disabled reason for the disabled state, if disabled.

Specified by:
getUserState in interface SmPolicyApi
Parameters:
userDirOid - User Directory object identifier
userDn - User Distiniguished name
userState - This object will be populated with User state.
Returns:
The result of the request.
Throws:
SmApiException

setUserState

public SmApiResult setUserState(SmObjId userDirOid,
                                java.lang.String userDn,
                                SmUserPasswordState userState)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Sets the user state as enable/disable with the disabled reason for the state, if state is disabled.

Specified by:
setUserState in interface SmPolicyApi
Parameters:
userDirOid - User Directory object identfier.
userDn - User Distinguished name.
userState - This object sets the user state using its property.
Returns:
The result of the request.
Throws:
SmApiException

getPasswordState

public SmApiResult getPasswordState(SmObjId userDirOid,
                                    java.lang.String userDn,
                                    SmUserPasswordState passwordState)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Gets the password state of the user which includes login failures, disabled time, last login time, last password change and previous login time.

Specified by:
getPasswordState in interface SmPolicyApi
Parameters:
userDirOid - User directory object identifier.
userDn - User distinguished name
passwordState - The object that will be poulated with the password state.
Returns:
The result of the request.
Throws:
SmApiException

setPasswordState

public SmApiResult setPasswordState(SmObjId userDirOid,
                                    java.lang.String userDn,
                                    SmUserPasswordState passwordState)
                             throws SmApiException
Description copied from interface: SmPolicyApi
This function sets the password state of the user which includes login failures, disabled time, last login time, empty password history, last password change and previous login time.

Specified by:
setPasswordState in interface SmPolicyApi
Parameters:
userDirOid - User directory object identifier.
userDn - User distinguished name.
passwordState - This object sets the password state using its properties.
Returns:
The result of the request.
Throws:
SmApiException

addSelfReg

public SmApiResult addSelfReg(SmSelfReg SelfReg)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Creates a self-registration object.

Specified by:
addSelfReg in interface SmPolicyApi
Parameters:
SelfReg - The self-registration object to create.
Returns:
The result of the request.
Throws:
SmApiException

modifySelfReg

public SmApiResult modifySelfReg(SmSelfReg SelfReg)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a self-registration object.

Specified by:
modifySelfReg in interface SmPolicyApi
Parameters:
SelfReg - The self-registration object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteSelfReg

public SmApiResult deleteSelfReg(java.lang.String szSelfRegName)
                          throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a self-registration object.

Specified by:
deleteSelfReg in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

getSelfReg

public SmApiResult getSelfReg(java.lang.String szSelfRegName,
                              SmSelfReg SelfReg)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a self-registration object.

Specified by:
getSelfReg in interface SmPolicyApi
Parameters:
szSelfRegName - The self-registration object to retrieve.
SelfReg - This object will be populated with the properties of the self-registration object.
Returns:
The result of the request.
Throws:
SmApiException

addAdmin

public SmApiResult addAdmin(SmAdmin Admin)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Creates a SiteMinder Administrator.

Specified by:
addAdmin in interface SmPolicyApi
Parameters:
Admin - The SiteMinder Administrator to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyAdmin

public SmApiResult modifyAdmin(SmAdmin Admin)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a SiteMinder Administrator.

Specified by:
modifyAdmin in interface SmPolicyApi
Parameters:
Admin - The SiteMinder Administrator to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteAdmin

public SmApiResult deleteAdmin(java.lang.String szAdminName)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a SiteMinder Administrator.

Specified by:
deleteAdmin in interface SmPolicyApi
Parameters:
szAdminName - The SiteMinder Administrator to delete.
Returns:
The result of the request.
Throws:
SmApiException

getAdmin

public SmApiResult getAdmin(java.lang.String szAdminName,
                            SmAdmin Admin)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a SiteMinder Administrator.

Specified by:
getAdmin in interface SmPolicyApi
Parameters:
szAdminName - The SiteMinder Administrator to retrieve.
Admin - This object will be populated with the properties of the SiteMinder Administrator.
Returns:
The result of the request.
Throws:
SmApiException

addAdminToDomain

public SmApiResult addAdminToDomain(java.lang.String szAdminName,
                                    java.lang.String szDomainName)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Associates a SiteMinder Administrator with a domain.

Specified by:
addAdminToDomain in interface SmPolicyApi
Parameters:
szAdminName - The SiteMinder Administrator to associate with a domain.
szDomainName - The domain to associate with the SiteMinder Administrator.
Returns:
The result of the request.
Throws:
SmApiException

removeAdminFromDomain

public SmApiResult removeAdminFromDomain(java.lang.String szAdminName,
                                         java.lang.String szDomainName)
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Disassociates a user directory from a domain.

Specified by:
removeAdminFromDomain in interface SmPolicyApi
Parameters:
szAdminName - The SiteMinder Administrator to disassociate from the domain.
szDomainName - The domain to disassociate from the SiteMinder Administrator.
Returns:
The result of the request.
Throws:
SmApiException

getAdminUserDirs

public SmApiResult getAdminUserDirs(java.lang.String adminName,
                                    java.util.Vector userDirs)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of user directories that an administrator can manage.

Specified by:
getAdminUserDirs in interface SmPolicyApi
Parameters:
adminName - Distinguished name of the administrator.
userDirs - This Vector will be populated with the list of user directory names (String).
Throws:
SmApiException

getAdminDomains

public SmApiResult getAdminDomains(java.lang.String szAdminName,
                                   java.util.Vector adminDomains)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Gets the all UserDirectory which is added by Domain of the Administrator object

Specified by:
getAdminDomains in interface SmPolicyApi
Parameters:
szAdminName - Name of Admin whose UserDirectory are to be retrived
adminDomains - Vector receving UserDirectory Admin Domain Attributes. attributes of the Admin object.
Returns:
The result of the request.
Throws:
SmApiException

getDomainObjectNames

public SmApiResult getDomainObjectNames(java.lang.String propName,
                                        java.lang.String domainName,
                                        java.util.Vector ObjectNames)
                                 throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of domain objects within a domain.

Specified by:
getDomainObjectNames in interface SmPolicyApi
Parameters:
propName - Property name of the domain object.
domainName - Name or object identifier of the SiteMinder domain object.
ObjectNames - This Vector will be populated with the retrieved list of domain objects.
Returns:
The result of the request.
Throws:
SmApiException

getGlobalObjectNames

public SmApiResult getGlobalObjectNames(java.lang.String szPropName,
                                        java.util.Vector ObjectNames)
                                 throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of global objects.

Specified by:
getGlobalObjectNames in interface SmPolicyApi
Parameters:
szPropName - Property name of the global object.
ObjectNames - This Vector will be populated with the retrieved list of global objects.
Returns:
The result of the request.
Throws:
SmApiException

addGroup

public SmApiResult addGroup(java.lang.String szDomainName,
                            SmObject group)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Creates a new group of any type (rule, response, agent).

Specified by:
addGroup in interface SmPolicyApi
Parameters:
szDomainName - The domain that contains the group to create. For agent groups, this parameter will be empty.
group - The group object to create.
Returns:
The result of the request.
Throws:
SmApiException

modifyGroup

public SmApiResult modifyGroup(java.lang.String szDomainName,
                               SmObject group)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Modifies a group of any type (rule, response, agent).

Specified by:
modifyGroup in interface SmPolicyApi
Parameters:
szDomainName - The domain that contains the group to create. For agent groups, this parameter will be empty.
group - The group object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteGroup

public SmApiResult deleteGroup(int groupType,
                               java.lang.String szGroupName,
                               java.lang.String szDomainName)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Deletes a group of any type (rule, response, agent).

Specified by:
deleteGroup in interface SmPolicyApi
Parameters:
groupType - The type of the group to delete.
szGroupName - Name of the group to delete.
szDomainName - The domain where the group is located. For agent groups, this name will be empty.
Returns:
The result of the request.
Throws:
SmApiException

getGroup

public SmApiResult getGroup(java.lang.String szGroupName,
                            java.lang.String szDomainName,
                            SmObject Group)
                     throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of a group of any type (rule, response, agent).

Specified by:
getGroup in interface SmPolicyApi
Parameters:
szGroupName - Name of the group to retrieve.
szDomainName - The domain where the group is located. For agent groups, this name will be empty.
Group - This object will be populated with the properties of the group object.
Returns:
The result of the request.
Throws:
SmApiException

getGroupMembers

public SmApiResult getGroupMembers(int groupType,
                                   java.lang.String szGroupName,
                                   java.lang.String szDomainName,
                                   java.util.Vector Names)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of groups of any type (rule, response, and agent).

Specified by:
getGroupMembers in interface SmPolicyApi
Parameters:
groupType - One of the group types specified in SmGroup.
szGroupName - The group to retrieve.
szDomainName - The domain where the group is located. For agent groups, this name will be empty.
Names - This Vector will be populated with the list of group members.
Returns:
The result of the request.
Throws:
SmApiException

addToGroup

public SmApiResult addToGroup(int groupType,
                              java.lang.String szItemName,
                              java.lang.String szGroupName,
                              java.lang.String szDomainName)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Adds a group member of any type (rule, response, agent) to the specified group.

Specified by:
addToGroup in interface SmPolicyApi
Parameters:
groupType - One of the group types specified in SmGroup.
szItemName - The member to add to the group. The member being added must be of the same type as the group.
szGroupName - The group to contain the new member.
szDomainName - The domain where the group is located. For agent groups, this name will be empty.
Returns:
The result of the request.
Throws:
SmApiException

removeFromGroup

public SmApiResult removeFromGroup(int groupType,
                                   java.lang.String szItemName,
                                   java.lang.String szGroupName,
                                   java.lang.String szDomainName)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Removes a group member of any type (rule, response, agent) from the specified group.

Specified by:
removeFromGroup in interface SmPolicyApi
Parameters:
groupType - One of the group types specified in SmGroup.
szItemName - The member to be removed from the group.
szGroupName - The group where the item is currently a member.
szDomainName - The domain where the group is located. For agent groups, this name will be empty.
Returns:
The result of the request.
Throws:
SmApiException

flushAll

public SmApiResult flushAll()
                     throws SmApiException
Description copied from interface: SmPolicyApi
Flushes all SiteMinder caches. This method flushes policy store cache, resource cache, and user information cache.

Specified by:
flushAll in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

holdUpdatesNotificationsProcessing

public SmApiResult holdUpdatesNotificationsProcessing()
                                               throws SmApiException
Description copied from interface: SmPolicyApi
Disable all SiteMinder cache updates This method disnables cache updates.

Specified by:
holdUpdatesNotificationsProcessing in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

resumeUpdatesNotificationsProcessing

public SmApiResult resumeUpdatesNotificationsProcessing()
                                                 throws SmApiException
Description copied from interface: SmPolicyApi
Enable all SiteMinder cache updates This method enables cache updates.

Specified by:
resumeUpdatesNotificationsProcessing in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

isUpdatesNotificationsProcessingOnHold

public SmApiResult isUpdatesNotificationsProcessingOnHold(NotificationProcessingStatus processingOnHold)
                                                   throws SmApiException
Description copied from interface: SmPolicyApi
Show all Siteminder cache updates status This method Shows cache update status.

Specified by:
isUpdatesNotificationsProcessingOnHold in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

flushUsers

public SmApiResult flushUsers()
                       throws SmApiException
Description copied from interface: SmPolicyApi
Flushs the user information cache.

Specified by:
flushUsers in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

flushUser

public SmApiResult flushUser(java.lang.String userDirectory,
                             java.lang.String userDn)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Flushes a user from the user information cache.

Specified by:
flushUser in interface SmPolicyApi
Parameters:
userDirectory - The user directory where the user is located.
userDn - Distinguished name of the user being flushed.
Returns:
The result of the request.
Throws:
SmApiException

flushRealms

public SmApiResult flushRealms()
                        throws SmApiException
Description copied from interface: SmPolicyApi
Flushes all realms from the resource cache.

Specified by:
flushRealms in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

flushRealm

public SmApiResult flushRealm(java.lang.String realmOid)
                       throws SmApiException
Description copied from interface: SmPolicyApi
Flushes a realm from the resource cache.

Specified by:
flushRealm in interface SmPolicyApi
Parameters:
realmOid - Object identifier of the realm being flushed.
Returns:
The result of the request.
Throws:
SmApiException

changeDynamicKey

public SmApiResult changeDynamicKey()
                             throws SmApiException
Description copied from interface: SmPolicyApi
Changes a dynamic encryption key.

Before you change a dynamic key through the Java API, the Agent Key setting in the Policy Server Key Management dialog box must be set to Use dynamic Agent Key. To access this dialog box in the Policy Server UI, click Tools > Manage Keys. Then, in the Agent Key tab, select Use dynamic Agent Key.

Specified by:
changeDynamicKey in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

changePersistentKey

public SmApiResult changePersistentKey(java.lang.String persistentKey)
                                throws SmApiException
Description copied from interface: SmPolicyApi
Changes a persistent encryption key.

Specified by:
changePersistentKey in interface SmPolicyApi
Parameters:
persistentKey - The persistent key to change. If persistentKey is empty, the persistent key is randomly generated.
Returns:
The result of the request.
Throws:
SmApiException

changeSessionKey

public SmApiResult changeSessionKey(java.lang.String sessionKey)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Changes a session encryption key.

Specified by:
changeSessionKey in interface SmPolicyApi
Parameters:
sessionKey - The session key to change. If sessionKey is empty, the session key is randomly generated.
Returns:
The result of the request.
Throws:
SmApiException

changeSharedSecretKey

public SmApiResult changeSharedSecretKey()
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Changes a shared secret encryption key. The shared Secret key is randomly generated.

Specified by:
changeSharedSecretKey in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException

getRealmUserPolicies

public SmApiResult getRealmUserPolicies(java.lang.String realmOID,
                                        java.util.Vector UserPolicyOIDs)
                                 throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of user policies that can access a realm.

Specified by:
getRealmUserPolicies in interface SmPolicyApi
Parameters:
realmOID - Object identifier of the realm.
UserPolicyOIDs - This Vector of Strings will be populated with the list of user policy object identifiers that a user can access.
Returns:
The result of the request.
Throws:
SmApiException

getDomainObject

public SmApiResult getDomainObject(java.lang.String szObjName,
                                   java.lang.String szDomainName,
                                   SmDomainObject obj)
                            throws SmApiException
Description copied from interface: SmPolicyApi
Gets a domain object by name or object identifier (OID).

Specified by:
getDomainObject in interface SmPolicyApi
szDomainName - Name or object identifier of the SiteMinder domain object.
obj - This object will be populated with the retrieved object.
Returns:
The result of the request.
Throws:
SmApiException

getObject

public SmApiResult getObject(java.lang.String szObjName,
                             SmObject obj)
                      throws SmApiException
Description copied from interface: SmPolicyApi
Gets a global object by name or object identifier (OID).

Specified by:
getObject in interface SmPolicyApi
Parameters:
szObjName - Name or object identifier of the SiteMinder global object.
obj - This object will be populated with the retrieved object.
Returns:
The result of the request.
Throws:
SmApiException

getConfigObject

public SmApiResult getConfigObject(java.lang.String szObjName,
                                   SmObject obj)
                            throws SmApiException
Throws:
SmApiException

renameObject

public SmApiResult renameObject(SmObjId objId,
                                java.lang.String newName)
                         throws SmApiException
Description copied from interface: SmPolicyApi
Renames an object. You can only rename objects that have a name property.

Specified by:
renameObject in interface SmPolicyApi
Parameters:
objId - Object identifier of the object being renamed.
newName - The new name for the object.
Returns:
The result of the API request.
Throws:
SmApiException

getVersion

public int getVersion()

Gets the Policy API version compliance level.

Specified by:
getVersion in interface SmPolicyApi
Returns:
The Policy API version compliance level.

doExport

public SmApiResult doExport(SmExportAttr objExportAttr)
                     throws SmApiException
Description copied from interface: SmPolicyApi

Exports policy data from a remote Policy Server.

doExport() exports an entire policy store or a single policy domain from a remote policy server and writes the output .smdif and .config files on the client’s local file system.

Functionally, the policy data export behaves in the same manner as the smobjexport utility. For more information about this tool, see the Policy Server Installation Guide.

Exported policy data is returned over the tunnel connection in 20kb chunks and written to the local files specified by smExportAttr.setFileName() or, if that method is not called, to stdout.smdif and stdout.cfg. doExport() manages data transfer over the tunnel connection until completion. However, it will not resume transfer after a connection failure.

Specified by:
doExport in interface SmPolicyApi
Parameters:
objExportAttr - Policy data export attributes.
Returns:
The result of the API request.
Throws:
SmApiException

doImport

public SmApiResult doImport(SmImportAttr objImportAttr)
                     throws SmApiException
Description copied from interface: SmPolicyApi

Imports policy data stored on a local client into remote Policy Server.

doImport() imports an entire policy store or a single policy domain from .smdif and .config files on the client’s local file system onto a remote policy server.

Functionally, the policy data import behaves in the same manner as the smobjimport utility). For more information about this tool, see the CA eTrust SiteMinder Policy Server Installation Guide.

Policy data to be imported is sent over the tunnel connection in 20kb chunks from the local files specified by smImportAttr.setFileName(). doImport() manages data transfer over the tunnel connection until completion. However, it will not resume transfer after a connection failure.

Specified by:
doImport in interface SmPolicyApi
Parameters:
objImportAttr - Policy data import attributes.
Returns:
The result of the API request.
Throws:
SmApiException

getPolicyStoreVersion

public SmApiResult getPolicyStoreVersion(java.lang.StringBuffer majorVersion,
                                         java.lang.StringBuffer minorVersion,
                                         java.lang.StringBuffer mode)
                                  throws SmApiException
Specified by:
getPolicyStoreVersion in interface SmPolicyApi
Throws:
SmApiException

addAuthValidateMap

public SmApiResult addAuthValidateMap(SmAuthValidateMap authValidateMap)
                               throws SmApiException
Description copied from interface: SmPolicyApi
Adds an authentication and validation directory mapping object.

Specified by:
addAuthValidateMap in interface SmPolicyApi
Parameters:
authValidateMap - The authentication and validation mapping object to add.
Returns:
The result of the request.
Throws:
SmApiException

modifyAuthValidateMap

public SmApiResult modifyAuthValidateMap(SmAuthValidateMap authValidateMap)
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an authentication and validation directory mapping object.

Specified by:
modifyAuthValidateMap in interface SmPolicyApi
Parameters:
authValidateMap - The authentication and validation mapping object to modify.
Returns:
The result of the request.
Throws:
SmApiException

deleteAuthValidateMap

public SmApiResult deleteAuthValidateMap(SmObjId authValidateMapOid)
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Deletes an authentication and validation directory mapping object.

Specified by:
deleteAuthValidateMap in interface SmPolicyApi
Parameters:
authValidateMapOid - Object identifier of the authentication and validation mapping object to delete.
Returns:
The result of the request.
Throws:
SmApiException

getAuthValidateMap

public SmApiResult getAuthValidateMap(SmObjId authValidateMapOid,
                                      SmAuthValidateMap authValidateMap)
                               throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an authentication and validation directory mapping object.

Specified by:
getAuthValidateMap in interface SmPolicyApi
Parameters:
authValidateMapOid - The object identifier of the authentication and validation mapping object to retreive.
authValidateMap - This object will be populated with the retrieved object.
Returns:
The result of the request.
Throws:
SmApiException

getChildren

public SmApiResult getChildren(java.lang.String szOid,
                               java.util.Vector Children)
                        throws SmApiException
Description copied from interface: SmPolicyApi
Gets a list of OIDs of realms under a domain or gets the list of rules and realms under a realm

Specified by:
getChildren in interface SmPolicyApi
Children - - This object will be populated with the list of OIDs a) With top level realms, if the OID is of a domain b) With top level realms and rules OIDs if the OID passed is of a realm.
Returns:
The result of the request.
Throws:
SmApiException

IsGroup

public boolean IsGroup(java.lang.String szOid)
                throws SmApiException
Description copied from interface: SmPolicyApi
Returns whether the OID passed is of an group or not. i.e. rulegroup, responsegroup or agent group

Specified by:
IsGroup in interface SmPolicyApi
Returns:
true if the object is a group and false otherwise.
Throws:
SmApiException

getSharedSecretPolicy

public SmApiResult getSharedSecretPolicy(java.lang.String szOid,
                                         SmSharedSecretPolicy sharedSecretPolicy)
                                  throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an SmSharedSecretPolicy object.

Specified by:
getSharedSecretPolicy in interface SmPolicyApi
Parameters:
szOid - The Object Identifier of the Shared Secret Policy Object
sharedSecretPolicy - An object that will be populated with the properties of the SmSharedSecretPolicy object.
Returns:
The result of the request.
Throws:
SmApiException

modifySharedSecretPolicy

public SmApiResult modifySharedSecretPolicy(SmSharedSecretPolicy sharedSecretPolicy)
                                     throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an SharedSecretPolicy object.

Specified by:
modifySharedSecretPolicy in interface SmPolicyApi
Parameters:
sharedSecretPolicy - The SharedSecretPolicy object to modify.
Returns:
The result of the request.
Throws:
SmApiException

getKeyManagement

public SmApiResult getKeyManagement(java.lang.String szOid,
                                    SmKeyManagement keyManagement)
                             throws SmApiException
Description copied from interface: SmPolicyApi
Gets the contents of an SmKeyManagement object.

Specified by:
getKeyManagement in interface SmPolicyApi
Parameters:
szOid - The Object Identifier of the KeyManagement Object
Returns:
The result of the request.
Throws:
SmApiException

modifyKeyManagement

public SmApiResult modifyKeyManagement(SmKeyManagement keyManagement)
                                throws SmApiException
Description copied from interface: SmPolicyApi
Modifies an SmKeyManagement object.

Specified by:
modifyKeyManagement in interface SmPolicyApi
Returns:
The result of the request.
Throws:
SmApiException
Overview  Package   Class  Tree  Deprecated  Index  Help 
SiteMinder
Java SDK r12.51
Mon 04/08/2013
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
http://ca.com
Copyright (c) 2013 CA.