com.netegrity.sdk.policyapi
Class SmAdmin

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmAdmin
extends SmObjectImpl

Represents a SiteMinder Administrator object.

This object has global scope.

Note: A Policy Server administrator must be a SiteMinder administrator. SiteMinder administrators must log in through the login() method of the SmApiSession class.

Since:

SDK 2.0

Field Summary

static int	AdminRightsManageAllDomains The administrator's right to manage system and domain objects.
static int	AdminRightsManageEverything The administrator's right to manage everything.
static int	AdminRightsManageKeys The administrator's right to manage keys.
static int	AdminRightsManageObjects The administrator's right to manage domain objects.
static int	AdminRightsManagePasswordPolicy The administrator's right to manage password services.
static int	AdminRightsManageReports The administrator's right to view SiteMinder reports.
static int	AdminRightsManageUsers The administrator's right to manage users.
static java.lang.String	PropAdmins Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropDirAuth The object's authentication directory property.
static java.lang.String	PropDomains The object's domain property.
static java.lang.String	PropPassword The object's password property.
static java.lang.String	PropRights The object's administrator rights property.
static java.lang.String	PropScheme The object's authentication scheme property.
static java.lang.String	PropUserDirectory The object's user directory property (searchable).

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

SmAdmin()
Creates a SiteMinder Administrator object.

SmAdmin(java.lang.String name)
Creates a SiteMinder Administrator object.

Method Summary

int	getAdminRights() Gets the rights of the administrator.
boolean	getDirAuth() Returns true if the administrator account is in an external directory.
java.lang.String	getPassword() Gets the administrator's password.
SmObjId	getScheme() Gets the object identifier of the authentication scheme used to authenticate the administrator.
SmObjId	getUserDirectory() Gets the external user directory where the administrator account can be found.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setAdminRights(int adminRights) Sets the rights of the administrator.
void	setDirAuth(boolean bDirAuth) Specifies whether the administrator account is found in an external directory.
void	setPassword(java.lang.String password) Sets the administator's password.
void	setScheme(java.lang.Object scheme) Sets the object identifier of the authentication scheme used to authenticate the administrator.
void	setUserDirectory(java.lang.Object userDirectory) Sets the external user directory where the administrator account can be found.
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

PropAdmins

public static final java.lang.String PropAdmins

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

See Also:

Constant Field Values

PropPassword

public static final java.lang.String PropPassword

The object's password property.

See Also:

Constant Field Values

PropUserDirectory

public static final java.lang.String PropUserDirectory

The object's user directory property (searchable). You can search administrators based on this property.

See Also:

Constant Field Values

PropScheme

public static final java.lang.String PropScheme

The object's authentication scheme property. You can search administrators based on this property.

See Also:

Constant Field Values

PropDirAuth

public static final java.lang.String PropDirAuth

The object's authentication directory property.

See Also:

Constant Field Values

PropDomains

public static final java.lang.String PropDomains

The object's domain property.

See Also:

Constant Field Values

PropRights

public static final java.lang.String PropRights

The object's administrator rights property.

See Also:

Constant Field Values

AdminRightsManageAllDomains

public static final int AdminRightsManageAllDomains

The administrator's right to manage system and domain objects.

See Also:

Constant Field Values

AdminRightsManageObjects

public static final int AdminRightsManageObjects

The administrator's right to manage domain objects.

See Also:

Constant Field Values

AdminRightsManageUsers

public static final int AdminRightsManageUsers

The administrator's right to manage users.

See Also:

Constant Field Values

AdminRightsManageKeys

public static final int AdminRightsManageKeys

The administrator's right to manage keys.

See Also:

Constant Field Values

AdminRightsManagePasswordPolicy

public static final int AdminRightsManagePasswordPolicy

The administrator's right to manage password services.

See Also:

Constant Field Values

AdminRightsManageReports

public static final int AdminRightsManageReports

The administrator's right to view SiteMinder reports.

See Also:

Constant Field Values

AdminRightsManageEverything

public static final int AdminRightsManageEverything

The administrator's right to manage everything.

See Also:

Constant Field Values

Constructor Detail

SmAdmin

public SmAdmin()

Creates a SiteMinder Administrator object. The name of the administrator is not set with this constructor.

SmAdmin

public SmAdmin(java.lang.String name)

Creates a SiteMinder Administrator object.

Parameters:

name - Name of the administrator.

Method Detail

getPassword

public java.lang.String getPassword()

Gets the administrator's password.

Returns:

The administrator's password.

setPassword

public void setPassword(java.lang.String password)

Sets the administator's password.

Parameters:

password - The administrator's password.

getUserDirectory

public SmObjId getUserDirectory()

Gets the external user directory where the administrator account can be found.

Returns:

The object identifier of the user directory.

setUserDirectory

public void setUserDirectory(java.lang.Object userDirectory)

Sets the external user directory where the administrator account can be found.

Parameters:

userDirectory - The object identifier of the user directory.

getScheme

public SmObjId getScheme()

Gets the object identifier of the authentication scheme used to authenticate the administrator.

Returns:

The object identifier of the authentication scheme.

setScheme

public void setScheme(java.lang.Object scheme)

Sets the object identifier of the authentication scheme used to authenticate the administrator.

Parameters:

scheme - The Object identifier of the authentication scheme.

getDirAuth

public boolean getDirAuth()

Returns true if the administrator account is in an external directory.

Returns:

true if the administrator account is in an external directory.

setDirAuth

public void setDirAuth(boolean bDirAuth)

Specifies whether the administrator account is found in an external directory.

Parameters:

bDirAuth - true if the administrator account is in an external directory.

getAdminRights

public int getAdminRights()

Gets the rights of the administrator. Administrator rights are represented by constants beginning with AdminRights.

Returns:

The rights of the administrator.

setAdminRights

public void setAdminRights(int adminRights)

Sets the rights of the administrator. Administrator rights are represented by constants beginning with AdminRights.

Parameters:

adminRights - The rights of the administrator.

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.