The SPML Connector can provision users to any SPML 2.0 server.
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 are:
- After a connection has been established.
The following variables will be available to the script:
- connection -- the com.sun.openconnectors.framework.spi.Connection just established
- username -- the username specified for the connection
- password -- the password specified for the connection
- memory -- a java.util.Map persisted between script executions
- Before a Request is sent.
The following variables will be available to the script:
- request -- the org.openspml.v2.msg.Request about to be sent
- memory -- a java.util.Map persisted between script executions
- After a Response is received.
The following variables will be available to the script:
- response -- the org.openspml.v2.msg.Response just received
- memory -- a java.util.Map persisted between script executions
- Before a connection is disposed.
The following variables will be available to the script:
- connection -- the com.sun.openconnectors.framework.spi.Connection about to be disposed
- username -- the username specified for the connection
- password -- the password specified for the connection
- memory -- a java.util.Map persisted between script executions
Additionally, scripts can be executed to change the Attributes before they 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 (such as '__PASSWORD__'
for password) that may not correspond to the names used by the server.
- A script can be executed to modify attribute names on Create and Modify.
The script should return the name to be used.
The following variables will be available to the script:
- name -- the name of the attribute
- objectClass -- the name of the objectClass
- configuration -- the SPMLConfiguration object
- memory -- a java.util.Map persisted between script executions
- A script can be executed to modify Attributes returned by Search.
The script should return the Attribute to be used.
The following variables will be available to the script:
- attribute -- the com.sun.openconnectors.framework.common.objects.Attribute
- objectClass -- the name of the objectClass
- configuration -- the SPMLConfiguration object
- memory -- a java.util.Map persisted between script executions
- A script can be executed to modify attribute names on Search.
The script should return the name to be used.
The following variables will be available to the script :
- name -- the name of the attribute
- configuration -- the SPMLConfiguration object
- memory -- a java.util.Map persisted between script executions