Sun Identity Manager Service Provider 8.1 Deployment

Option Maps

Many of the LighthouseContext methods take an argument of type java.util.Map called an option map. This provides an extensible way to pass additional information into the function rather than through a lengthy list of arguments, or a large collection of different method signatures.

The map keys are always strings. The map values are usually strings or lists of strings. When an option value is treated as a boolean, the value may either be the strings true and false or a java.lang.Boolean object. When an object value is treated as an integer, it may either be a string or a java.lang.Integer object.

The options recognized by a particular method will be described in the documentation for that method. The following table lists some common options recognized by many methods.

Option	Description
user	Used to specify an alternate user name for auditing and locking. If you are using an authenticated context, the name of the authenticated user will be used by default. Specifying this option is recommended if you are using a shared anonymous context so that you can trace audit log entries back to a particular user.
allowNotFound	Used by methods that would ordinarily throw the ItemNotFound exception if you attempt to retrieve an object with an invalid name or id. When this boolean option is true, the method will silently return null or ignore the request rather than throwing an exception.
form	Specifies an alternate form to be used to process the view during check-out, refresh, and check-in.