com.netegrity.sdk.policyapi
Class SmAuthAzMap

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmAuthAzMap

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmAuthAzMap
extends SmObjectImpl

Represents a SiteMinder authentication and authorization directory mapping object.

This object has global scope.

Since:

SDK 2.0

Field Summary

static int	AUTHAZ_MAPTYPE_ATTR Indicates that the type of directory mapping matches the value of the attribute exactly from the authentication directory to the authorization directory.
static int	AUTHAZ_MAPTYPE_DN Indicates that the type of directory mapping matches the user's distinguished name exactly from the authentication directory to the authorization directory.
static int	AUTHAZ_MAPTYPE_UNIVERSALID Indicates that the type of directory mapping matches the value of the Universal ID attribute exactly from the authentication directory to the authorization directory.
static java.lang.String	PropAuthAttrName The object's authentication user directory name property.
static java.lang.String	PropAuthAzMaps Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropAuthDirOid The object's authentication user directory property (searchable).
static java.lang.String	PropAzAttrName The object's authorization user directory name property.
static java.lang.String	PropAzDirOid The object's authorization user directory property (searchable).
static java.lang.String	PropMapType The object's directory mapping type 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

SmAuthAzMap()
Constructs an authentication and authorization directory mapping object.

SmAuthAzMap(java.lang.String oid)
Constructs an authentication and authorization directory mapping object with the specified object identifier.

Method Summary

int	getAuthAzType() Gets the authentication and authorization directory mapping type.
SmObjId	getAuthUserDir() Gets the authentication directory of the directory mapping.
SmObjId	getAzUserDir() Gets the authorization directory for the directory mapping.
java.lang.String	getDescription() Gets the description of the object.
java.lang.String	getName() Gets the name of the object.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setAuthAzType(int authAzMapType) Sets the authentication and authorization directory mapping type.
void	setAuthUserDir(java.lang.Object authUserDirectory) Sets the authentication directory for the directory mapping.
void	setAzUserDir(java.lang.Object azUserDirectory) Sets the authorization directory for the directory mapping.
void	setDescription(java.lang.String description) Authentication and authorization directory mapping objects do not have a description property.
void	setName(java.lang.String name) Authentication and authorization directory mapping objects do not have a name property.
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

PropAuthAzMaps

public static final java.lang.String PropAuthAzMaps

Property name to be specified in the method getGlobalObjectNames().

See Also:

Constant Field Values

PropAuthDirOid

public static final java.lang.String PropAuthDirOid

The object's authentication user directory property (searchable).

See Also:

Constant Field Values

PropAuthAttrName

public static final java.lang.String PropAuthAttrName

The object's authentication user directory name property.

See Also:

Constant Field Values

PropAzDirOid

public static final java.lang.String PropAzDirOid

The object's authorization user directory property (searchable). You can search for authentication and authorization directory mapping objects based on this property.

See Also:

Constant Field Values

PropAzAttrName

public static final java.lang.String PropAzAttrName

The object's authorization user directory name 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

AUTHAZ_MAPTYPE_DN

public static final int AUTHAZ_MAPTYPE_DN

Indicates that the type of directory mapping matches the user's distinguished name exactly from the authentication directory to the authorization directory.

See Also:

Constant Field Values

AUTHAZ_MAPTYPE_UNIVERSALID

public static final int AUTHAZ_MAPTYPE_UNIVERSALID

Indicates that the type of directory mapping matches the value of the Universal ID attribute exactly from the authentication directory to the authorization directory.

See Also:

Constant Field Values

AUTHAZ_MAPTYPE_ATTR

public static final int AUTHAZ_MAPTYPE_ATTR

Indicates that the type of directory mapping matches the value of the attribute exactly from the authentication directory to the authorization directory.

See Also:

Constant Field Values

Constructor Detail

SmAuthAzMap

public SmAuthAzMap()

Constructs an authentication and authorization directory mapping object.

SmAuthAzMap

public SmAuthAzMap(java.lang.String oid)

Constructs an authentication and authorization 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 authorization 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 authorization 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.Object authUserDirectory)

Sets the authentication directory for the directory mapping.

Parameters:

authUserDirectory - The object identifier of the authentication directory.

getAuthUserDir

public SmObjId getAuthUserDir()

Gets the authentication directory of the directory mapping.

Returns:

The object identifier of the authentication directory.

setAzUserDir

public void setAzUserDir(java.lang.Object azUserDirectory)

Sets the authorization directory for the directory mapping.

Parameters:

azUserDirectory - The object identifier of the authorization directory.

getAzUserDir

public SmObjId getAzUserDir()

Gets the authorization directory for the directory mapping.

Returns:

The object identifier of the authorization directory.

getAuthAzType

public int getAuthAzType()

Gets the authentication and authorization directory mapping type.

Returns:

The authentication and authorization directory mapping type.

setAuthAzType

public void setAuthAzType(int authAzMapType)
                   throws SmApiException

Sets the authentication and authorization directory mapping type.

Parameters:

authAzMapType - The authentication and authorization directory mapping type.

Throws:

SmApiException - When the mapping type is invalid, the SmApiResult will be SmApiResult.POLICY_INVALID_AUTHAZ_MAP_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.