com.tivoli.pd.rgy.RgyEntity

Edit online

RgyEntity provides methods common to RgyUser and RgyGroup interfaces.

This section explains the following methods:
getId() and getNativeId()

Provide the Verify Identity Access ID for the user or group with getId() and the native registry ID with getNativeId(). This product supports only LDAP registries. The registry native ID is an LDAP Distinguished Name. The value of Verify Identity Access ID is null if the LDAP account does not have any associated Verify Identity Access identity.

Example :
  • getId() returns a string similar to sec_master.
  • getNativeId() returns a string similar to cn=SecurityMaster,secAuthority=Default.

Prototype:

String getId();
String getNativeId();
attributeNameIterator(), getOneAttributeValue(), and getAttributeValues()

You can obtain available attribute names using the attributeNameIterator() method.

getOneAttributeValue() is a convenience method you can use when you are sure that the attribute has only one value.

The getAttributeValues() Verify Identity Access returns the attribute values as an array of objects.

All the value objects in the array are in the same class as a string or byte array. The cached values in the RgyEntity for the attributes are never read again from the registry. You must fetch a new instance of the entity using the RgyRegistry to ensure that the attribute values are the latest.

Prototype: 
Iterator <String> attributeNameIterator();
Object getOneAttributeValue(String name);
Object[] getAttributeValues(String name);
attributeDelete(), attributeReplace(), and attributeAdd()

Modify the attributes of entities with these methods. Attribute values are either a string or byte. If an attribute has multiple values, you can supply all the values as objects. All objects in the array can represent the same class. The API updates the values of both RgyEntity and the attributes from the cache to the registry.

Prototype: void attributeDelete(String name) throws RgyException; void attributeDelete(String name, Object value) throws RgyException; void attributeDelete(String name, Object[] values) throws RgyException; void attributeReplace(String name, Object value) throws RgyException; void attributeReplace(String name, Object[] values) throws RgyException; void attributeAdd(String name, Object value) throws RgyException; void attributeAdd(String name, Object[] values) throws RgyException;
Note: The Delete, Replace, or Add method of the RgyEntity updates the cached values only for the instance on which the method is invoked.
getDomain() and getRgyRegistry()

getDomain() returns a specific domain when RgyRegistry fetches the entity.

getRgyRegistry() returns the RgyRegistry instance that instantiated the RgyEntity instance.