The following table describes the different ExtendedRequest classes that you can use to send messages to and receive messages from the client.
Table 1–4 ExtendedRequest Classes for Sending and Receiving Messages
ExtendedRequest Class |
Description |
---|---|
changeUserPassword |
Constructs a message to request a user password change. |
deleteUser |
Constructs a message to request a user deletion. |
disableUser |
Constructs a message to request the disabling of a user. |
enableUser |
Constructs a message to request the enabling of a user. |
launchProcess |
Constructs a message to request the launch of a process. |
listResourceobjects |
Constructs a message to request the name of a resource object in the Waveset repository, and the type of object supported by that resource. The request returns a list of names. |
reloadConfiguration |
Reloads the SPML Configuration object. |
resetUserPassword |
Constructs a message to request the reset of a user password. |
runForm |
Allows you to create custom SPML requests that return information obtained by calling the Waveset Session API. |
soapTrace |
Enables tracing. |
The server code converts each ExtendedRequest into a view operation.
The following examples illustrate the typical formats for an ExtendedRequest and its classes:
The following example shows the typical format for an ExtendedRequest.
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("changeUserPassword"); req.setAttribute("accountId", "exampleuser"); req.setAttribute("password", "xyzzy"); req.setAttribute("accounts","Lighthouse,LDAP,RACF"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
Most SPML ExtendedRequest requests accept the following arguments:
accountId – Identifies the Waveset user name.
accounts – Presents resource names in a comma-delimited list.
If you pass an accounts argument, the specified SPML operation only updates the specified resources. You must include the Lighthouse attribute in a non-null accounts list if you want to update the Waveset user in addition to specific resource accounts.
If you do not pass an accounts argument, the operation updates all resource accounts linked to the user, including the Waveset user account.
The following example shows the typical format for a deleteUser request (View -> Deprovision view).
If you customize this request, there might be side effects.
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("deleteUser"); req.setAttribute("accountId","exampleuser"); req.setAttribute("accounts","Lighthouse,LDAP,RACF"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
The following example shows the typical format for a disableUser request (View -> Disable view).
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("disableUser"); req.setAttribute("accountId","exampleuser"); req.setAttribute("accounts","Lighthouse,LDAP,RACF"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
The following example shows the typical format for an enableUser request (View -> Enable view).
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("enableUser"); req.setAttribute("accountId","exampleuser"); req.setAttribute("accounts","Lighthouse,LDAP,RACF"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
The following example shows the typical format for a launchProcess request (View -> Process view).
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("launchProcess"); req.setAttribute("process", "my custom process"); req.setAttribute("taskName", "my task instance"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
where:
launchProcess – Starts the custom processes.
process – Name of the TaskDefinition object in the Waveset repository to start.
taskName – Name of the task needed to start the workflow.
The task instance object holds the runtime state of the process.
The remaining attributes are arbitrary and they are passed into the task.
The following example shows the typical format for a listResourceObjects request.
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("listResourceObjects"); req.setAttribute("resource", "LDAP"); req.setAttribute("type", "group"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
where:
resource – Specifies the name of a resource object in the Waveset repository.
type – Specifies the object type supported by that resource.
The following example shows the typical format for a reloadConfiguration request.
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("reloadConfiguration"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
The following example shows the typical format for a resetUserPassword request (View -> Reset User Password view).
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("resetUserPassword"); req.setAttribute("accountId","exampleuser"); req.setAttribute("accounts","Lighthouse,LDAP,RACF"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
The following example shows the typical format for a runForm request.
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("runForm"); req.setAttribute("form", "SPML Get Object Names"); ExtendedResponse res = (ExtendedResponse) client.request(req); |
where form is the name of a configuration object containing a form.
The following example shows the typical format for a soapTrace request.
ExtendedRequest req = new ExtendedRequest(); req.setOperationIdentifier("soapTrace"); ExtendedResponse res = (ExtendedResponse) client.request(req); |