Package com.iplanet.ums.dctree

Class DomainComponent

java.lang.Object

com.iplanet.ums.PersistentObject

com.iplanet.ums.dctree.DomainComponent

All Implemented Interfaces:

ISearch, IUMSConstants, Serializable

public class DomainComponent
extends PersistentObject

Represents a domain component in the domain componet tree. Each Domain Component object represent a node in the dctree and each dc may be associated with an organization in the customer DIT (the convergence tree as noted in the nortel specication).

See Also:

DomainComponentTree, Serialized Form

Field Summary

Fields inherited from class com.iplanet.ums.PersistentObject

COMPUTED_MEMBER_ATTR_NAME

Fields inherited from interface com.iplanet.ums.IUMSConstants

ADD_NULL_OBJ, ATTR_NOT_ALLOWED, ATTRIBUTETYPE_NOT_FOUND, BAD_ATTRNAMES, BAD_CHILD_OBJ, BAD_CLASS, BAD_COS_ATTR_QUALIFIER, BAD_GUID, BAD_ID, BAD_NAMING_ATTR, BAD_OBJ_TO_ADD, BAD_PRINCIPAL_HDL, BAD_STRUCTURE_TEMPLATE_PRIORITY, BAD_TEMPLATE, BAD_TOKEN_HDL, COMPOSE_GUID_FAILED, CONFIG_MGR_ERROR, COS_DEF_OR_TARGET_OBJECT_NULL, COS_DEFINITION_NOT_FOUND, COS_DEFINITION_NOT_PERSISTENT, COS_TARGET_OBJECT_DIFFERENT_TREE, COS_TARGET_OBJECT_NOT_PERSISTENT, COS_TEMPLATE_NOT_FOUND, DATA_CONSTRAINT, DEFINITION_NOT_PERSISTENT, DEL_NULL_OBJ, DSCFG_CONNECTFAIL, DSCFG_CTRLERROR, DSCFG_DIRSERVER_NODE_EXPECTED, DSCFG_INVALID_BASE_DN, DSCFG_JSSSFFAIL, DSCFG_NO_FILE_PATH, DSCFG_NOCFGMGR, DSCFG_SERVER_NOT_FOUND, DSCFG_SERVERGROUP_NODE_EXPECTED, DSCFG_UNSUPPORTEDLSTNRTYPE, DSCFG_UNSUPPORTEDSERVERCTRL, ENTRY_ALREADY_EXISTS, ENTRY_NOT_FOUND, ERROR_CM, ERROR_CM_INITIATE, ILLEGAL_ADGROUP_SCOPE, ILLEGAL_GROUP_SCOPE, INSTANCE_FAILED, INSUFFICIENT_ACCESS_ADD, INSUFFICIENT_ACCESS_DELETE, INVALID_COS_ATTRIBUTE_QUALIFIER, INVALID_COSDEFINITION, INVALID_TOKEN, MISSING_TEMPL_NAME, MULTIPLE_ENTRY, NEW_INSTANCE_FAILED, NEXT_ENTRY_FAILED, NO_NAMING_ATTR, NO_POLICY_DOMAIN, NO_RECURSION_ALLOW, NO_REQUIRED, NO_VALUE, NULL_GUIDS, NULL_PRINCIPAL, NULL_SESSION, NULL_TOKEN, OBJECT_NOT_PERSISTENT, OBJECTCLASS_NOT_FOUND, PERSISTENT_OBJECT_PARAM_NULL, POLICIES_DO_NOT_MATCH_BY_NAME_RESOURCE_ACTION, POLICY_DOMAIN_NOT_FOUND, POLICY_EXISTS_FOR_NAME, POLICY_EXISTS_FOR_RESOURCE_ACTION, POLICY_NOT_FOUND, POLICY_ROOT_NOT_FOUND, READ_ATTRIBUTES_ERROR, READING_LDIF_FAILED, REPLACE_DEFINITION_NOT_PERSISTENT, ROLE_CONTAINED, SEARCH_FAILED, services_validator_initialize_failed, services_validator_invalid_attr_name, services_validator_invalid_attr_schema, services_validator_schema_does_not_exist, SMS_ADD_SUB_CONFIG_FAILED, SMS_ADMIN_LIMIT_EXCEEDED, SMS_ATTR_LIST_NEEDED, SMS_ATTR_NAME_NOT_FOUND, SMS_ATTR_OR_VAL_EXISTS, SMS_ATTR_SYNTAX_NOT_FOUND, SMS_AUTHENTICATION_ERROR, SMS_CAN_NOT_CONSTRUCT_SERVICE_MANAGER, SMS_CANNOT_CREATE_INSTANCE, SMS_CANNOT_CREATE_PLACE_HOLDER_NODE, SMS_EVENT_NOTIFICATION_FAILED, SMS_failed_to_get_schema_manager, SMS_INSUFFICIENT_ACCESS_RIGHTS, SMS_INVALID_ATTR_ENTRY, SMS_INVALID_ATTR_NAME, SMS_INVALID_CLASS_NAME, SMS_INVALID_CONFIG_NAME, SMS_INVALID_DN, SMS_INVALID_METHOD, SMS_INVALID_OP_VALUE, SMS_INVALID_PARAMETERS, SMS_INVALID_SEARCH_BASE, SMS_INVALID_SEARCH_ORDER_PARAMETER, SMS_INVALID_SEARCH_PATTERN, SMS_LDAP_NOT_SUPPORTED, SMS_LDAP_OPERATION_FAILED, SMS_LDAP_REFERRAL_EXCEPTION, SMS_LDAP_SERVER_BUSY, SMS_NO_ATTRIBUTE_IN_ENTRY, SMS_NO_SUCH_ATTRIBUTE, SMS_NO_SUCH_OBJECT, SMS_NODE_ALREADY_EXISTS, SMS_OC_NAME_NOT_FOUND, SMS_organization_already_exists_no_args, SMS_READONLY_OBJ, SMS_SERVER_DOWN, SMS_SERVER_INSTANCE_NOT_FOUND, SMS_service_already_exists, SMS_service_already_exists_no_args, SMS_service_does_not_exist, SMS_SERVICE_NAME_NOT_FOUND, SMS_SERVICE_NODE_NOT_FOUND, SMS_services_node_does_not_exist, SMS_SMSSchema_exception_message, SMS_SMSSchema_invalid_input_stream, SMS_SMSSchema_invalid_xml_document, SMS_SMSSchema_no_schema_element, SMS_SMSSchema_no_service_element, SMS_SMSSchema_parser_error, SMS_SMSSchema_service_notfound, SMS_SUB_CONFIG_DOES_NOT_EXIST, SMS_TIME_LIMIT_EXCEEDED, SMS_UNEXPECTED_LDAP_EXCEPTION, SMS_UNKNOWN_EXCEPTION_OCCURRED, SMS_VALIDATOR_CANNOT_INSTANTIATE_CLASS, SMS_VALUE_DOES_NOT_EXIST, SMS_xml_invalid_doc_type, SMS_XML_PARSER_EXCEPTION, SMSSCHEMA_SERVICE_NOTFOUND, SSO_ILLEGALACCESS, SSO_NOPROVIDERCLASS, SSO_NOPROVIDERINSTANCE, SSO_NOPROVIDERPROPERTY, STRUCTURE_TEMPLATE_ATTRSET_NULL, TEMPLATE_NO_ATTR, UMS_BUNDLE_NAME, UMS_DEBUG, UMS_PKG, UNABLE_TO_ADD_ENTRY, UNABLE_TO_DELETE_ENTRY, UNABLE_TO_READ_ENTRY, UNMATCHED_CLASS, USER_NOT_IN_GROUP_SCOPE

Constructor Summary

Constructors

Constructor	Description
DomainComponent()	Default constructor
DomainComponent(SSOToken token, String dcName)	Given a name for domain component, construct the dc object in memory

Method Summary

Modifier and Type	Method	Description
Guid	getAssociatedOrganizationGuid()	Get the domain mapping from this dc entry.
String	getDomainStatus()	Get the domain status in the dc entry
String	getNamingAttribute()	Get the naming attribute for the dc entry
PersistentObject	getOrganization()	Get the domain mapping from this dc entry to the organization entry in the customer DIT.
void	setAssociatedOrganization(Guid orgGuid)	Sets the mapping of a dc entry in the dctree to an organization or organizational unit entry in the convergence DIT, the directory tree hosting all the actual entries.
void	setAssociatedOrganization(PersistentObject org)	Sets the mapping of a dc entry in the dctree to an organization or OrganizationalUnit entry in the convergence DIT, the directory tree hosting all the actual entries
void	setDomainStatus(String status)	Set the domain status in the dc entry

Methods inherited from class com.iplanet.ums.PersistentObject

addACI, addAttributeValue, addChild, changePassword, deleteACI, getACI, getACI, getAttribute, getAttribute, getAttributeNames, getAttributes, getAttributes, getAttributes, getAttrSet, getChildren, getChildren, getChildren, getDN, getGuid, getParentGuid, getParentObject, getRoles, idToDN, isMemberOf, isPersistent, modify, modify, modify, remove, removeAttribute, removeAttributeValue, removeChild, removeChild, rename, replaceACI, save, search, search, search, setAttribute, setAttribute, setAttrSet, setGuid, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DomainComponent

public DomainComponent()

Default constructor

DomainComponent

public DomainComponent(SSOToken token,
                       String dcName)
                throws UMSException

Given a name for domain component, construct the dc object in memory

Parameters:

dcName - Domain Componet name

Throws:

UMSException

Method Detail

setAssociatedOrganization

public void setAssociatedOrganization(PersistentObject org)
                               throws UMSException

Sets the mapping of a dc entry in the dctree to an organization or OrganizationalUnit entry in the convergence DIT, the directory tree hosting all the actual entries

Parameters:

org - Organization entry to be associated with the dc entry in the dctree

Throws:

UMSException

setAssociatedOrganization

public void setAssociatedOrganization(Guid orgGuid)
                               throws UMSException

Sets the mapping of a dc entry in the dctree to an organization or organizational unit entry in the convergence DIT, the directory tree hosting all the actual entries.

Parameters:

orgGuid - Identifier for organization.

Throws:

UMSException - if mapping of dc entry cannot be set.

getOrganization

public PersistentObject getOrganization()
                                 throws UMSException

Get the domain mapping from this dc entry to the organization entry in the customer DIT. Return the organization object associated with thic dc entry

Returns:

PersistentObject representing the organization entry associated with dc entry

Throws:

UMSException

getAssociatedOrganizationGuid

public Guid getAssociatedOrganizationGuid()
                                   throws UMSException

Get the domain mapping from this dc entry. Domain mapping is in terms of DN

Returns:

identifier for the domain mapping associated with this dc entry

Throws:

UMSException

getDomainStatus

public String getDomainStatus()
                       throws UMSException

Get the domain status in the dc entry

Returns:

Domain status in the dc entry

Throws:

UMSException

setDomainStatus

public void setDomainStatus(String status)
                     throws UMSException

Set the domain status in the dc entry

Parameters:

status - Domain status to be set

Throws:

UMSException

getNamingAttribute

public String getNamingAttribute()

Get the naming attribute for the dc entry

Overrides:

getNamingAttribute in class PersistentObject

Returns:

Attribute name for identification