com.netegrity.sdk.policyapi
Class SmScheme

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmScheme
extends SmObjectImpl

Represents a SiteMinder authentication scheme.

This object has global scope.

Since:

SDK 2.0

Field Summary

static int	LevelOne Constant to indicate that the level of protection is 1.
static java.lang.String	PropAllowSaveCreds Constant to indicate the property Save Credentials.
static java.lang.String	PropIgnorePwCheck Constant to indicate the property Password Policies (searchable).
static java.lang.String	PropIsRadius Constant to indicate the property Scheme Type is Radius (searchable).
static java.lang.String	PropIsTemplate Constant to indicate the property Template (searchable).
static java.lang.String	PropIsUsedByAdmin Constant to indicate the property Authenticate Administrators (searchable).
static java.lang.String	PropLevel Constant to indicate the property Protection Level.
static java.lang.String	PropLib Constant to indicate the property Library.
static java.lang.String	PropParam Constant to indicate the property Parameter that is passed to the authentication scheme.
static java.lang.String	PropSchemes Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropSecret Constant to indicate the property Shared Secret.
static java.lang.String	PropType Constant to indicate the property Type of Authentication (searchable).
static int	TypeACEServer Constant to indicate that the type of authentication scheme is ACE Server (SecureID Template).
static int	TypeACEServerHTMLForm Constant to indicate that the type of authentication scheme is ACE Server HTML Form (SecureID HTML Form Template).
static int	TypeAnonymous Constant to indicate that the type of authentication scheme is Anonymous (Anonymous Template).
static int	TypeBasic Constant to indicate that the type of authentication scheme is Basic (Basic Template).
static int	TypeBasicOverSSL Constant to indicate that the type of authentication scheme is Basic Over SSL (Basic over SSL Template).
static int	TypeCryptoCard Constant to indicate that the type of authentication scheme is Crypto Card (CRYPTOCard RB-1 Template).
static int	TypeCustom Constant to indicate that the type of authentication scheme is Custom.
static int	TypeEncotone Constant to indicate that the type of authentication scheme is Encotone (TeleID Template).
static int	TypeHTMLForm Constant to indicate that the type of authentication scheme is HTML Form (HTML Form Template).
static int	TypeImpersonation Constant to indicate that the type of authentication scheme is Impersonation.
static int	TypeMSPassport Constant to indicate that the type of authentication scheme is MS Passport.
static int	TypeNTLM Constant to indicate that the type of authentication scheme is NTLM (NTLM Template).
static int	TypeRadiusChapPap Constant to indicate that the type of authentication scheme is RADIUS CHAP/PAP (RADIUS CHAP/PAP Template).
static int	TypeRadiusServer Constant to indicate that the type of authentication scheme is RADIUS Server (RADIUS Server Template).
static int	TypeSafeWordHTMLForm Constant to indicate that the type of authentication scheme is SafeWord Form.
static int	TypeSafeWordServer Constant to indicate that the type of authentication scheme is SafeWord Server (SafeWord Template).
static int	TypeSAMLArtifact Constant to indicate that the type of authentication scheme is SAML Artifact (available with the separately licensed Federation Security Services feature).
static int	TypeX509ClientCert Constant to indicate that the type of authentication scheme is X509 Client Certification (X509 Client Cert Template).
static int	TypeX509ClientCertAndBasic Constant to indicate that the type of authentication scheme is X509 Client Certification and Basic (X509 Client Cert and Basic Template).
static int	TypeX509ClientCertAndForm Constant to indicate that the authentication scheme is of type X509 Client Cert and Form.
static int	TypeX509ClientCertOrBasic Constant to indicate that the type of authentication scheme is X509 Client Certification or Basic (X509 Client Cert or Basic Template).
static int	TypeX509ClientCertOrForm Constant to indicate that the authentication scheme is of type X509 Client Cert or Form.

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

SmScheme()
Constructs the authentication scheme.

SmScheme(java.lang.String name)
Constructs the authentication scheme with the specified name.

Method Summary

boolean	getAllowSaveCreds() Checks whether the authentication scheme is allowed to save user credentials.
boolean	getIgnorePwCheck() Checks whether the password policies for the authentication scheme are disabled.
boolean	getIsRadius() Checks whether the scheme is of type Radius.
boolean	getIsTemplate() Checks whether the authentication scheme is a template.
boolean	getIsUsedByAdmin() Checks whether the authentication scheme can be used to authenticate administrators.
int	getLevel() Gets the protection level of the authentication scheme.
java.lang.String	getLibrary() Gets the name of the shared library that implements the authentication scheme.
java.lang.String	getParameter() Gets the parameter information that is passed to the authentication scheme.
java.lang.String	getSecret() Gets the shared secret for the authentication scheme.
int	getType() Gets the type of the authentication scheme.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setAllowSaveCreds(boolean allowSaveCreds) Specifies whether the authentication scheme is allowed to save user credentials.
void	setIgnorePwCheck(boolean ignorePwCheck) Specifies whether password policies are disabled for the authentication scheme.
void	setIsRadius(boolean isRadius) Specifies whether the scheme is of type Radius.
void	setIsTemplate(boolean isTemplate) Specifies whether the authentication scheme is a template.
void	setIsUsedByAdmin(boolean isUsedByAdmin) Specifies whether the authentication scheme can be used to authenticate administrators.
void	setLevel(int level) Sets the protection level of the authentication scheme.
void	setLibrary(java.lang.String library) Sets the name of the shared library that implements the authentication scheme.
void	setParameter(java.lang.String parameter) Sets the parameter information that is passed to the authentication scheme.
void	setSecret(java.lang.String secret) Sets the shared secret for the authentication scheme.
void	setType(int type) Sets the type of the authentication 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

PropSchemes

public static final java.lang.String PropSchemes

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

See Also:

Constant Field Values

PropType

public static final java.lang.String PropType

Constant to indicate the property Type of Authentication (searchable). You can search scheme objects based on this property.

See Also:

Constant Field Values

PropLevel

public static final java.lang.String PropLevel

Constant to indicate the property Protection Level.

See Also:

Constant Field Values

PropLib

public static final java.lang.String PropLib

Constant to indicate the property Library.

See Also:

Constant Field Values

PropParam

public static final java.lang.String PropParam

Constant to indicate the property Parameter that is passed to the authentication scheme.

See Also:

Constant Field Values

PropSecret

public static final java.lang.String PropSecret

Constant to indicate the property Shared Secret.

See Also:

Constant Field Values

PropIsTemplate

public static final java.lang.String PropIsTemplate

Constant to indicate the property Template (searchable). You can search scheme objects based on this property.

See Also:

Constant Field Values

PropIsUsedByAdmin

public static final java.lang.String PropIsUsedByAdmin

Constant to indicate the property Authenticate Administrators (searchable). You can search scheme objects based on this property.

See Also:

Constant Field Values

PropAllowSaveCreds

public static final java.lang.String PropAllowSaveCreds

Constant to indicate the property Save Credentials.

See Also:

Constant Field Values

PropIsRadius

public static final java.lang.String PropIsRadius

Constant to indicate the property Scheme Type is Radius (searchable). You can search scheme objects based on this property.

See Also:

Constant Field Values

PropIgnorePwCheck

public static final java.lang.String PropIgnorePwCheck

Constant to indicate the property Password Policies (searchable). You can search scheme objects based on this property.

See Also:

Constant Field Values

TypeBasic

public static final int TypeBasic

Constant to indicate that the type of authentication scheme is Basic (Basic Template).

See Also:

Constant Field Values

TypeCryptoCard

public static final int TypeCryptoCard

Constant to indicate that the type of authentication scheme is Crypto Card (CRYPTOCard RB-1 Template).

See Also:

Constant Field Values

TypeEncotone

public static final int TypeEncotone

Constant to indicate that the type of authentication scheme is Encotone (TeleID Template).

See Also:

Constant Field Values

TypeHTMLForm

public static final int TypeHTMLForm

Constant to indicate that the type of authentication scheme is HTML Form (HTML Form Template).

See Also:

Constant Field Values

TypeBasicOverSSL

public static final int TypeBasicOverSSL

Constant to indicate that the type of authentication scheme is Basic Over SSL (Basic over SSL Template).

See Also:

Constant Field Values

TypeRadiusServer

public static final int TypeRadiusServer

Constant to indicate that the type of authentication scheme is RADIUS Server (RADIUS Server Template).

See Also:

Constant Field Values

TypeSafeWordServer

public static final int TypeSafeWordServer

Constant to indicate that the type of authentication scheme is SafeWord Server (SafeWord Template).

See Also:

Constant Field Values

TypeACEServer

public static final int TypeACEServer

Constant to indicate that the type of authentication scheme is ACE Server (SecureID Template).

See Also:

Constant Field Values

TypeX509ClientCert

public static final int TypeX509ClientCert

Constant to indicate that the type of authentication scheme is X509 Client Certification (X509 Client Cert Template).

See Also:

Constant Field Values

TypeX509ClientCertAndBasic

public static final int TypeX509ClientCertAndBasic

Constant to indicate that the type of authentication scheme is X509 Client Certification and Basic (X509 Client Cert and Basic Template).

See Also:

Constant Field Values

TypeX509ClientCertOrBasic

public static final int TypeX509ClientCertOrBasic

Constant to indicate that the type of authentication scheme is X509 Client Certification or Basic (X509 Client Cert or Basic Template).

See Also:

Constant Field Values

TypeRadiusChapPap

public static final int TypeRadiusChapPap

Constant to indicate that the type of authentication scheme is RADIUS CHAP/PAP (RADIUS CHAP/PAP Template).

See Also:

Constant Field Values

TypeAnonymous

public static final int TypeAnonymous

Constant to indicate that the type of authentication scheme is Anonymous (Anonymous Template).

See Also:

Constant Field Values

TypeNTLM

public static final int TypeNTLM

Constant to indicate that the type of authentication scheme is NTLM (NTLM Template).

See Also:

Constant Field Values

TypeCustom

public static final int TypeCustom

Constant to indicate that the type of authentication scheme is Custom.

See Also:

Constant Field Values

TypeACEServerHTMLForm

public static final int TypeACEServerHTMLForm

Constant to indicate that the type of authentication scheme is ACE Server HTML Form (SecureID HTML Form Template).

See Also:

Constant Field Values

TypeSafeWordHTMLForm

public static final int TypeSafeWordHTMLForm

Constant to indicate that the type of authentication scheme is SafeWord Form.

See Also:

Constant Field Values

TypeX509ClientCertOrForm

public static final int TypeX509ClientCertOrForm

Constant to indicate that the authentication scheme is of type X509 Client Cert or Form.

See Also:

Constant Field Values

TypeX509ClientCertAndForm

public static final int TypeX509ClientCertAndForm

Constant to indicate that the authentication scheme is of type X509 Client Cert and Form.

See Also:

Constant Field Values

TypeMSPassport

public static final int TypeMSPassport

Constant to indicate that the type of authentication scheme is MS Passport.

See Also:

Constant Field Values

TypeSAMLArtifact

public static final int TypeSAMLArtifact

Constant to indicate that the type of authentication scheme is SAML Artifact (available with the separately licensed Federation Security Services feature).

See Also:

Constant Field Values

TypeImpersonation

public static final int TypeImpersonation

Constant to indicate that the type of authentication scheme is Impersonation.

See Also:

Constant Field Values

LevelOne

public static final int LevelOne

Constant to indicate that the level of protection is 1.

See Also:

Constant Field Values

Constructor Detail

SmScheme

public SmScheme()

Constructs the authentication scheme. Name and description are not set.

SmScheme

public SmScheme(java.lang.String name)

Constructs the authentication scheme with the specified name.

Parameters:

name - Name of the authentication scheme.

Method Detail

getLevel

public int getLevel()

Gets the protection level of the authentication scheme. The level can vary from 1 through 20. The higher the number, the more secure the scheme.

When the Policy Server is on an HP-UX 11i platform, the protection level can range from 1 through 1000.

Returns:

The protection level of the authentication scheme.

setLevel

public void setLevel(int level)

Sets the protection level of the authentication scheme. The level can vary from 1 through 20. The higher the number, the more secure the scheme.

When the Policy Server is on an HP-UX 11i platform, the protection level can range from 1 through 1000.

With Anonymous authentication schemes, set this value to 0.

Parameters:

level - The protection level of the authentication scheme.

getType

public int getType()

Gets the type of the authentication scheme. Authentication scheme types are constants that begin with Type.

Returns:

The type of the authentication scheme.

setType

public void setType(int type)

Sets the type of the authentication scheme. Authentication scheme types are constants that begin with Type. See setLibrary() for a list of scheme types and their associated default libraries.

Parameters:

type - The type of the authentication scheme.

getLibrary

public java.lang.String getLibrary()

Gets the name of the shared library that implements the authentication scheme.

Returns:

The name of the shared library.

setLibrary

public void setLibrary(java.lang.String library)

Sets the name of the shared library that implements the authentication scheme.

The following table shows the standard authoriation scheme types and their default libraries. You typically will use the default library for a scheme type, but you can use a custom library in place of the default library.

Scheme Type	Library
TypeAnonymous	smauthanon
TypeBasicOverSSL	smauthcert
TypeBasic	smauthdir
TypeCryptoCard	smauthcryptocard
TypeHTMLForm	smauthhtml
TypeNTLM	smauthntlm
TypeRadiusChapPap	smauthchap
TypeRadiusServer	smauthradius
TypeSafeWordServer	smauthamauthenigma
TypeACEServerHTMLForm	smauthacehtml
TypeACEServer	smauthace
TypeEncotone	smauthencotone
TypeX509ClientCertAndBasic	smauthcert
TypeX509ClientCertOrBasic	smauthcert
TypeX509ClientCert	smauthcert

Parameters:

library - The name of the shared library.

getParameter

public java.lang.String getParameter()

Gets the parameter information that is passed to the authentication scheme.

Returns:

The parameter information that is passed to the custom authentication scheme.

setParameter

public void setParameter(java.lang.String parameter)

Sets the parameter information that is passed to the authentication scheme.

Parameters:

parameter - The parameter information that is passed to the custom authentication scheme.

getSecret

public java.lang.String getSecret()

Gets the shared secret for the authentication scheme.

Returns:

The shared secret for the authentication scheme.

setSecret

public void setSecret(java.lang.String secret)

Sets the shared secret for the authentication scheme.

Parameters:

secret - The shared secret for the authentication scheme.

getIsTemplate

public boolean getIsTemplate()

Checks whether the authentication scheme is a template.

Returns:

true if the scheme is a template. false otherwise.

setIsTemplate

public void setIsTemplate(boolean isTemplate)

Specifies whether the authentication scheme is a template.

Parameters:

isTemplate - true if the scheme is a template. false otherwise.

getIsUsedByAdmin

public boolean getIsUsedByAdmin()

Checks whether the authentication scheme can be used to authenticate administrators.

Returns:

true if the scheme is to authenticate administrators. false otherwise.

setIsUsedByAdmin

public void setIsUsedByAdmin(boolean isUsedByAdmin)

Specifies whether the authentication scheme can be used to authenticate administrators.

Parameters:

isUsedByAdmin - true if the scheme can be used to authenticate administrators. false otherwise.

getAllowSaveCreds

public boolean getAllowSaveCreds()

Checks whether the authentication scheme is allowed to save user credentials.

Returns:

true if the authentication scheme is allowed to save user credentials. false otherwise.

setAllowSaveCreds

public void setAllowSaveCreds(boolean allowSaveCreds)

Specifies whether the authentication scheme is allowed to save user credentials.

Parameters:

allowSaveCreds - true if the authentication scheme is allowed to save user credentials. false otherwise.

getIsRadius

public boolean getIsRadius()

Checks whether the scheme is of type Radius.

Returns:

true if the scheme is of type Radius. false otherwise.

setIsRadius

public void setIsRadius(boolean isRadius)

Specifies whether the scheme is of type Radius.

Parameters:

isRadius - true if the scheme is of type Radius. false otherwise.

getIgnorePwCheck

public boolean getIgnorePwCheck()

Checks whether the password policies for the authentication scheme are disabled.

Returns:

true if the password policies are disabled. false otherwise.

setIgnorePwCheck

public void setIgnorePwCheck(boolean ignorePwCheck)

Specifies whether password policies are disabled for the authentication scheme.

Parameters:

ignorePwCheck - true if the password policies are disabled. 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.