com.netegrity.imapi
Interface LogicalAttributeContext

All Superinterfaces:

IMContext, Logger, ProviderAccessor, java.io.Serializable, ServiceProvider, TaskInfo

public interface LogicalAttributeContext
extends IMContext

Provides read and write access to the logical attribute(s) and any associated physical attributes for a particular logical attribute scheme.

This interface also provides access to IMContext information about the current task, to ProviderAccessor methods for direct access to the managed objects in the data store, and to logging methods and other Identity Manager services.

Identity Manager passes LogicalAttributeContext into each method it calls in LogicalAttributeAdapter.

There are two types of names associated with logical and physical attributes. Both are defined in the Identity Manager Management Console, through the following fields on the Logical Attribute Handler Properties screen:

• Name. The ID of the logical or physical attribute. You pass this value into the LogicalAttribteContext methods getLogicalAttributeName() and getPhysicalAttributeName() to retrieve the logical or physical attribute name that corresponds to the ID.
• Attribute Name. The logical or physical attribute name. This is the name that an administrator sees in the Identity Manager User Console when defining a task screen and associating attribute names with task screen fields. Unless otherwise specified, the attribute names used in LogicalAttribteContext methods are the names defined in Attribute Name.

Since:

IdentityMinder 5.6

Method Summary

java.util.Vector	getLogicalAttributeMultiValue(java.lang.String logicalAttributeName) Retrieves a Vector of all the values in a multi-value logical attribute.
java.lang.String	getLogicalAttributeName(java.lang.String propertyName) Retrieves the logical attribute name that corresponds to the specified logical attribute ID.
java.util.Enumeration	getLogicalAttributeNames() Retrieves the names of all the logical attributes associated with the current task.
java.lang.String	getLogicalAttributeValue(java.lang.String attributeName) Retrieves the value of the specified logical attribute.
java.util.Vector	getPhysicalAttributeMultiValue(java.lang.String physicalName) Retrieves a Vector of all the values in a multi-value physical attribute.
java.lang.String	getPhysicalAttributeName(java.lang.String propertyName) Retrieves the physical attribute name that corresponds to the specified physical attribute ID.
java.util.Enumeration	getPhysicalAttributesNames() Retrieves the names of all the physical attributes associated with the current task.
java.lang.String	getPhysicalAttributeValue(java.lang.String attributeName) Retrieves the value of the specified physical attribute.
boolean	isLogicalAttributeMultiValue(java.lang.String logicalAttributeName) Determines whether the specified logical attribute is a multi-value attribute or a single-value attribute.
boolean	isPhysicalAttributeMultiValue(java.lang.String physicalAttributeName) Determines whether the specified physical attribute is a multi-value attribute or a single-value attribute.
void	setLogicalAttributeMultiValue(java.lang.String logicalAttributeName, java.util.Vector values) Assigns multiple values to the specified logical attribute.
void	setLogicalAttributeValue(java.lang.String attributeName, java.lang.String attributeValue) Assigns a value to the specified logical attribute.
void	setPhysicalAttributeMultiValue(java.lang.String physicalAttributeName, java.util.Vector values) Assigns multiple values to the specified physical attribute.
void	setPhysicalAttributeValue(java.lang.String attributeName, java.lang.String attributeValue) Assigns a value to the specified physical attribute.

Methods inherited from interface com.netegrity.imapi.IMContext

getAuxDataRoot, getLocalizer, getLocalizer, getSessionAttribute, removeSessionAttribute, setSessionAttribute

Methods inherited from interface com.netegrity.imapi.Logger

logDebugMessage, logErrorMessage, logInfoMessage, logWarningMessage

Methods inherited from interface com.netegrity.imapi.TaskInfo

addErrorObject, addMessageObject, addMessageObject, addStatusDetail, createRuntimeStatusDetail, getActionType, getAdminFriendlyName, getAdministrator, getAdminTask, getAdminUniqueName, getAuthDirFriendlyName, getAuthDirUniqueName, getEnvironmentFriendlyName, getEnvironmentUniqueName, getObjectOrganization, getObjectOrganizationFriendlyName, getSessionCreateTime, getSessionId, getSiteMinderSessionId, getSiteMinderSessionSpec, getSiteMinderTransactionId, getSMHeader, getSubject, getSubjects, getTaskApplication, getTaskCategory, getTaskFriendlyName, getTaskUniqueName, getTSContext, getUserLocale, isAuditableTask, isTaskReadOnly, isWorkflowTask, sendAuditEvent

Methods inherited from interface com.netegrity.imapi.ServiceProvider

canUserAdministerGroup, convertLogicalToPhysical, convertPhysicalToLogical, decryptString, decryptString, doesSupportGroup, doesSupportOrganization, encryptString, encryptString, findAdminTask, getAllUsersAccessRoles, getGroupAdmins, getGroupMembers, getGroups, getGroupsAdminCanAdminister, getManagedObject, getManagedObjects, getManagedObjects, getOrg, getOrgMembers, getRootOrg, getSubOrgs, getTemporaryPassword, getTempPassword, isPasswordValid, isPasswordValid, isTopMostOrgWhichTaskIsBoundTo, validatePassword, validatePassword

Methods inherited from interface com.netegrity.imapi.ProviderAccessor

getAccessControlProvider, getAccessRoleProvider, getAccessTaskProvider, getAdminRoleProvider, getAdminTaskProvider, getAnalyticsEngineProvider, getEnvironmentSettingsProvider, getGroupProvider, getManagedObjectProvider, getOrganizationProvider, getProvisioningPolicyProvider, getProvisioningRoleProvider, getRelationshipProvider, getSecurityProvider, getSynchronizationProvider, getTabDefinitionProvider, getUserProvider

Method Detail

getLogicalAttributeValue

java.lang.String getLogicalAttributeValue(java.lang.String attributeName)

Retrieves the value of the specified logical attribute. If the attribute is a multi-value attribute, only the first value is retrieved.

Parameters:

attributeName - The name of the logical attribute whose value is being retrieved.

Returns:

The logical attribute value.

getPhysicalAttributeValue

java.lang.String getPhysicalAttributeValue(java.lang.String attributeName)

Retrieves the value of the specified physical attribute. If the attribute is a multi-value attribute, only the first value is retrieved.

Parameters:

attributeName - The name of the physical attribute whose value is being retrieved.

Returns:

The physical attribute value.

setLogicalAttributeValue

void setLogicalAttributeValue(java.lang.String attributeName,
                              java.lang.String attributeValue)
                              throws java.lang.Exception

Assigns a value to the specified logical attribute.

Parameters:

attributeName - The logical attribute being assigned a value.

attributeValue - The value to assign to the logical attribute.

Throws:

java.lang.Exception

setPhysicalAttributeValue

void setPhysicalAttributeValue(java.lang.String attributeName,
                               java.lang.String attributeValue)
                               throws java.lang.Exception

Assigns a value to the specified physical attribute.

Parameters:

attributeName - The physical attribute being assigned a value.

attributeValue - The value to assign to the physical attribute.

Throws:

java.lang.Exception

getLogicalAttributeMultiValue

java.util.Vector getLogicalAttributeMultiValue(java.lang.String logicalAttributeName)

Retrieves a Vector of all the values in a multi-value logical attribute. If only one value is defined, the value is returned in a Vector of one.

Parameters:

logicalAttributeName - The name of the multi-value logical attribute whose values are being retrieved.

Returns:

The values in the multi-value logical attribute.

getPhysicalAttributeMultiValue

java.util.Vector getPhysicalAttributeMultiValue(java.lang.String physicalName)

Retrieves a Vector of all the values in a multi-value physical attribute. If only one value is defined, the value is returned in a Vector of one.

Parameters:

physicalName - The name of the multi-value physical attribute whose values are being retrieved.

Returns:

The values in the multi-value physical attribute.

setPhysicalAttributeMultiValue

void setPhysicalAttributeMultiValue(java.lang.String physicalAttributeName,
                                    java.util.Vector values)
                                    throws java.lang.Exception

Assigns multiple values to the specified physical attribute.

Parameters:

physicalAttributeName - The name of the physical attribute to which multiple values are being assigned.

values - The values being assigned to the physical attribute.

Throws:

java.lang.Exception

setLogicalAttributeMultiValue

void setLogicalAttributeMultiValue(java.lang.String logicalAttributeName,
                                   java.util.Vector values)
                                   throws java.lang.Exception

Assigns multiple values to the specified logical attribute.

Parameters:

logicalAttributeName - The name of the logical attribute to which multiple values are being assigned.

values - The values being assigned to the logical attribute.

Throws:

java.lang.Exception

isLogicalAttributeMultiValue

boolean isLogicalAttributeMultiValue(java.lang.String logicalAttributeName)

Determines whether the specified logical attribute is a multi-value attribute or a single-value attribute.

Parameters:

logicalAttributeName - The logical attribute in question.

Returns:

true if the attribute is a multi-value attribute, or false if it is a single-value attribute.

isPhysicalAttributeMultiValue

boolean isPhysicalAttributeMultiValue(java.lang.String physicalAttributeName)

Determines whether the specified physical attribute is a multi-value attribute or a single-value attribute.

Parameters:

physicalAttributeName - The physical attribute in question.

Returns:

true if the attribute is a multi-value attribute, or false if it is a single-value attribute.

getLogicalAttributeName

java.lang.String getLogicalAttributeName(java.lang.String propertyName)

Retrieves the logical attribute name that corresponds to the specified logical attribute ID.

You pass the retrieved attribute name into LogicalAttributeContext methods that set or retrieve logical attribute values.

Parameters:

propertyName - The attribute ID as defined in the Name field of the Logical Attribute Properties dialog box of the Identity Manager Management Console.

Returns:

The logical attribute name.

getPhysicalAttributeName

java.lang.String getPhysicalAttributeName(java.lang.String propertyName)

Retrieves the physical attribute name that corresponds to the specified physical attribute ID.

You pass the retrieved attribute name into LogicalAttributeContext methods that set or retrieve physical attribute values.

Parameters:

propertyName - The attribute ID as defined in the Name field of the Logical Attribute Properties dialog box of the Identity Manager Management Console.

Returns:

The physical attribute name.

getLogicalAttributeNames

java.util.Enumeration getLogicalAttributeNames()

Retrieves the names of all the logical attributes associated with the current task.

Returns:

The logical attribute names.

getPhysicalAttributesNames

java.util.Enumeration getPhysicalAttributesNames()

Retrieves the names of all the physical attributes associated with the current task.

Returns:

The physical attribute names.