getUser Action (Sun Identity Manager 8.1 Resources Reference)

Sun Identity Manager 8.1 Resources Reference

getUser Action

The getUser action retrieves one of the following from the host application:

A string of screens or responses from which the adapter can parse the user attributes for a given user.
A map of user attributes for a given user.

The getUser action must be defined.

Context

The actionContext map will contain the following entries:

Key	Value Type	Value Description
`hostAccess`	com.waveset.adapter.HostAccess	Provides 3270 emulation access to a mainframe.
`adapter`	com.waveset.object.ScriptedHostResourceAdapter	Adapter instance
`action`	java.lang.String	The string `getUser`.
`attrsToGet`	java.util.List	List of strings identifying the user attributes to be fetch. This list is derived from the right-hand side of the schema map.
`id`	java.lang.String	Account ID of the user to fetch
`errors`	java.util.List	This is initially an empty list. The script must add java.lang.String objects to this list if any errors are found during processing.
`trace`	com.waveset.adapter.Trace	An object used to trace execution. Scripts can use methods of this class to make itself “debuggable” in a customer environment.
`result`	java.util.Map	The script adds entries to the map to return user attributes. See the entry table below.

The result map is expected to be populated by the script with the following entries:

Key	Value Type	Value Description
`text`	String	Contains the text to be parsed for the user attributes. This may be the contents of one or more screens or responses. The user attributes will be extracted from this string later using the AttrParse object named in the `attrParse` entry of this map. Do not put this entry into the map if no matching user is found. Do not add this field to the map. Populate the `attrMap` map instead.
`attrParse`	String	Name of an AttrParse object which will be used by the adapter to parse user attributes from the string found in the `text` entry of this map. Set this entry only in combination with setting the `text` entry.
`attrMap`	java.util.Map	If the script is capable of directly retrieving the user attributes, then the script can set this entry with a map of the user attributes. Note that this `attrMap` entry is respected by the adapter only if the `text` entry of this map is not present.

Key

Value Type

Value Description

text

String

Contains the text to be parsed for the user attributes. This may be the contents of one or more screens or responses.

The user attributes will be extracted from this string later using the AttrParse object named in the attrParse entry of this map. Do not put this entry into the map if no matching user is found.

Do not add this field to the map. Populate the attrMap map instead.

attrParse

String

Name of an AttrParse object which will be used by the adapter to parse user attributes from the string found in the text entry of this map. Set this entry only in combination with setting the text entry.

attrMap

java.util.Map

If the script is capable of directly retrieving the user attributes, then the script can set this entry with a map of the user attributes. Note that this attrMap entry is respected by the adapter only if the text entry of this map is not present.

Error Handling

If there is no matching user found, then the result map should be left empty.

If any application-specific errors are found in a screen or response, the script should add appropriate strings to the errors key. Determining that an error has occurred may require a string search for various known error strings.

The presence of any items in the errors List is considered a retrieval failure. Additionally, any throw from within the script is considered a retrieval failure.