Activating Services Through SOAP > Configuration Tasks

Configuration Tasks

The tasks to configure the Dynamic Service Activator are:

1. Configuring Security for Gateway Clients
2. Accessing the Configuration Files
3. Configuring General Properties
4. Configuring Subscriber Types
5. Configuring the NIC Proxies
6. Configuring Access to Methods and Scripts
7. (Optional) Deleting Subscriber Types, NIC Proxies, Methods, Scripts, and Clients
8. Configuring the Logging Properties
9. Exporting Configuration Objects

Configuring Security for Gateway Clients

As described in the section Dynamic Service Activator Operation, Dynamic Service Activator interacts with the Web application server to determine whether a gateway client has access to a method or script. To configure security for gateway clients:

1. Configure the name and credentials, such as a password, that the Web application server uses to authenticate the gateway client.

You must use the same name for the gateway client when you define the scripts and methods to which the gateway client has access (see Configuring the NIC Proxies).

2. Assign gateway clients to the defined security role for Dynamic Service Activator.

The default role is DSAAuthorizedClient; if you want to change the default setting, you can edit the file dsa\WEB-INF\web.xml file, which you can extract from the dsa.war file. For information about extracting files from a WAR file, see Installing Dynamic Service Activator.

For information about these tasks, see the documentation for your Web application server, and the information about security at

http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html

Accessing the Configuration Files

Use SDX Configuration Editor to configure general properties for Dynamic Service Activator. For basic information about using SDX Configuration Editor, see SDX Software Basics Guide, Chapter 14, Using SDX Configuration Editor.

To access the new Dynamic Service Activator:

1. Start SDX Configuration Editor.
2. Import the sample data from the directory.
3. Open the WebApplication/DynamicServiceActivation.xml file and the WebApplication.xml file.

Configuring General Properties

The general properties for Dynamic Service Activator are settings that determine the global behavior of the application rather than the relationship between an individual gateway client and the application.

To configure general properties for Dynamic Service Activator:

1. In the DynamicServiceActivation.xml file, click the Dynamic Service Activation tab.

The Dynamic Service Activation pane appears.

2. Complete the properties.

Logging Subsystem Configuration Namespace

• Namespace that defines the properties for the logging operations.
• Value—Path, relative to the root namespace, that defines the object for the namespace
• Default—/WebApplication
• Property name—loggingNamespace

Disable Access Control Mechanism

• Setting that determines the type of access that gateway clients have to methods and scripts.
• Value

• True—Gateway clients have unrestricted access to all methods and scripts.
• False—Gateway clients have access only to methods and scripts that you specify in the configuration.

• Default—False
• Property name—disableAccessControls

Configuring Subscriber Types

You configure which types of information identify subscribers to the SAE. The subscriber types that you can configure in Configuration Editor are the same as the subscriber types that you can use in applications created with the SAE CORBA remote API.

To configure subscriber types:

1. In the DynamicServiceActivation.xml file, click the Subscriber Types tab to create a subscriber type.

The Subscriber Types pane appears.

2. Select Subscriber Type from the drop-down list next to the Create a New Instance of button, and click the Create a New Instance of button.

The instance name for the Subscriber Type is used to construct the subscriber's URI.

3. Configure the following mandatory properties.

Subscriber ID Type

• Type of information used to identify a subscriber.
• Value

• SIT_ADDRESS—Subscriber's IP address
• SIT_DN—Distinguished name of subscriber profile
• SIT_LOGIN_NAME—Subscriber's login name
• SIT_IF_NAME—Name of the interface and name of the virtual router to which the subscriber connects
• SIT_IF_INDEX—SNMP index of the interface and name of the virtual router to which the subscriber connects
• SIT_ADDR_IF_NAME—Subscriber's IP address, name of the managed interface, and name of the virtual router to which the subscriber connects
• SIT_PRIMARY_USER_NAME—Primary username

• Default—No value
• Property name—sidType

NIC Proxy Namespace

• Namespace that defines the properties for the NIC proxy operations for the specified subscriber ID type.
• Value—/nicProxies/<NIC proxy name>
• Guidelines—Each subscriber type must use a different NIC proxy. All NIC proxies for Dynamic Service Activator are stored in a /nicProxies directory.
• Default—No value
• Examples

• /nicProxies/ip for a SIT_ADDRESS subscriber type
• /nicProxies/dn for a SIT_DN subscriber type

• Property name—nicProxyNamespace

Configuring the NIC Proxies

You create a NIC proxy for each subscriber type to be configured. (See Configuring Subscriber Types.) Subscriber types that have different subscriber ID types can use the same NIC proxy. For example, a subscriber type configured as SubscriberType1 that has a subscriber ID type of SIT_IF_NAME, and a subscriber type configured as subscriberType2 that has a subscriber ID type of SIT_IF_INDEX can both use the same NIC proxy. Likewise, a subscriber type configured as SubscriberType1 and a subscriber type configured as subscriberType2 that both have a subscriber ID type of SIT_ADDRESS can use the same NIC proxy.

To configure NIC proxies, click the NIC Proxy Configurations tab in the DynamicServiceActivation.xml file.

A NIC proxy for Dynamic Service Activator is stored in the /nicProxies directory. The name of the NIC proxy must match the name configured in the Subscriber Types pane. For information about configuring NIC proxies, see SDX Components Guide, Vol. 2, Chapter 13, Configuring Applications to Communicate with an SAE.

Configuring Access to Methods and Scripts

Before configuring access to methods and scripts, determine how you want to organize the methods, scripts, and clients (see Prerequisite Tasks).

NOTE: Generally, to keep the organization simple, make all client objects subordinate to method and script objects.

Configuring access to methods and scripts involves adding methods, scripts, and clients to the directory, and configuring access properties between each client and each method or script.

To configure access to methods and scripts:

1. In the DynamicServiceActivation.xml file, click the Methods/Scripts tab to create a method or script.

The Methods/Scripts pane appears.

2. Select Method/Script from the drop-down list next to the Create a New Instance of button, and click the Create a New Instance of button.
3. If you created a method or script object, in the Methods/Scripts pane scroll down to the field List of clients who may invoke this method or script, and Select Client from the drop-down list next to the Create a New Instance of button and click the Create a New Instance of button.
4. Specify the properties for each combination of method or script and client in the Methods/Scripts pane.
5. Save the file.

Method or Script Name

• Method or script to activate on the SAE.
• Value—Text string that exactly matches the name of the method or script
• Property name—methodName

SAE Locator Index

• Zero-based index of the argument that Dynamic Service Activator should use to locate the SAE server on which to activate the method or script.
• Value—Integer in the range 0-4294967295
• Guidelines—For methods, set this value to 0.

Each method or script receives a set of arguments in the gateway client's SOAP request. For example, the second argument has the index 1 and could be a subscriber's IP address. Dynamic Service Activator would pass the argument to the NIC to locate the SAE managing that subscriber.

• Property name—saeLocatorArg

Constraints for Arguments (for methods and scripts)

• See Configuring Access Constraints.
• Guideline—This property is optional.

Client ID

• Name of the gateway client.
• Value—Text string that exactly matches the name the Web application server uses to authenticate the gateway client (see Configuring Security for Gateway Clients).
• Guidelines—If you disable the access control mechanism (see Configuring General Properties) and you configure the Web application server to authenticate clients with any username and password (see Configuring Security for Gateway Clients), Dynamic Service Activator sends the text string "anonymous client" as the first argument to the SAE's Java scripts interface module.
• Property name—clientID

Constraints for arguments (for clients)

• See Configuring Access Constraints.
• Guideline—This property is optional.

Configuring Access Constraints

Access constraints are regular expressions that the arguments for the method or script in the SOAP request must match. If the arguments for the method or script in a particular SOAP request do not match these regular expressions, then Dynamic Service Activator rejects the request. Access constraints are optional.

You use the fields labeled Constraints for arguments to specify the regular expressions. These fields comprise an entry box, a display table, and a set of action buttons.

To add optional access constraints:

1. Click in the entry box.
2. Enter the access condition in the format

<property>=<regularExpression>

• <property>—Zero-based index of the argument
• <regularExpression>—Regular expression

For information about the regular expression syntax, see

http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html

3. Click Add.

To modify optional access conditions:

1. Select the access condition you want to delete in the table.

The access condition appears in the entry box.

2. Modify the text in the entry box.
3. Click Modify.

The modified condition appears in the display table.

To delete optional access conditions:

1. Select the access condition you want to delete in the display table.
2. Click Delete.

Deleting Subscriber Types, NIC Proxies, Methods, Scripts, and Clients

You can delete configuration entries in the various panes from the DynamicServiceActivation.xml file.

To delete an instance of a configuration entry:

1. Select the configuration entry from the menu to the left of the field called Delete an Instance.
2. Click Delete an Instance.

The Confirmation dialog box appears.

3. Click OK.

SDX Configuration Editor deletes the method or client.

Configuring the Logging Properties

To configure logging properties:

1. With SDX Configuration Editor, access the WebApplication.xml file.

The Logging pane appears.

2. Configure the logging properties.

You can see default settings for logging in this file. For information about configuring logging, see SDX Components Guide, Vol. 1, Chapter 10, Configuring Logging for SDX Components.

3. Save the file.

Exporting Configuration Objects

Saving configuration changes in SDX Configuration Editor saves them only in the local configuration object. When you have configured the gateway applications, you must export the modified objects to the directory for the changes to take effect.

To export configuration changes back to the directory:

1. Select the project in the navigator pane, and hold down the right mouse button.
2. Select SDX System Configuration > Export to LDAP Directory.