com.netegrity.sdk.policyapi
Class SmSelfReg

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmSelfReg
extends SmObjectImpl

Represents a SiteMinder Self-Registration scheme.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropEnableLogging Constant to indicate the property Enable Logging.
static java.lang.String	PropRegistrationURL Constant to indicate the property Registration URL.
static java.lang.String	PropSelfReg Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropTemplatePath Constant to indicate the property Template Path.
static java.lang.String	PropUserDirectory Constant to indicate the property User Directory (searchable).
static java.lang.String	PropWelcomePathProvider Constant to indicate the property Welcome Path Provider.

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

SmSelfReg()
Constructs a registration scheme object.

SmSelfReg(java.lang.String szName)
Constructs a registration scheme object with the specified name.

Method Summary

boolean	getEnableLogging() Checks whether registration information logging is enabled.
java.lang.String	getRegistrationURL() Gets the location of the form used to welcome users who registered and who have been successfully authenticated.
java.lang.String	getTemplatePath() Gets the location of a registration template.
SmObjId	getUserDir() Gets the Object identifier of the user directory where user information is stored.
java.lang.String	getWelcomePathProvider() Gets the Workflow library for this registration scheme.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setEnableLogging(boolean enableLogging) Specifies whether to log registration information.
void	setRegistrationURL(java.lang.String registrationURL) Sets the location of the form used to welcome users who registered and who have been successfully authenticated.
void	setTemplatePath(java.lang.String templatePath) Sets the location of a registration template.
void	setUserDir(java.lang.Object userDirectory) Sets the Object identifier of the user directory where user information is stored.
void	setWelcomePathProvider(java.lang.String welcomePathProvider) Sets the Workflow library for this registration scheme.
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

PropSelfReg

public static final java.lang.String PropSelfReg

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

See Also:

Constant Field Values

PropUserDirectory

public static final java.lang.String PropUserDirectory

Constant to indicate the property User Directory (searchable). You can search self-registration objects based on this property.

See Also:

Constant Field Values

PropRegistrationURL

public static final java.lang.String PropRegistrationURL

Constant to indicate the property Registration URL.

See Also:

Constant Field Values

PropTemplatePath

public static final java.lang.String PropTemplatePath

Constant to indicate the property Template Path.

See Also:

Constant Field Values

PropWelcomePathProvider

public static final java.lang.String PropWelcomePathProvider

Constant to indicate the property Welcome Path Provider.

See Also:

Constant Field Values

PropEnableLogging

public static final java.lang.String PropEnableLogging

Constant to indicate the property Enable Logging.

See Also:

Constant Field Values

Constructor Detail

SmSelfReg

public SmSelfReg()

Constructs a registration scheme object. Name and description are not set.

SmSelfReg

public SmSelfReg(java.lang.String szName)

Constructs a registration scheme object with the specified name.

Parameters:

name - Name of the Registration scheme.

Method Detail

getUserDir

public SmObjId getUserDir()

Gets the Object identifier of the user directory where user information is stored.

Returns:

The Object identifier of the user directory.

setUserDir

public void setUserDir(java.lang.Object userDirectory)

Sets the Object identifier of the user directory where user information is stored.

Parameters:

userDirectory - The Object identifier of the user directory.

getRegistrationURL

public java.lang.String getRegistrationURL()

Gets the location of the form used to welcome users who registered and who have been successfully authenticated.

Returns:

The location of the form.

setRegistrationURL

public void setRegistrationURL(java.lang.String registrationURL)

Sets the location of the form used to welcome users who registered and who have been successfully authenticated.

Parameters:

registrationURL - the location of the form.

getTemplatePath

public java.lang.String getTemplatePath()

Gets the location of a registration template.

Returns:

The location of a registration template.

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)

Sets the location of a registration template.

Parameters:

templatePath - The Location of a registration template.

getWelcomePathProvider

public java.lang.String getWelcomePathProvider()

Gets the Workflow library for this registration scheme.

Returns:

The Workflow library for this registration scheme.

setWelcomePathProvider

public void setWelcomePathProvider(java.lang.String welcomePathProvider)

Sets the Workflow library for this registration scheme.

Parameters:

welcomePathProvider - The Workflow library for this registration scheme.

getEnableLogging

public boolean getEnableLogging()

Checks whether registration information logging is enabled.

Returns:

true when logging is enabled. false otherwise.

setEnableLogging

public void setEnableLogging(boolean enableLogging)

Specifies whether to log registration information.

Parameters:

enableLogging - true when logging is enabled; false otherwise.

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.