com.netegrity.sdk.policyapi
Class SmUserDirectory

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmUserDirectory
extends SmObjectImpl

Represents a SiteMinder User Directory.

This object has global scope.

Note: Fields (prefixed with prop...) that represent user directory properties and methods that get or set user directory properties apply to all supported user directory types (LDAP, ODBC, WinNT, and custom) unless individual directory types are specified.

Note: Fields and methods that apply to LDAP directories also apply to Active Directories.

Since:

SDK 2.0

Field Summary

static java.lang.String	CUSTOM_NAMESPACE Designates a connection to a custom directory service.
static java.lang.String	LDAP_NAMESPACE Designates a connection to an LDAP directory service.
static int	LDAP_SCOPE_SUBTREE Constant to indicate that the search of the LDAP tree extends through the entire sub tree.
static java.lang.String	ODBC_NAMESPACE Designates a connection to an ODBC directory service.
static java.lang.String	PropChallengeRespAttr Constant to indicate the property Challenge Response Attribute.
static java.lang.String	PropDisabledAttr Constant to indicate the property Disabled Attribute.
static java.lang.String	PropEmailAddrAttr Reserved for future use.
static java.lang.String	PropEnableSecurityContext Constant to indicate EnableSecurityContext For information, see setEnableSecurityContext().
static java.lang.String	PropGuidAttr Constant to indicate the property Anonymous Attribute.
static java.lang.String	PropNamespace Constant to indicate the property Namespace (searchable).
static java.lang.String	PropODBCQuery Constant to indicate the property ODBC Query Object Identifier (searchable).
static java.lang.String	PropPassword Constant to indicate the property Password.
static java.lang.String	PropPasswordAttr Constant to indicate the property Password Attribute.
static java.lang.String	PropPasswordDataAttr Constant to indicate the property password Data Attribute.
static java.lang.String	PropRequireCredentials Constant to indicate the property Require Credentials.
static java.lang.String	PropSearchResults Constant to indicate the property Search Results.
static java.lang.String	PropSearchRoot Constant to indicate the property Search Root.
static java.lang.String	PropSearchScope Constant to indicate the property Search Scope.
static java.lang.String	PropSearchTimeout Constant to indicate the property Search Timeout.
static java.lang.String	PropSecureConnection Constant to indicate the property Secure Connection.
static java.lang.String	PropServer Constant to indicate the property Server.
static java.lang.String	PropUniversalIDAttr Constant to indicate the property Universal Identifier.
static java.lang.String	PropUserDirectories Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropUserLookupEnd Constant to indicate the property Userlookup End.
static java.lang.String	PropUserLookupStart Constant to indicate the property Userlookup Start.
static java.lang.String	PropUsername Constant to indicate the property Username.
static java.lang.String	WINNT_NAMESPACE Designates a connection to a Windows NT directory service.

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

SmUserDirectory()
Constructs a user directory object.

SmUserDirectory(java.lang.String name)
Constructs a user directory object with the specified name.

Method Summary

java.lang.String	getChallengeRespAttr() Gets the name of the user directory attribute that contains a challenge response for SiteMinder to send back to a user -- for example, a hint for a forgotten password.
java.lang.String	getDisabledAttr() Gets the name of the user directory attribute that SiteMinder uses to keep track of a user’s enabled or disabled state.
java.lang.String	getEmailAddressAttr() Reserved for future use.
boolean	getEnableSecurityContext() Checks if the user directory lookup should be initiated in the context of the authenticated user.
java.lang.String	getGuidAttr() Gets the name of the user directory attribute that is designated as the anonymous user distinguished name (DN).
java.lang.String	getNamespace() Gets the namespace of the user directory.
SmObjId	getODBCQuery() Gets the object identifier for a set of ODBC queries that SiteMinder uses to query the ODBC directory.
java.lang.String	getPassword() Gets the password needed to access a user directory.
java.lang.String	getPasswordAttr() Gets the name of the user directory attribute that contains the user's password.
java.lang.String	getPasswordDataAttr() Gets the name of the user directory attribute that SiteMinder uses to store password policy information.
boolean	getRequireCredentials() Checks whether credentials are necessary to authenticate against a user directory.
int	getSearchResults() Gets the maximum number of records that can be returned for a single search of an LDAP or custom user directory.
java.lang.String	getSearchRoot() Gets the LDAP search root or the parameter string for the custom directory's library.
int	getSearchScope() Gets the scope of the search in an LDAP tree.
int	getSearchTimeout() Gets the maximum amount of time that SiteMinder will search an LDAP or custom directory.
boolean	getSecureConnection() Checks whether SSL must be used to access an LDAP or custom directory.
java.lang.String	getServer() Gets the directory server or other information for the user directory, depending upon the directory type.
java.lang.String	getUniversalIDAttr() Gets the name of the user directory attribute that has been designated as the universal ID.
java.lang.String	getUserLookupEnd() Gets the end value for a user DN lookup in an LDAP directory.
java.lang.String	getUserLookupStart() Gets the start value for a user DN lookup in an LDAP directory.
java.lang.String	getUsername() Gets the user name needed to access a user directory.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setChallengeRespAttr(java.lang.String challengeRespAttr) Sets the name of the user directory attribute that contains a challenge response for SiteMinder to send back to a user -- for example, a hint for a forgotten password.
void	setDisabledAttr(java.lang.String disabledAttr) Sets the name of the user directory attribute that SiteMinder uses to keep track of a user’s enabled or disabled state.
void	setEmailAddressAttr(java.lang.String szEmailAddressAttr) Reserved for future use.
void	setEnableSecurityContext(boolean enableSecurityCtxt) This attribute directs the user directory to initiate lookups in the context of the authenticated user.
void	setGuidAttr(java.lang.String guidAttr) Sets the name of the user directory attribute that is designated as the anonymous user distinguished name (DN).
void	setNamespace(java.lang.String namespace) Sets the namespace of the user directory.
void	setODBCQuery(java.lang.Object odbcQuery) Specifies the object identifier for a set of ODBC queries that SiteMinder uses to query the ODBC directory.
void	setPassword(java.lang.String password) Specifies the password needed to access a user directory.
void	setPasswordAttr(java.lang.String passwordAttr) Sets the name of the user directory attribute that contains the user's password.
void	setPasswordDataAttr(java.lang.String passwordDataAttr) Sets the name of the user directory attribute that SiteMinder uses to store password policy information.
void	setRequireCredentials(boolean requireCredentials) Specifies whether credentials are necessary to authenticate against a user directory.
void	setSearchResults(int searchResults) Sets the maximum number of records that can be returned for a single search of an LDAP or custom user directory.
void	setSearchRoot(java.lang.String searchRoot) Sets the LDAP search root or the parameter string for the custom directory's library.
void	setSearchScope(int nSearchScope) Sets the scope of the search in an LDAP tree.
void	setSearchTimeout(int searchTimeout) Sets the maximum amount of time that SiteMinder will search an LDAP or custom directory.
void	setSecureConnection(boolean secureConnection) Specifies whether SSL must be used to access an LDAP or custom directory.
void	setServer(java.lang.String server) Sets the directory server or other information for the user directory, depending upon the directory type.
void	setUniversalIDAttr(java.lang.String universalIDAttr) Sets the name of the user directory attribute that has been designated as the universal ID.
void	setUserLookupEnd(java.lang.String userLookupEnd) Sets the end value for a user DN lookup in an LDAP directory.
void	setUserLookupStart(java.lang.String userLookupStart) Sets the start value for a user DN lookup in an LDAP directory.
void	setUsername(java.lang.String username) Specifies the user name needed to access a user directory.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

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

getDescription, getName, getObjectClassname, getOid, isDomainObject, isWriteable, newObject, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

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

Field Detail

PropUserDirectories

public static final java.lang.String PropUserDirectories

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

See Also:

Constant Field Values

PropNamespace

public static final java.lang.String PropNamespace

Constant to indicate the property Namespace (searchable). Namespace information is required.

You can search user directory objects based on this property.

See Also:

Constant Field Values

PropServer

public static final java.lang.String PropServer

Constant to indicate the property Server. Server information is required.

For information about server definition for a particular user directory type, see setServer().

See Also:

Constant Field Values

PropSearchRoot

public static final java.lang.String PropSearchRoot

Constant to indicate the property Search Root. For information, see setSearchRoot().

See Also:

Constant Field Values

PropSearchResults

public static final java.lang.String PropSearchResults

Constant to indicate the property Search Results. For information, see setSearchResults().

See Also:

Constant Field Values

PropSearchScope

public static final java.lang.String PropSearchScope

Constant to indicate the property Search Scope. For information, see setSearchScope().

See Also:

Constant Field Values

PropSearchTimeout

public static final java.lang.String PropSearchTimeout

Constant to indicate the property Search Timeout. For information, see setSearchTimeout().

See Also:

Constant Field Values

PropUserLookupStart

public static final java.lang.String PropUserLookupStart

Constant to indicate the property Userlookup Start. For information, see setUserLookupStart().

See Also:

Constant Field Values

PropUserLookupEnd

public static final java.lang.String PropUserLookupEnd

Constant to indicate the property Userlookup End. For information, see setUserLookupEnd().

See Also:

Constant Field Values

PropUsername

public static final java.lang.String PropUsername

Constant to indicate the property Username. For information, see setUsername().

See Also:

Constant Field Values

PropPassword

public static final java.lang.String PropPassword

Constant to indicate the property Password. For information, see setPassword().

See Also:

Constant Field Values

PropSecureConnection

public static final java.lang.String PropSecureConnection

Constant to indicate the property Secure Connection. For information, see setSecureConnection().

See Also:

Constant Field Values

PropRequireCredentials

public static final java.lang.String PropRequireCredentials

Constant to indicate the property Require Credentials. For information, see setRequireCredentials().

See Also:

Constant Field Values

PropDisabledAttr

public static final java.lang.String PropDisabledAttr

Constant to indicate the property Disabled Attribute. For information, see setDisabledAttr().

See Also:

Constant Field Values

PropUniversalIDAttr

public static final java.lang.String PropUniversalIDAttr

Constant to indicate the property Universal Identifier. For information, see setUniversalIDAttr().

See Also:

Constant Field Values

PropODBCQuery

public static final java.lang.String PropODBCQuery

Constant to indicate the property ODBC Query Object Identifier (searchable). For information, see setODBCQuery().

You can search user directory objects based on this property.

See Also:

Constant Field Values

PropGuidAttr

public static final java.lang.String PropGuidAttr

Constant to indicate the property Anonymous Attribute. For information, see setGuidAttr().

See Also:

Constant Field Values

PropPasswordDataAttr

public static final java.lang.String PropPasswordDataAttr

Constant to indicate the property password Data Attribute. For information, see setPasswordDataAttr().

See Also:

Constant Field Values

PropPasswordAttr

public static final java.lang.String PropPasswordAttr

Constant to indicate the property Password Attribute. For information, see setPasswordAttr().

See Also:

Constant Field Values

PropEmailAddrAttr

public static final java.lang.String PropEmailAddrAttr

Reserved for future use.

See Also:

Constant Field Values

PropChallengeRespAttr

public static final java.lang.String PropChallengeRespAttr

Constant to indicate the property Challenge Response Attribute. For information, see setChallengeRespAttr().

See Also:

Constant Field Values

PropEnableSecurityContext

public static final java.lang.String PropEnableSecurityContext

Constant to indicate EnableSecurityContext For information, see setEnableSecurityContext().

See Also:

Constant Field Values

LDAP_SCOPE_SUBTREE

public static final int LDAP_SCOPE_SUBTREE

Constant to indicate that the search of the LDAP tree extends through the entire sub tree.

See Also:

Constant Field Values

LDAP_NAMESPACE

public static final java.lang.String LDAP_NAMESPACE

Designates a connection to an LDAP directory service.

See Also:

Constant Field Values

ODBC_NAMESPACE

public static final java.lang.String ODBC_NAMESPACE

Designates a connection to an ODBC directory service.

See Also:

Constant Field Values

WINNT_NAMESPACE

public static final java.lang.String WINNT_NAMESPACE

Designates a connection to a Windows NT directory service.

See Also:

Constant Field Values

CUSTOM_NAMESPACE

public static final java.lang.String CUSTOM_NAMESPACE

Designates a connection to a custom directory service. You create custom directory connections with the Directory API.

See Also:

Constant Field Values

Constructor Detail

SmUserDirectory

public SmUserDirectory()

Constructs a user directory object. Name and description are not set.

SmUserDirectory

public SmUserDirectory(java.lang.String name)

Constructs a user directory object with the specified name.

Parameters:

name - Name of the user directory.

Method Detail

getNamespace

public java.lang.String getNamespace()

Gets the namespace of the user directory.

Returns:

One of the following namespace values:

   LDAP:
   WinNT:
   ODBC:
   Custom:

setNamespace

public void setNamespace(java.lang.String namespace)

Sets the namespace of the user directory.

Parameters:

namespace - One of the following namespace values:

   LDAP:
   WinNT:
   ODBC:
   Custom:

getServer

public java.lang.String getServer()

Gets the directory server or other information for the user directory, depending upon the directory type. Directory types and their associated values are as follows:

• ODBC - Data source name.
• NT - Domain name.
• LDAP - An IP address or an IP address and port number in the format IP_address:port_number. The port number 389 is assumed if no port number is specified.
• Custom - Library name.

Returns:

The directory server or other information for the user directory.

setServer

public void setServer(java.lang.String server)

Sets the directory server or other information for the user directory, depending upon the directory type. Directory types and their associated values are as follows:

• ODBC - Data source name.
• NT - Domain name.
• LDAP - An IP address or an IP address and port number in the format IP_address:port_number. The port number 389 is assumed if no port number is specified.
• Custom - The library name for the custom directory.

Parameters:

server - The directory server or other information for the user directory.

getSearchRoot

public java.lang.String getSearchRoot()

Gets the LDAP search root or the parameter string for the custom directory's library.

• With LDAP directories, gets the location in the LDAP tree that serves as the starting point for the directory connection -- typically, an organization (o) or organizational unit (ou). The Policy Server begins searching at the root when locating a user. See getSearchScope() for more information.
  
  
• With custom directories, gets the parameter string, if any, to pass to the custom library.

Returns:

The LDAP search root or the parameter string for the custom library.

setSearchRoot

public void setSearchRoot(java.lang.String searchRoot)

Sets the LDAP search root or the parameter string for the custom directory's library.

• With LDAP directories, sets the location in the LDAP tree that serves as the starting point for the directory connection -- typically, an organization (o) or organizational unit (ou). The Policy Server begins searching at the root when locating a user. See setSearchScope() for more information.
  
  
• With custom directories, sets the parameter string to pass to the custom library.

Parameters:

searchRoot - The LDAP search root or the parameter string for the custom library.

getUserLookupStart

public java.lang.String getUserLookupStart()

Gets the start value for a user DN lookup in an LDAP directory. For more information, see setUserLookupStart()

Returns:

The user lookup start value.

setUserLookupStart

public void setUserLookupStart(java.lang.String userLookupStart)

Sets the start value for a user DN lookup in an LDAP directory. The lookup start value together with the lookup end value allow users to authenticate entering only part of the DN string. For example, in the DN uid=JSmith,ou=marketing,o=myorg.org:

• uid= is the lookup start value.
• ,ou=marketing,o=myorg.org is the lookup end value.

When these lookup start and lookup end values are set, only JSmith, which is the unique part of the DN, must be specified in the credentials when the user logs in.

Applies to LDAP user directories only.

Parameters:

userLookupStart - The user lookup start value.

getUserLookupEnd

public java.lang.String getUserLookupEnd()

Gets the end value for a user DN lookup in an LDAP directory. For more information, see setUserLookupEnd()

Returns:

The user lookup end value.

setUserLookupEnd

public void setUserLookupEnd(java.lang.String userLookupEnd)

Sets the end value for a user DN lookup in an LDAP directory. The lookup end value together with the lookup start value allow users to authenticate entering only part the DN string. For example, in the DN uid=JSmith,ou=marketing,o=myorg.org:

• uid= is the lookup start value.
• ,ou=marketing,o=myorg.org is the lookup end value.

When these lookup start and lookup end values are set, only JSmith, which is the unique part of the DN, must be specified in the credentials when the user logs in.

Applies to LDAP user directories only.

Parameters:

userLookupEnd - The user lookup end value.

getUsername

public java.lang.String getUsername()

Gets the user name needed to access a user directory. requireCredentials in the method setRequireCredentials() must be set to true.

Returns:

The user name needed to access a user directory.

setUsername

public void setUsername(java.lang.String username)

Specifies the user name needed to access a user directory. requireCredentials in the method setRequireCredentials() must be set to true.

Parameters:

username - The user name needed to access a user directory.

getPassword

public java.lang.String getPassword()

Gets the password needed to access a user directory. requireCredentials in the method setRequireCredentials() must be set to true.

Returns:

The password needed to access a user directory.

setPassword

public void setPassword(java.lang.String password)

Specifies the password needed to access a user directory. requireCredentials in the method setRequireCredentials() must be set to true.

Parameters:

password - The password needed to access a user directory.

getSearchResults

public int getSearchResults()

Gets the maximum number of records that can be returned for a single search of an LDAP or custom user directory.

Returns:

The maximum number of records that can be returned.

setSearchResults

public void setSearchResults(int searchResults)

Sets the maximum number of records that can be returned for a single search of an LDAP or custom user directory.

Parameters:

searchResults - The maximum number of records that can be returned.

getSearchScope

public int getSearchScope()

Gets the scope of the search in an LDAP tree. The scope indicates how far below the root that SiteMinder will query the LDAP user directory to find a match for user authentication.

See getSearchRoot() for more information.

Returns:

One of the following values:

1 (One level - search the root and one level below).
2 (Sub tree - search the root and all levels below).

setSearchScope

public void setSearchScope(int nSearchScope)

Sets the scope of the search in an LDAP tree. The scope indicates how far below the root that SiteMinder will query the LDAP user directory to find a match for user authentication.

See setSearchRoot() for more information.

Parameters:

nSearchScope - One of the following values:

1 (One level - search the root and one level below).
2 (Sub tree - search the root and all levels below).

getSearchTimeout

public int getSearchTimeout()

Gets the maximum amount of time that SiteMinder will search an LDAP or custom directory.

Returns:

The maximum search time in seconds.

setSearchTimeout

public void setSearchTimeout(int searchTimeout)

Sets the maximum amount of time that SiteMinder will search an LDAP or custom directory.

Parameters:

searchTimeout - The maximum search time in seconds.

getSecureConnection

public boolean getSecureConnection()

Checks whether SSL must be used to access an LDAP or custom directory. Enabling a secure connection means that SiteMinder performs secure authentication and encrypted transmissions.

Returns:

true if SSL must be used. false otherwise.

setSecureConnection

public void setSecureConnection(boolean secureConnection)

Specifies whether SSL must be used to access an LDAP or custom directory. Enabling a secure connection means that SiteMinder performs secure authentication and encrypted transmissions.

Parameters:

secureConnection - true if SSL must be used. false otherwise.

getRequireCredentials

public boolean getRequireCredentials()

Checks whether credentials are necessary to authenticate against a user directory.

Returns:

true if credentials are necessary to authenticate against a user directory. false otherwise.

setRequireCredentials

public void setRequireCredentials(boolean requireCredentials)

Specifies whether credentials are necessary to authenticate against a user directory.

Parameters:

requireCredentials - true if credentials are necessary to authenticate against a user directory. false otherwise.

getEnableSecurityContext

public boolean getEnableSecurityContext()

Checks if the user directory lookup should be initiated in the context of the authenticated user.

Returns:

true if authenticated user context is enabled false if authenticated user context is not enabled

setEnableSecurityContext

public void setEnableSecurityContext(boolean enableSecurityCtxt)

This attribute directs the user directory to initiate lookups in the context of the authenticated user.

Parameters:

true - to enable authenticated user context false to disable authenticated user context

getDisabledAttr

public java.lang.String getDisabledAttr()

Gets the name of the user directory attribute that SiteMinder uses to keep track of a user’s enabled or disabled state.

Applies to LDAP and ODBC directories, and possibly to custom directories.

Returns:

The enabled/disabled attribute.

setDisabledAttr

public void setDisabledAttr(java.lang.String disabledAttr)

Sets the name of the user directory attribute that SiteMinder uses to keep track of a user’s enabled or disabled state.

Applies to LDAP and ODBC directories, and possibly to custom directories.

Parameters:

disabledAttr - The enabled/disabled attribute.

getUniversalIDAttr

public java.lang.String getUniversalIDAttr()

Gets the name of the user directory attribute that has been designated as the universal ID. Typically, the universal ID differs from the user’s login ID, and the universal ID is used to look up user information.

Applies to LDAP, ODBC, and WinNT directories, and possibly to custom directories.

Returns:

The universal ID attribute.

setUniversalIDAttr

public void setUniversalIDAttr(java.lang.String universalIDAttr)

Sets the name of the user directory attribute that has been designated as the universal ID. Typically, the universal ID differs from the user’s login ID, and the universal ID is used to look up user information.

Applies to LDAP, ODBC, and WinNT directories, and possibly to custom directories.

Parameters:

universalIDAttr - The universal ID attribute.

getODBCQuery

public SmObjId getODBCQuery()

Gets the object identifier for a set of ODBC queries that SiteMinder uses to query the ODBC directory.

Returns:

The object identifier of the ODBC query.

setODBCQuery

public void setODBCQuery(java.lang.Object odbcQuery)

Specifies the object identifier for a set of ODBC queries that SiteMinder uses to query the ODBC directory.

Parameters:

odbcQuery - The object identifier of the ODBC query.

getGuidAttr

public java.lang.String getGuidAttr()

Gets the name of the user directory attribute that is designated as the anonymous user distinguished name (DN). This DN is defined in the anonymous authentication scheme. With this DN, anonymous users can gain access to the resources associated with the anonymous authentication scheme.

Applies to LDAP directories, and possibly to custom directories.

Returns:

The anonymous user distinguished name attribute.

setGuidAttr

public void setGuidAttr(java.lang.String guidAttr)

Sets the name of the user directory attribute that is designated as the anonymous user distinguished name (DN). This DN is defined in the anonymous authentication scheme. With this DN, anonymous users can gain access to the resources associated with the anonymous authentication scheme.

Applies to LDAP directories, and possibly to custom directories.

Parameters:

guidAttr - The anonymous user distinguished name attribute.

getPasswordDataAttr

public java.lang.String getPasswordDataAttr()

Gets the name of the user directory attribute that SiteMinder uses to store password policy information.

Applies to LDAP and ODBC directories, and possibly to custom directories.

Returns:

The password data attribute.

setPasswordDataAttr

public void setPasswordDataAttr(java.lang.String passwordDataAttr)

Sets the name of the user directory attribute that SiteMinder uses to store password policy information.

Applies to LDAP and ODBC directories, and possibly to custom directories.

Parameters:

passwordDataAttr - The password data attribute.

getPasswordAttr

public java.lang.String getPasswordAttr()

Gets the name of the user directory attribute that contains the user's password.

Applies to LDAP and ODBC directories, and possibly to custom directories.

Returns:

The password attribute.

setPasswordAttr

public void setPasswordAttr(java.lang.String passwordAttr)

Sets the name of the user directory attribute that contains the user's password.

Applies to LDAP and ODBC directories, and possibly to custom directories.

Parameters:

passwordAttr - The password attribute.

getEmailAddressAttr

public java.lang.String getEmailAddressAttr()

Reserved for future use.

setEmailAddressAttr

public void setEmailAddressAttr(java.lang.String szEmailAddressAttr)

Reserved for future use.

getChallengeRespAttr

public java.lang.String getChallengeRespAttr()

Gets the name of the user directory attribute that contains a challenge response for SiteMinder to send back to a user -- for example, a hint for a forgotten password.

Applies to LDAP directories, and possibly to custom directories.

Returns:

The challenge response attribute.

setChallengeRespAttr

public void setChallengeRespAttr(java.lang.String challengeRespAttr)

Sets the name of the user directory attribute that contains a challenge response for SiteMinder to send back to a user -- for example, a hint for a forgotten password.

Applies to LDAP directories, and possibly to custom directories.

Parameters:

challengeRespAttr - The challenge response attribute.

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.