com.netegrity.sdk.policyapi
Class SmDomainObjectImpl

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

All Implemented Interfaces:

SmDomainObject, SmObject, java.lang.Cloneable

Direct Known Subclasses:

SmPolicy, SmPolicyLink, SmRealm, SmResponse, SmResponseAttr, SmResponseGroup, SmRule, SmRuleGroup, SmUserPolicy, SmVariable

public abstract class SmDomainObjectImpl
extends SmObjectImpl
implements SmDomainObject

Represents SiteMinder Domain-based objects.

Since:

SDK 2.0

Field Summary

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

PropObjectClassName

Fields inherited from interface com.netegrity.sdk.policyapi.SmDomainObject

PropDomain

Fields inherited from interface com.netegrity.sdk.policyapi.SmObject

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmDomainObjectImpl()
Constructs a domain-based object.

SmDomainObjectImpl(java.lang.String className, java.lang.String name, java.lang.Object domain)
Constructs a domain-based object with the specified class and object name for the specified domain.

SmDomainObjectImpl(java.lang.String className, java.lang.String name, java.lang.String description, java.lang.Object domainOid)
Constructs a domain-based object with the specified class and object name for the specified domain, and includes a description of the object.

Method Summary

SmObjId	getDomain() Gets the Object identifier of the Domain object.
java.lang.String	getDomainName() Gets the Domain name of the object Deprecated. The preferred way to get the Domain identifier from Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.getDomain()
boolean	isDomainObject() Specifies whether the current object is a domain object.
boolean	isWriteable() Specifies whether the current object is writable.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setDomain(java.lang.Object domain) Sets the Object identifier of the Domain object.
void	setDomainName(java.lang.String domainName) Sets the Domain name of the object Deprecated. The preferred way to set the Domain identifier for Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.setDomain (domain) or xx.setDomain (domain.getOid())
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, newObject, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netegrity.sdk.policyapi.SmObject

getDescription, getName, getObjectClassname, getOid, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Constructor Detail

SmDomainObjectImpl

public SmDomainObjectImpl()

Constructs a domain-based object.

SmDomainObjectImpl

public SmDomainObjectImpl(java.lang.String className,
                          java.lang.String name,
                          java.lang.Object domain)

Constructs a domain-based object with the specified class and object name for the specified domain.

Parameters:

className - Class name of the object.

name - Name of the object.

domain - Object identifier of the Domain.

SmDomainObjectImpl

public SmDomainObjectImpl(java.lang.String className,
                          java.lang.String name,
                          java.lang.String description,
                          java.lang.Object domainOid)

Constructs a domain-based object with the specified class and object name for the specified domain, and includes a description of the object.

Parameters:

className - Class name of the object.

name - Name of the object.

description - Description of the object.

domain - Object identifier of the Domain.

Method Detail

getDomainName

public java.lang.String getDomainName()

Description copied from interface: SmDomainObject

Gets the Domain name of the object

Deprecated. The preferred way to get the Domain identifier from Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.getDomain()

Example:

String strDomainId = xx.getDomain().toString();

Specified by:

getDomainName in interface SmDomainObject

Returns:

The Domain name of the object.

setDomainName

public void setDomainName(java.lang.String domainName)

Description copied from interface: SmDomainObject

Sets the Domain name of the object

Deprecated. The preferred way to set the Domain identifier for Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.setDomain (domain) or xx.setDomain (domain.getOid())

Example:

// First create an empty domain Object.
SmDomain domain = new SmDomain ();
// Get the required domain object.
policyapi.getDomain("RequiredDomainName", domain);
// Now call setDomain of xx = realm / rule/ response / responseAttr / policy / policyLink / userPolicy

xx.setDomain (domain);
or
xx.setDomain (domain.getOid());

Specified by:

setDomainName in interface SmDomainObject

Parameters:

domainName - The Domain name of the object.

getDomain

public SmObjId getDomain()

Description copied from interface: SmDomainObject

Gets the Object identifier of the Domain object.

Specified by:

getDomain in interface SmDomainObject

Returns:

The Object identifier of the Domain object.

setDomain

public void setDomain(java.lang.Object domain)

Description copied from interface: SmDomainObject

Sets the Object identifier of the Domain object.

Specified by:

setDomain in interface SmDomainObject

Parameters:

domain - The Domain of the object or Object identifier of the Domain object.

isWriteable

public boolean isWriteable()

Description copied from interface: SmObject

Specifies whether the current object is writable.

Specified by:

isWriteable in interface SmObject

Overrides:

isWriteable in class SmObjectImpl

Returns:

true if the object is writable.

isDomainObject

public boolean isDomainObject()

Description copied from interface: SmObject

Specifies whether the current object is a domain object.

Specified by:

isDomainObject in interface SmObject

Overrides:

isDomainObject in class SmObjectImpl

Returns:

true if the object is a domain object.

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.