SiteMinder
Java SDK r12.51


com.netegrity.sdk.policyapi
Class SmAuthValidateMap

java.lang.Object
  extended by com.netegrity.sdk.policyapi.SmObjectImpl
      extended by com.netegrity.sdk.policyapi.SmAuthValidateMap
All Implemented Interfaces:
SmObject, java.lang.Cloneable

public final class SmAuthValidateMap
extends SmObjectImpl

Represents a SiteMinder authentication and validation directory mapping object.

This object has global scope.

Since:
SDK SIGMA

Field Summary
static java.lang.String AUTHVALIDATE_MAPTYPE_DN
          Indicates that the type of directory mapping matches the user's distinguished name exactly from the authentication directory to the validation directory.
static java.lang.String AUTHVALIDATE_MAPTYPE_UNIVERSALID
          Indicates that the type of directory mapping matches the value of the Universal ID attribute exactly from the authentication directory to the validation directory.
static java.lang.String PropAuthDirName
          The object's authentication user directory name property.
static java.lang.String PropAuthValidateMaps
          Property name to be specified in the method getGlobalObjectNames().
static java.lang.String PropMapType
          The object's directory mapping type property.
static java.lang.String PropValidateDirOid
          The object's validation user directory property
 
Fields inherited from class com.netegrity.sdk.policyapi.SmObjectImpl
PropObjectClassName
 
Fields inherited from interface com.netegrity.sdk.policyapi.SmObject
ConfigurationClassName, PropDesc, PropName, PropOid
 
Constructor Summary
SmAuthValidateMap()
          Constructs an authentication and validation directory mapping object.
SmAuthValidateMap(java.lang.String oid)
          Constructs an authentication and validation directory mapping object with the specified object identifier.
 
Method Summary
 java.lang.String getAuthUserDir()
          Gets the authentication directory of the directory mapping.
 java.lang.String getAuthValidateType()
          Gets the authentication and validation directory mapping type.
 java.lang.String getDescription()
          Gets the description of the object.
 java.lang.String getName()
          Gets the name of the object.
 SmObjId getValidateUserDir()
          Gets the validation directory for the directory mapping.
 void readProperties(java.util.Hashtable properties)
          Copies the object properties from the specified hashtable.
 void setAuthUserDir(java.lang.String authUserDirName)
          Sets the authentication directory for the directory mapping.
 void setAuthValidateType(java.lang.String szAuthValidateMapType)
          Sets the authentication and validation directory mapping type.
 void setDescription(java.lang.String description)
          Authentication and validation directory mapping objects do not have a description property.
 void setName(java.lang.String name)
          Authentication and validation directory mapping objects do not have a name property.
 void setValidateUserDir(java.lang.Object validationUserDir)
          Sets the validation directory for the directory mapping.
 void writeProperties(java.util.Hashtable properties)
          Copies the object properties to the specified hashtable.
 
Methods inherited from class com.netegrity.sdk.policyapi.SmObjectImpl
getObjectClassname, getOid, isDomainObject, isWriteable, newObject, setObjectClassname, setOid, setOid, toString, writeSearchProperties
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PropAuthValidateMaps

public static final java.lang.String PropAuthValidateMaps
Property name to be specified in the method getGlobalObjectNames().

See Also:
Constant Field Values

PropAuthDirName

public static final java.lang.String PropAuthDirName
The object's authentication user directory name property.

See Also:
Constant Field Values

PropValidateDirOid

public static final java.lang.String PropValidateDirOid
The object's validation user directory property

See Also:
Constant Field Values

PropMapType

public static final java.lang.String PropMapType
The object's directory mapping type property.

See Also:
Constant Field Values

AUTHVALIDATE_MAPTYPE_DN

public static final java.lang.String AUTHVALIDATE_MAPTYPE_DN
Indicates that the type of directory mapping matches the user's distinguished name exactly from the authentication directory to the validation directory.

See Also:
Constant Field Values

AUTHVALIDATE_MAPTYPE_UNIVERSALID

public static final java.lang.String AUTHVALIDATE_MAPTYPE_UNIVERSALID
Indicates that the type of directory mapping matches the value of the Universal ID attribute exactly from the authentication directory to the validation directory.

See Also:
Constant Field Values
Constructor Detail

SmAuthValidateMap

public SmAuthValidateMap()
Constructs an authentication and validation directory mapping object.


SmAuthValidateMap

public SmAuthValidateMap(java.lang.String oid)
Constructs an authentication and validation directory mapping object with the specified object identifier.

Parameters:
oid - Object identifier of the directory mapping.
Method Detail

getName

public java.lang.String getName()
Gets the name of the object.

Specified by:
getName in interface SmObject
Overrides:
getName in class SmObjectImpl
Returns:
null

setName

public void setName(java.lang.String name)
Authentication and validation directory mapping objects do not have a name property. Calling this function sets the name of the object to null.

Specified by:
setName in interface SmObject
Overrides:
setName in class SmObjectImpl
Parameters:
name - The name of the object.

setDescription

public void setDescription(java.lang.String description)
Authentication and validation directory mapping objects do not have a description property. Calling this function sets the description of the object to null.

Specified by:
setDescription in interface SmObject
Overrides:
setDescription in class SmObjectImpl
Parameters:
description - The description of the object.

getDescription

public java.lang.String getDescription()
Gets the description of the object.

Specified by:
getDescription in interface SmObject
Overrides:
getDescription in class SmObjectImpl
Returns:
null

setAuthUserDir

public void setAuthUserDir(java.lang.String authUserDirName)
Sets the authentication directory for the directory mapping.

Parameters:
authUserDirectory - The object identifier of the authentication directory.

getAuthUserDir

public java.lang.String getAuthUserDir()
Gets the authentication directory of the directory mapping.

Returns:
The object identifier of the authentication directory.

setValidateUserDir

public void setValidateUserDir(java.lang.Object validationUserDir)
Sets the validation directory for the directory mapping.

Parameters:
validationUserDir - The object identifier of the authorization directory.

getValidateUserDir

public SmObjId getValidateUserDir()
Gets the validation directory for the directory mapping.

Returns:
The object identifier of the validation directory.

getAuthValidateType

public java.lang.String getAuthValidateType()
Gets the authentication and validation directory mapping type.

Returns:
The authentication and validation directory mapping type.

setAuthValidateType

public void setAuthValidateType(java.lang.String szAuthValidateMapType)
Sets the authentication and validation directory mapping type.

Parameters:
authValidateMapType - The authentication and validation directory mapping type.

writeProperties

public void writeProperties(java.util.Hashtable properties)
Description copied from interface: SmObject
Copies the object properties to the specified hashtable.

Specified by:
writeProperties in interface SmObject
Overrides:
writeProperties in class SmObjectImpl
Parameters:
properties - The hashtable where the object properties will be copied.

readProperties

public void readProperties(java.util.Hashtable properties)
Description copied from interface: SmObject
Copies the object properties from the specified hashtable.

Specified by:
readProperties in interface SmObject
Overrides:
readProperties in class SmObjectImpl
Parameters:
properties - The new properties of the object.

SiteMinder
Java SDK r12.51

Mon 04/08/2013

http://ca.com
Copyright (c) 2013 CA.