com.netegrity.llsdk6.imsapi.managedobject
Interface ManagedObject

All Superinterfaces:

AttributeCollection, java.util.Map, ModifiableObject, NamedObject, java.io.Serializable

All Known Subinterfaces:

AccessRole, AccessTask, Account, AdminRole, AdminTask, AssignableObject, Container, Endpoint, EndpointCapability, EndpointGroup, ExploreAndCorrelateDef, Grantor, Group, Namespace, Organization, PasswordPolicy, ProvisioningNonManagedObject, ProvisioningPolicy, ProvisioningPolicy, ProvisioningRole, Role, Task, User

public interface ManagedObject
extends NamedObject, AttributeCollection, java.io.Serializable

Provides access to the attributes of managed objects that extend this interface. Access to attributes is provided through the methods inherited from AttributeCollection.

Identity Manager administrators perform admin tasks against Identity Manager managed objects.

Managed objects can be any of the following kinds of objects:

• A logical view of objects defined in the Identity Manager Directory for a particular Identity Manager environment: User, Group, Organization.
  The Identity Manager logical objects represent the physical objects that are stored in the underlying user directory.
• Proprietary objects defined within an Identity Manager environment: AdminRole, AdminTask, AccessRole, AccessTask, PasswordPolicy.
• Objects defined in the eTrust Admin Directory associated with the Identity Manager environment: ProvisioningRole.

Managed objects can be accessed in a variety of ways:

• Through ProviderAccessor.
• Through the BLTHContext get... methods.
• Through an event. You retrieve event objects for the current task through EventContext or EventROContext.

Since:

IdentityMinder 5.6

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

void	directAddAttributeValue(java.lang.String attributeName, java.lang.String value) Directly updates the attribute on the managed object by adding or setting the value.
void	directRemoveAttributeValue(java.lang.String attributeName, java.lang.String value) Directly updates the attribute on the managed object by remove or clearing the value.
boolean	equals(java.lang.Object other) Internal use only.
void	fixUniqueNames(UniqueNameChangeHelper uniqueNameChanges) Called when secondary events are started to correct the unique name references to objects that may have just been created as part of the primary events.
ImsDirectory	getImsDirectory() Internal use only.
ImsEnvironment	getImsEnvironment() Internal use only.
ObjectType	getObjectType() Retrieves the type of this managed object.
Organization	getOrg(java.util.Enumeration attribs) Retrieves the organization that is the parent of the current object.
Organization	getOrg(TSContext context, AttributeRightsCollection attribs) Retrieves the organization that is the parent of the current object, and includes access permissions for the retrieved object's attributes.
ManagedObjectProvider	getProvider() Get managed object provider.
int	hashCode() Internal use only.
void	move(Organization newParent) Moves the object to a new organization.
boolean	persisted() Checks if the ManagedObject has been persisted.

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.NamedObject

getFriendlyName, getUniqueName, toString

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.AttributeCollection

addAttributes, addValueToAttribute, containsAttribute, doesAttributeHaveMultipleValues, enumerateAttributes, getAttribute, getAttributeMultiValue, getAttributePermission, getAttributes, getExtendedAttribute, getLastCommittedAttribute, getLastCommittedAttributeMultiValue, getLastCommittedValue, getOriginalAttribute, getOriginalAttributeMultiValue, getOriginalValue, getValue, hasAttributeChanged, isAttributeUncommitted, isUncommitted, makeCurrentValueOriginal, removeAttributes, setAttribute, setAttributeMultiValue, setAttributes, setValue, updateAttributeSet

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getObjectType

ObjectType getObjectType()

Retrieves the type of this managed object.

Returns:

An object representing the managed object type.

equals

boolean equals(java.lang.Object other)

Internal use only.

Specified by:

equals in interface java.util.Map

Specified by:

equals in interface NamedObject

Overrides:

equals in class java.lang.Object

Returns:

true if the objects are equal, or false otherwise.

hashCode

int hashCode()

Internal use only.

Specified by:

hashCode in interface java.util.Map

Specified by:

hashCode in interface NamedObject

Overrides:

hashCode in class java.lang.Object

persisted

boolean persisted()

Checks if the ManagedObject has been persisted.

Returns:

true if the ManagedObject has already been persisted, false if it has not

move

void move(Organization newParent)
          throws SmApiException

Moves the object to a new organization.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.NoSessionException

com.netegrity.sdk.apiutil.SmApiException

SmApiException

getOrg

Organization getOrg(java.util.Enumeration attribs)
                    throws SmApiException

Retrieves the organization that is the parent of the current object.

Every managed object contains a reference to its parent in the hierarchy. Typically, the parent is the organization where the object is located. In special cases where an object has no parent object -- for example, the root organization of a hierarchy, and roles and tasks (which are not contained in an organizational hierarchy) -- this method returns null.

Parameters:

attribs - An Enumeration of Strings containing names of the attributes to include in the retrieved object. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

The organization that contains the current object, or null if the object is not contained in an organization.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.NoSessionException

SmApiException

getOrg

Organization getOrg(TSContext context,
                    AttributeRightsCollection attribs)
                    throws SmApiException

Retrieves the organization that is the parent of the current object, and includes access permissions for the retrieved object's attributes.

Every managed object contains a reference to its parent in the hierarchy. Typically, the parent is the organization where the object is located.

This method returns null in special cases where an object has no parent object -- for example, the root organization of a hierarchy, and roles and tasks (which are not contained in an organizational hierarchy).

Parameters:

context - Context information for the current task session.

attribs - A collection of AttributeRight objects, each containing the name of an attribute to include in the retrieved objects, and the associated permission request.

Returns:

The organization that contains the current object, or null if the object is not contained in an organization.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.NoSessionException

SmApiException

getImsEnvironment

ImsEnvironment getImsEnvironment()
                                 throws SmApiException

Internal use only.

Throws:

SmApiException

getImsDirectory

ImsDirectory getImsDirectory()
                             throws SmApiException

Internal use only.

Throws:

SmApiException

directAddAttributeValue

void directAddAttributeValue(java.lang.String attributeName,
                             java.lang.String value)
                             throws SmApiException

Directly updates the attribute on the managed object by adding or setting the value. This should not modify this managed object. This should work for single and multi-valued attributes. Used primarily when updating relationships.

Parameters:

attributeName -

value -

Throws:

SmApiException

getProvider

ManagedObjectProvider getProvider()
                                  throws SmApiException

Get managed object provider.

Returns:

Managed object provider of the object

Throws:

SmApiException

directRemoveAttributeValue

void directRemoveAttributeValue(java.lang.String attributeName,
                                java.lang.String value)
                                throws SmApiException

Directly updates the attribute on the managed object by remove or clearing the value. This should not modify this managed object. This should work for single and multi-valued attributes. Used primarily when updating relationships.

Parameters:

attributeName -

value -

Throws:

SmApiException

fixUniqueNames

void fixUniqueNames(UniqueNameChangeHelper uniqueNameChanges)
                    throws SmApiException

Called when secondary events are started to correct the unique name references to objects that may have just been created as part of the primary events.

Parameters:

uniqueNameChanges -

Throws:

SmApiException