Sun Identity Manager 8.1 Resources Reference

Configuration Notes

Connection Parameters

The SPML Connector configuration parameters include:

Table 58–1 SPML Connection Parameters

Connection Parameter 

Description 

Login user

username to use when connecting to the SPML 2 server 

password

password use when connecting to the SPML 2 server 

Target System Url

URL of the SPML2 server 

Scripting Parameters

Scripting parameters include scripting language, which defines the scripting language that you use to write scripts. Groovy support is included with the connector framework. Since SPML 2.0 does not specify how to establish and maintain a session, the SPML 2.0 connector allows scripts to be performed at specified points in the execution so that session management can be performed. These points of execution include:

After a connection has been established, the Post-Connect script is run with the following variables defined.

Table 58–2 Post-Connect Scripting Variables

Scripting Variable 

Description 

connection

the com.sun.openconnectors.framework.spi.Connection just established 

username

username specified for the connection 

password

password specified for the connection 

memory

java.util.Map that is persisted between script executions 

Before a request is sent, the Pre-Send script is run with the following variables defined.

Table 58–3 Pre-Send Scripting Variables

Scripting Variable 

Description 

request

the org.openspml.v2.msg.Request about to be sent 

memory

java.util.Map persisted between script executions 

After a response is received, the Post-Receive script is run with the following variables defined.

Table 58–4 Post-Receive Scripting Variables

Scripting Variable 

Description 

response

the org.openspml.v2.msg.Response just received 

memory

java.util.Map persisted between script executions 

Before a connection is terminated, the Pre-Disconnect script is run with the following variables defined.

Table 58–5 Pre-Disconnect Scripting Variables

Scripting Variable 

Description 

connection

the com.sun.openconnectors.framework.spi.Connection about to be terminated 

username

username specified for the connection 

password

password specified for the connection 

memory

java.util.Map persisted between script executions 

Additionally, you can execute scripts to change the attributes before the attributes are sent to the server, or after they are received back from the server. This can be necessary since the connector framework uses reserved names for some attributes (for example, NAME for name) that may not correspond to the names used by the server.

You can execute a script to modify attribute names during create and modify operations. This script should return the name to be used. The following variables will be available to the Map 'set' Name script:

Table 58–6 Map 'set' Name Scripting Variables

Scripting Variable 

Description 

name

name of the attribute 

objectclass

name of the object class 

configuration

the SPML configuration object 

memory

java.util.Map that is persisted between script executions 

You can execute a script to modify attributes that are returned as a result of search operations. The script should return the attribute to be used. The following variables will be available to the Map Attribute script:

Table 58–7 Map Attribute Scripting Variables

Scripting Variable 

Description 

attribute

com.sun.openconnectors.framework.common.objects. Attribute 

objectClass

name of the object class 

configuration

SPMLConfiguration object 

memory

java.util.Map persisted between script executions 

You can execute a script to modify attributes that are returned during query operations. The script should return the name to be used. The Map 'query' Name script should return the name to be used.

Table 58–8 Map 'query' Name Scripting Variables

Scripting Variable 

Description 

name

name of the attribute 

configuration

SPML configuration object 

memory

java.util.Map persisted between script executions 

Finally, you must specify a mapping between the SPML object classes and the Connector Framework object classes. This is done with a table containing one row for each supported Connector Framework object class (for example, __ACCOUNT__) and four columns that contain :