Using the AquaLogic Service Bus Plug-in for WorkSpace Studio

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

User Interface Reference

This section describes all the views, dialogs, wizards, and other user interface objects in the ALSB plug-in.

Alerts

The following pages are provided for managing alerts:

Alert Destination editor

An alert destination is a destination address for alert notifications in ALSB. Use this page to configure an alert destination resource. For more information, see Alert Destinations in Using the AquaLogic Service Bus Console.

Option
Description
Description
Enter a description for this alert destination.
SNMP Trap
If you specify SNMP Trap, alerts are sent as SNMP traps, and can be processed by any third-party enterprise monitoring systems (ESM).
Reporting
If you specify Reporting, alerts are sent to the ALSB Reporting module and can be captured using a custom reporting provider that can developed using the reporting APIs provider by AquaLogic Service Bus. This allows third-parties to receive and process alerts in custom Java code.

Continue in the Edit Alert Destination page. Click Add to add e-mail and JMS recipients to an alert destination. See:

For more information, see Adding E-Mail and JMS Recipients in Using the AquaLogic Service Bus Console.

Edit E-mail Recipient page

Use this page to configure the destination target for an alert sent via e-mail (that is, using the e-mail transport). For more information, see Adding E-Mail Recipients in Using the AquaLogic Service Bus Console.

Option
Description
Mail Recipients
Enter an e-mail recipient in the format: mailto:username@hostname
You can specify multiple e-mail recipients by entering the user names and hostnames in a comma-separated list. For example, mailto:username@hostname
[,username_1@hostname_1]...[,username_n@hostname_n]
Only the first mail recipient needs to be prefixed with the text “mailto:”. However doing so is optional; the code will add it if it is missing.
SMTP Server
Select the name of the SMTP server for the outgoing e-mail. This field is not required if Mail Session is selected in the next field. These fields are mutually exclusive; it is an error to configure both.
Mail Session
Select an available mail session. This field is not required if an SMTP Server is selected in the previous field. These fields are mutually exclusive; it is an error to configure both.
From Name
Provide a sender’s name for the alert notification. This field is optional.
From Address
Provide a valid e-mail address. This field is required if a value for the From Name field is specified.
Reply To Name
Provide a name to which a reply may be addressed. This field is optional.
Reply To Address
Provide an e-mail address to which a reply may be sent. This field is required if a value for the Reply To Name field is specified.
Connection Timeout
Enter the number of seconds a connection must wait for a response from the server before timing out. The default value is 0.
Request Encoding
Enter a character set encoding value. The default encoding value is iso-8859-1.

Edit JMS Destination page

Use this page to configure the destination target for an alert sent via JMS (that is, using the JMS transport). For more information, see Adding JMS Recipients in Using the AquaLogic Service Bus Console.

Option
Description
Destination URI
Enter a JMS destination URI in the format: jms://host:port/factoryJndiName/destJndiName
Destination Type
Select Queue or Topic.
Message Type
Select Bytes or Text.
Request Encoding
Enter a character set encoding value. The default encoding value is iso-8859-1.

AquaLogic Business Service Configuration

You configure new business services while creating them in the New AquaLogic Business Service wizard. You can view and modify those settings in the AquaLogic Business Service editor: With a few exceptions, configuration options are identical in the wizard and the editor and are therefore documented in one place. The wizard and editor business service configuration pages are:

Business Service General Configuration page

Use the AquaLogic Business Service General Configuration page to specify general configuration settings for a business service. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor. Options vary, depending on whether you are using the wizard or the editor, as described below.

New AquaLogic Business Service Wizard Options

The following table describes the options in the wizard:

Option
Description
Description
Enter a description for this service.
Service Type - Create a New Service (wizard only)
A service type defines the types and packaging of the messages exchanged by the service. Select the type of business service to create:
WSDL Web Service
Select this option to create a business service based on a WSDL. Then, enter the WSDL name, qualified by its path (for example, myProject/myFolder/myWSDL). Alternatively, click Browse to select a WSDL resource.
(port or binding) - Enter the name of a port (defined in the WSDL) to describe an actual transport address, or enter the name of a binding (defined in the WSDL) to map to a transport address. If you use Browse to select a WSDL, as described above, the Select a WSDL Definition dialog lists any ports and bindings defined in the WSDL. When you choose a port or a binding on that page, the (port or binding) field is filled with the selected name.
Transport Typed Service
Select this option to create a service that uses EJB transport.
Messaging Service
Select this option to create a service that exchanges messages of different content-types. These exchanges can be either request/response or one-way. They can also have a response with no request when used with the HTTP ‘GET’ option for the HTTP transport. Unlike Web Services, the content-type of the request and response need not be the same.
Any SOAP Service
Select this option to create a SOAP service that does not have an explicitly defined, concrete interface.
Select SOAP 1.1 or SOAP 1.2 from the drop-down list to specify the SOAP version to be used.
Any XML Service
Select this option to create an XML service that does not have an explicitly defined, concrete interface.
HTTP GET is only supported for messaging services and this service type.
Service Type - Create From Existing Service
Choose one of these options to create a service based on another service.
Business Service
Select this option to clone an existing business service.
Enter the path (project/folder) and the name of the business service; or click Browse to select a service.
Since ALSB does not accept the same URI for multiple services, you must change the URI for the cloned service.
Proxy Service
Select this option to create a business service based on an existing proxy service.
Enter the path (project/folder) and the name of the proxy service; or click Browse to select a service.
Since ALSB does not accept the same URI for multiple services, you must change the URI for the cloned service.

AquaLogic Business Service Editor Options

The following table describes the options in the editor:

Option
Description
Description
Enter or modify a description for this service.
Service Type (editor only)
This option shows the service type of the business service. You can change only some of the properties of some of the service types:
  • WSDL Web Service - You can enter (or click Browse to select) a different port or binding from the same WSDL. You can also specify a different WSDL, but by doing so, you are effectively creating a new service and you will have to configure it as if it were a new service.
  • Transport Typed Service - This option cannot be modified.
  • Messaging Service - This option cannot be modified.
  • Any SOAP Service - You can change the SOAP version (SOAP 1.1 or SOAP 1.2)
  • Any XML Service - This option cannot be modified.

Business Service Message Type Configuration page

Use the AquaLogic Business Service Message Type Configuration page to configure message types for a business service whose type is Messaging Service. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor:

The binding definition for messaging services consists of configuring the content-types of the messages that are exchanged. The content-type for the response does not need to be the same as for the request; therefore, the response is configured separately (for example, the service could accept an MFL message and return an XML acknowledgment receipt).

Note: E-mail, File, FTP, or SFTP transport business services whose type is Messaging Service support one-way messaging only; the Response Message Type should be None. If you select an option other than None, the file, ftp, or sftp protocol will not be available on the Transport Configuration page.

Option
Description
Request Message Type
Select a message type for the request message:
  • None - Select this option if there is no request message (HTTP GET example)
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Response Message Type
Select a message type for the response message:
  • None - Select this option if there is no response message.
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Business Service Service Policy Configuration page

Use the AquaLogic Business Service Service Policy Configuration page to configure service policy settings for a proxy service. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor.

Option
Description
WSDL-Based Policy
Select this option if the service policy is associated with the WSDL upon which the service is based.
Custom Policy Bindings
Select this option to add service-level policies, operation-level policies (in which case the policy applies to both the request and response messages), request policies, and response policies directly.
For more information about configuring service policies, see Configuring Message Level Security for Web Services in the AquaLogic Service Bus Security Guide.

Business Service SOAP Binding Configuration page

Use AquaLogic Business Service SOAP Binding Configuration page to configure the SOAP Binding for a business service based on a WSDL. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor:

Select or deselect Enforce WS-I Compliance to specify whether or not the service is to conform to the Basic Profile defined by the Web Services Interoperability Organization. This option is available for or SOAP 1.1 services only

When a service is marked WS-I compliant, checks are performed against the messages sent to and from that service.

Business Service Transport Configuration page

Use the AquaLogic Business Service Transport Configuration page to select, review, or change the service’s transport protocol and to set, review, or change general transport configuration settings. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor:

Outbound transport-level security applies to the connections between ALSB proxy services and business services. For more information about transport-level security, see Configuring Transport-Level Security in the AquaLogic Service Bus Security Guide.

Option
Description
Protocol
Select a transport protocol from the list. The protocols available differ, depending on the service type:
  • WSDL Web Service: DSP, HTTP, JMS, JPD, SB, WS
  • Transport-Typed Service: EJB, Flow
  • Messaging Service: E-mail, File, FTP, HTTP, JMS, MQ (if available), SFTP, Tuxedo
  • Any SOAP Service: DSP, HTTP, JMS, JPD, SB
  • Any XML Service: DSP, E-mail, File, FTP, HTTP, JMS, JPD, MQ (if available), SB, SFTP, Tuxedo
Load Balancing Algorithm
Select one of these load-balancing algorithms:
  • Round-robin - This algorithm dynamically orders the URLs that you enter in the Endpoint URI field for this business service. If the first one fails, it tries the next one, and so on until the retry count is exhausted.
  • For every new message, there is a new order of URLs.

  • Random - This algorithm randomly orders the list of URLs that you enter in the Endpoint URI field for this business service. If the first one fails, it tries the next one, and so on until the retry count is exhausted.
  • Random-weighted - This algorithm randomly orders the list of URLs that you enter in the Endpoint URI field for this business service, but some are retried more than others based on the value you enter in the Weight field.
  • None - This algorithm orders the list of URLs that you enter in the Endpoint URI field for this business service from top to bottom.
Endpoint URI
Enter an endpoint URL in the format based on the transport protocol you selected in the Protocol field, above: The formats are:
  • DSP - t3://dsp-ip-address:port/dsp-app-name
  • EJB - ejb:provider:jndiname
  • In the URI, provider is the name of the JNDI provider resource, and JNDIname is the JNDI name in the JNDI server for the EJB.

    If the JNDI provider is located on the same server, the JNDI provider need not be specified. The URI then would be ejb::jndiname

  • E-mail - mailto:foo@bar.com
  • File - file:///root-dir/dir1
  • FTP - ftp://hostname:port/directory
  • HTTP - http://host:port/someService
  • The HTTP transport supports both HTTP and HTTPS endpoints.

  • JMS - jms://host:port[,host:port]*/factoryJndiName/destJndiName
  • To target a JMS destination to multiple servers, use the following URI format:
    jms://host1:port,host2:port/QueueConnectionFactory/DestName

  • JPD - jpd:[<provider>]:<jpd_uri>
  • provider (optional) is the name of the JNDI provider which corresponds to the WLI JNDI provider resource. When omitted, the JNDI provider on the local server is used.

    <jpd uri> is the relative URL of the JPD on the WLI server. For example, if processes.Process.jpd is in the SampleApp Web project, then the relative URL of the JPD is /SampleApp/processes/Process.jpd.

  • MQ - mq://local-queue-name?conn=mq-connection-resource-ref
  • local-queue-name is the name of the MQ queue from which the business service reads messages.

    mq-connection-resource-ref is the path (project/folder) and name of the MQ connection resource; for example, default/my_MQconnection.

    To make the MQ transport available in ALSB, see MQ Connections in Using the AquaLogic Service Bus Console.

  • SB - sb://<jndi_provider_name/>service_name
  • jndi_provider_name (optional) is the name of the ALSB JNDI provider resource. When omitted, the default context is used.

    service_name is a target service and corresponds to the remote proxy service URI.

  • SFTP - sftp://hostname:port/directory
Endpoint URI (continued)
  • Tuxedo - tuxedo:resourcename/remotename
  • tuxedo-queue:sendQSpace/sendQName[/[rcvQspace:]rvcQname][/failureQname]

    In the URI, resourcename corresponds to a WTC Import name and remotename corresponds to the service name exported by the remote Tuxedo domain. The URI resourcename is required, and the remotename is optional.

    If more than one URI is specified, you must have unique resource names for the endpoints. If no remote name is specified, its value is the value of the resource name. If no remote name is entered or if remote and resource name are the same, only one URI is allowed. In this case resource name and remote name have the same value. This allows already defined WTC Imports to make use of WTC load-balancing and failover. For more information, see AquaLogic Service Bus Interoperability Solution for Tuxedo.

  • WS - http://host:port/someService

Note: ALSB no longer supports duplicate endpoint URIs within the same business service.

Click Add to add one or more additional URIs. At run time, the URLs are selected based on the load balancing algorithm you selected in the Load Balancing Algorithm field.
If you selected Random-weighted in the Load Balancing Algorithm field, you can also enter a weight in the Endpoint URI field. The default is 1.
If you have multiple endpoint defined, and you selected None in the Load Balancing Algorithm field, the order of endpoints is significant. You can reorder the endpoints using the Up and Down buttons.
ALSB does not support duplicate endpoint URIs within the same business service.
Retry count
In case of delivery failure when sending outbound requests, specify the number of times to retry individual URL endpoints; in other words, the number of failover attempts.
For example, a business service has one configured URI (U1) and the number of retries is set to 3. If U1 fails on the first attempt, the system retries the U1 endpoint 3 more times.
If a business service has 2 configured URIs (U1 and U2) and a retry count of 3, if the first attempt (for example, to U1) fails, the system tries (fails over to) the next URI (U2). If that also fails, the system makes two more attempts, once to U1 and once to U2.
Retry Iteration Interval
Specify the number of seconds the system pauses before iterating over all the endpoint URIs in the list again.
For example, a business service has two configured URIs (U1 and U2) and a retry count of 2 with a retry iteration interval of 5 seconds. If the first attempt (to U1) fails, the system tries U2 right away. But if U2 also fails, the system waits for 5 seconds and retries U1 once more.
Retry Application Errors
Select Yes or No.
In case of delivery failure when sending outbound requests, specify whether or not to retry endpoint URIs based on application errors (for example, a SOAP fault).

AquaLogic Proxy Service Configuration

You configure new proxy services while creating them in the New AquaLogic Proxy Service wizard. You can view and modify those settings in the AquaLogic Proxy Service editor: With a few exceptions, configuration options are identical in the wizard and the editor and are therefore documented in one place. The wizard and editor business service configuration pages are:

Proxy Service General Configuration page

Use the AquaLogic Proxy Service General Configuration page to set or modify general configuration properties for a proxy service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor: Options vary, depending on whether you are using the wizard or the editor, as described below.

New AquaLogic Proxy Service Wizard Options

The following table describes the options in the wizard:

Option
Description
Description
Enter a description for this proxy service.
Service Type - Create a New Service
Select the type of proxy service to create, as described below.
WSDL Web Service
Select this option to create a proxy service based on a WSDL. Then enter the WSDL name, qualified by its path (for example, myProject/myFolder/myWSDL). Alternatively, click Browse to select a WSDL resource.
(port or binding) - Enter the name of a port (defined in the WSDL) to describe an actual transport address, or enter the name of a binding (defined in the WSDL) to map to a transport address. If you use Browse to select a WSDL, the Select a WSDL Definition dialog lists any defined ports and bindings.

Note: If you are going to use the SOAP Body Type for operations, ensure that the WSDL does not have two operations with the same input message. The SOAP Body Type operation cannot be uniquely identified by inspecting the input message.

Messaging Service
Select this option to create a service that can receive messages of one data type and respond with messages of a different data type. These exchanges can be either request/response or one-way.
(HTTP GET is supported only in the Any XML Service and Messaging Service service types.)
Any SOAP Service
Select this option to create a SOAP service that does not have an explicitly defined, concrete interface.
Select SOAP 1.1 or SOAP 1.2 from the drop-down list to specify the SOAP version to be used.
Any XML Service
Select this option to create an XML service that does not have an explicitly defined, concrete interface.
(HTTP GET is supported only in the Any XML Service and Messaging Service service types.)
Service Type - Create From Existing Service
Choose one of these options to create a service based on another service.

Note: When a proxy service is created from another service, alert rules are maintained in the following way:

    • When a proxy service is created from a business service or a business service is created from a proxy service, the alert rules, if any, are removed.
    • When a proxy service is created from another proxy service or a business service is created from another business service, the alert rules, if any, are retained.
Business Service
Select this option to create a proxy service with a route node that routes to the business service you select. You cannot create a proxy service from a transport typed business service. If you create a proxy service from a DSP transport business service, ALSB switches the transport type of the proxy service to HTTP, because the DSP transport cannot be used for proxy services. You can change the transport type of the proxy service to any other available transport.
Enter the path (project/folder) and the name of the business service; or click Browse to select a service.
Proxy Service
Select this option to clone an existing proxy service. Enter the path (project/folder) and the name of the proxy service, or click Browse to select a service.
Since ALSB does not accept the same URI for multiple services, you must change the URI for the cloned service.
Content Streaming
Select this option to stream message content rather than store it in memory.
Select the Enabled check box and whether to buffer the intermediate content in memory (Memory Buffer) or to a disk file (Disk Buffer).
For more information, see Streaming body Content in the AquaLogic Service Bus User Guide.

AquaLogic Proxy Service Editor Options

The following table describes the options in the editor:

Option
Description
Description
Enter a description for this proxy service.
Service Type (editor only)
This option shows the service type of the proxy service. You can change only some of the properties of some of the service types:
  • WSDL Web Service - You can enter (or click Browse to select) a different port or binding from the same WSDL. You can also specify a different WSDL, but by doing so, you are effectively creating a new service and you will have to configure it as if it were a new service.
  • Transport Typed Service - This option cannot be modified.
  • Messaging Service - This option cannot be modified.
  • Any SOAP Service - You can change the SOAP version (SOAP 1.1 or SOAP 1.2)
  • Any XML Service - This option cannot be modified.
Content Streaming
Select this option to stream message content rather than store it in memory.
Select the Enabled check box and whether to buffer the intermediate content in memory (Memory Buffer) or to a disk file (Disk Buffer).
For more information, see Streaming body Content in the AquaLogic Service Bus User Guide.

Proxy Service Message Level Security Configuration page

Use the AquaLogic Proxy Service Message Level Security Configuration page to configure message-level security for the proxy service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Message-level custom tokens and message-level user name and password are supported on proxy services of the following binding types:

The configuration for both custom user name/password and custom token is similar. In both cases, you specify XPath expressions that enable ALSB to locate the necessary information. The root of these XPath expressions is as follows:

All XPath expressions must be in a valid XPath 2.0 format. The XPath expressions must use the XPath "declare namespace" syntax to declare any namespaces used, as follows:

  declare namespace
  ns='http://webservices.mycompany.com/MyExampleService';)

Option
Description
Service Key Provider
The name of a service key provider to be used by the service.
You can enter the path (project/folder) and name of a service key provider, or click Browse to select one.
A service key provider is only required in certain cases:
  • Outbound two-way TLS/SSL, where the proxy service routes messages to HTTPS services that require client-certificate authentication.
  • In some Web Service security scenarios, for example, if the proxy service requires messages to be encrypted.
To add a Web service security-enabled proxy service, you must create the proxy service from a WSDL (port or binding) with WS-policy attachments.
Custom Authentication Settings
Select one of the following:
  • None - if the service will not use custom authentication.
  • Custom User Name and Password - if the service will use a custom name and password, specified as XPath expressions
  • Custom Token - if the service will use a custom token
Custom User Name and Password - User Name XPath
The user name, specified as an XPath expression.
The XPath expression is evaluated against the message headers or payload, as appropriate, which allows ALSB to obtain the user name and for custom authentication.
Custom User Name and Password - User Password XPath
The password, specified as an XPath expression.
The XPath expression is evaluated against the message headers or payload, as appropriate, which allows ALSB to obtain the password values for custom authentication.
Custom Token - Token Type
Enter the type for the custom token type. Only the active token types configured for a WebLogic Server Identity Assertion provider can be used.
Custom Token - Token XPath
An XPath expression that specifies a path to the custom token. ALSB evaluates the Token XPath expression against the message headers or payload, as appropriate, to obtain the token for custom authentication.
To create or edit an expression, click <XPath> (or the expression_fragment, if one is already defined) to display the XPath Expression Editor.
Custom User Name and Password - Context Properties
or
Custom Token - Context Properties
Optionally, specify one or more context properties to pass additional context information to the Authentication (Custom User Name and Password) or Identity Assertion (Custom Token) security provider.
Context Properties provide a way (the ContextHandler interface) to pass additional information to the WebLogic Security Framework so that a security provider can obtain contextual information. See Additional Context Properties for Message Level Authentication for more information.
Enter the Property Name as a literal string, and the Value Selector as a valid XPath expression. (XPath expressions can also be literal strings.)
The XPath expressions are evaluated against the same message-part that is used for the custom token or custom user name/password. That is, the Value Selector XPath expressions for SOAP-based proxy services evaluate against the header and against the payload for non-SOAP-based proxy services.
The XPath expression is evaluated at runtime to produce the property's value. A ContextHandler is essentially a name/value list and, as such, it requires that a security provider know what names to look for. Therefore, the XPath expressions are evaluated only if a security provider asks for the value of one of these user-defined properties.
Click Add Property to add this context property. You can add multiple context properties.

Proxy Service Message Type Configuration page

Use AquaLogic Proxy Service Message Type Configuration page to configure message types for a proxy service whose type is Messaging Service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

The binding definition for messaging services consists of configuring the content-types of the messages that are exchanged. The content-type for the response does not have to be the same as for the request; therefore, the response is configured separately (for example, the service could accept an MFL message and return an XML acknowledgment receipt).

Note: E-mail, File, FTP, or SFTP transport proxy services whose type is Messaging Service support one-way messaging only; the Response Message Type should be None. If you select an option other than None, the E-mail, File, FTP, or SFTP protocols will not be available on the Transport Configuration page.

Option
Description
Request Message Type
Select a message type for the request message:
  • None - Select this option if there is no request message.
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Response Message Type
Select a message type for the response message:
  • None - Select this option if there is no response message.
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Proxy Service Operation Selection Configuration page

Use AquaLogic Proxy Service Operation Selection Configuration page to enforce WS-I compliance (for SOAP 1.1 services only) and select the selection algorithm to use to determine the operation called by this proxy service. This option is only available for SOAP or XML services defined from a WSDL.

The WSDL specification defines a default algorithm to compute which operation is called based on the type of the SOAP message received. However, there are cases (for example, performance issues, signature/encryption issues, or the default algorithm is not applicable) when you may need to select the operation based on other means.

ALSB provides additional algorithms. Each of them follows the same pattern and are based on the evaluation of an expression to get a value that is then used to lookup the corresponding operation in a static table.

ALSB is generally very forgiving if an inbound message is either missing data such that the operation cannot be determined, or has data that does not correspond to a valid operation. Both of these conditions result in $operation being empty. Rather than reject all such messages, ALSB does not initialize the operation variable in the context but otherwise continues to process the message.

However, security requirements are enforced if the proxy service is WSDL-based and at least one of the following conditions is true:

If these conditions are met, then there is a runtime check to make sure the operation selection algorithm returns a valid operation name. If the operation selection returns null or an operation that is not in the WSDL, then the message is rejected and an error is raised.

Option
Description
Enforce WS-I Compliance
Select or deselect this check box to specify whether or not the service is to conform to the Basic Profile defined by the Web Services Interoperability Organization. This option is available for or SOAP 1.1 services only
When a service is marked WS-I compliant, checks are performed against the messages sent to and from that service.
For proxies, checks are performed against request messages received by the proxy. For invoked services (i.e. services invoked by a proxy via service callout action or route node), checks are performed against the response messages received from those services. Note that it is the WS-I compliance property of the invoked service and not the proxy that determines whether or not checks are performed against messages received from the invoked service. If you specify WS-I compliance testing for an invoked service, the message flow generates a fault for response errors.
Selection Algorithm
Select one of the following and perform any required additional steps:
  • Transport Header - Select this algorithm to define the transport header that contains the lookup value. Then:
    • In the Header Name field, enter the transport header that extracts the value used as a key to select the operation being invoked.
    • Under the Operation Mapping field, specify the value for each operation in the Value field. The value is used as the key of the operation.
  • SOAPAction Header - Select this algorithm to specify that operation mapping be done automatically from the WSDL associated with this proxy service.
  • WS-Addressing - Select this algorithm to specify that the lookup value is contained by the WS-Addressing Action tag located in the SOAP headers of the SOAP message. Then, under the Operation Mapping field, specify the value for each operation in the Value field. The value is used as the key of the operation.
  • SOAP Header - Select this algorithm to define an XPath expression to be evaluated against the SOAP headers. This allows you to get the lookup value. Then:
    • In the XPath Expression field, specify the XPath expression that extracts the value used as a key to select the operation being invoked.
    • In the Operation Mapping field, specify the value for each operation in the Value field. The value is used as the key of the operation.
  • SOAP Body Type - This is the default algorithm defined by the WSDL specification to compute which operation is called based on the type of the SOAP message received.
  • If the proxy service is configured for a Web Service security pass-through scenario with an encrypted body, you cannot select this algorithm. A similar caveat applies to pass-through encrypted SOAP headers.

    If you have a WSDL that has two operations with the same input message, do not select this algorithm for operations, because the operation cannot be uniquely identified by inspecting the input message.

  • Payload Type - Available only for XML services based on a WSDL port or WSDL binding.
Header Name
This option is available only when the Selection Algorithm option is set to Transport Header.
Enter the transport header that extracts the value used as a key to select the operation being invoked.
XPath Expression
This option is available only when the Selection Algorithm option is set to SOAPHeader.
Specify the XPath expression that extracts the value used as a key to select the operation being invoked.
Operation Mapping
This option is available only when the Selection Algorithm option is set to Transport Header, WS-Addressing, or SOAP Body Type.
Specify the value for each operation in the Value field. The value is used as the key of the operation.

Proxy Service Service Policy Configuration page

Use AquaLogic Proxy Service Service Policy Configuration page to configure service policies for a proxy service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Option
Description
Option
Description
WSDL-Based Policy
Select this option if the service policy is associated with the WSDL upon which the service is based.
Custom Policy Bindings
Select this option to add service-level policies, operation-level policies (in which case the policy applies to both the request and response messages), request policies, and response policies directly.
For more information about configuring service policies, see Configuring Message Level Security for Web Services in the AquaLogic Service Bus Security Guide.

Proxy Service SOAP Binding Configuration page

This page is displayed only if the service you are creating has operations. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Use the AquaLogic Proxy Service SOAP Binding Configuration page to enforce WS-I compliance (for SOAP 1.1 services only) and select the selection algorithm to use to determine the operation called by this proxy service. This option is only available for SOAP or XML services defined from a WSDL.

The WSDL specification defines a default algorithm to compute which operation is called based on the type of the SOAP message received. However, there are cases (for example, performance issues, signature/encryption issues, or the default algorithm is not applicable) when you may need to select the operation based on other means.

ALSB provides additional algorithms. Each of them follows the same pattern and are based on the evaluation of an expression to get a value that is then used to lookup the corresponding operation in a static table.

ALSB is generally very forgiving if an inbound message is either missing data such that the operation cannot be determined, or has data that does not correspond to a valid operation. Both of these conditions result in $operation being empty. Rather than reject all such messages, ALSB does not initialize the operation variable in the context but otherwise continues to process the message.

However, security requirements are enforced if the proxy service is WSDL-based and at least one of the following conditions is true:

If these conditions are met, then there is a runtime check to make sure the operation selection algorithm returns a valid operation name. If the operation selection returns null or an operation that is not in the WSDL, then the message is rejected and an error is raised.

Option
Description
Enforce WS-I Compliance
For SOAP 1.1 services only:
Select or deselect this check box if you want to specify whether or not the service is to conform to the Basic Profile defined by the Web Services Interoperability Organization.
When a service is marked WS-I compliant, checks are performed against the messages sent to and from that service. For proxies, checks are performed against request messages received by the proxy. For invoked services (i.e. services invoked by a proxy via service callout action or route node), checks are performed against the response messages received from those services. Note that it is the WS-I compliance property of the invoked service and not the proxy that determines whether or not checks are performed against messages received from the invoked service. If you specify WS-I compliance testing for an invoked service, the message flow generates a fault for response errors.

Proxy Service Transport Configuration page

Use the AquaLogic Proxy Service Transport Configuration page to select a transport protocol for the proxy service and to set other general transport configuration settings.

This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Note: Inbound transport-level security applies to the client applications and ALSB proxy services. Outbound transport-level security applies to the connections between ALSB proxy services and business services. To learn more about transport-level security, see Configuring Transport-Level Security in the AquaLogic Service Bus Security Guide.

Option
Description
Protocol
Select a transport protocol from the list. The protocols available differ, depending on the service type you are creating:
  • WSDL Web Service: HTTP, JMS, Local, SB, WS
  • Messaging Service: E-mail, File, FTP, HTTP, JMS, Local, MQ (if available), SFTP, Tuxedo
  • Any SOAP Service: HTTP, JMS, Local, SB
  • Any XML Service: E-mail, File, FTP, HTTP, JMS, Local, MQ (if available), SB, SFTP, Tuxedo
Endpoint URI
Enter an endpoint URI in the format based on the transport protocol you selected in the Protocol field, above: The formats are:
  • E-mail - mailfrom:mail-server-host:port
  • File - file:///root-dir/dir1
  • FTP - ftp://hostname:port/directory
  • HTTP - /someName
  • The HTTP transport supports both HTTP and HTTPS endpoints.

  • JMS - jms://host:port[,host:port]*/factoryJndiName/destJndiName
  • To target a target a JMS destination to multiple servers, use the following URI format:

      jms://host1:port,host2:port/QueueConnectionFactory/DestName

    Note that when you create a proxy service, you can configure a JMS endpoint URI even if the server at that endpoint if not available. However, in the case of JMS, when you activate the session, the endpoint must be available.

  • Local
  • This transport does not require an endpoint URI.

  • MQ - mq://local-queue-name?conn=mq-connection-resource-ref
  • local-queue-name is the name of the MQ queue from which the proxy service reads messages.

    mq-connection-resource-ref is the path (project/folder) and name of the MQ connection resource; for example, default/my_MQconnection.

    To make the MQ transport available in ALSB, see MQ Connections in Using the AquaLogic Service Bus Console.

  • SB - service_name
  • service_name is the unique identifier for the proxy service. By default, this name will be the proxy service name.

    service_name must only contain characters permitted in URIs (as described in RFC2396), except it cannot contain forward slash (/) or colon (:) characters.

  • SFTP - sftp://hostname:port/directory
Endpoint URI (continued)
  • Tuxedo - servicename
  • The URI servicename corresponds to a WTC Export that the remote Tuxedo domain identifies as a Tuxedo service.

    If more than one URI is specified, you must have unique resource names for the endpoints. If no remote name is specified, its value is the value of the resource name. If no remote name is entered or if remote and resource name are the same, only one URI is allowed. In this case resource name and remote name will have the same value. This allows users using already defined WTC Imports to make use of WTC load-balancing and failover.

    Note: If you configure two identical URIs, an error indicates that the service name already exists.

  • WS - /contextPath
contextPath must be unique for proxy services that use either HTTP or WS transport.
Get All Headers
Select Yes to retrieve all the headers from the transport.
Select No to retrieve a defined set of headers. If you select No, enter a set of headers in the Header field, then click Add. (This step does not apply to Local transport.)

Note: ALSB does not pass the HTTP Authorization header from the request to the pipeline because it opens a security vulnerability. You could inadvertently create a log action that writes the user name and unencrypted password to a log file. If your design pattern requires the HTTP Authorization header to be in the pipeline, do the following:

a. In the startup command for ALSB, set the following system property to true: com.bea.wli.sb.transports.http.GetHttpAuthorizationHeaderAllowed

b. In Eclipse, on the Transport Configuration page, select Yes for Get All Headers or select No and specify Authorization.

c. Restart ALSB.

ALSB will pass the Authorization header to the pipeline.

ALSB Configurations and Projects

The following are provided for working with ALSB configurations and projects.

ALSB Configurations view

This view displays a hierarchical list of all your ALSB configurations and the projects they contain. See also New AquaLogic Service Bus Configuration Project wizard.

You can do the following in the Configurations view:

New AquaLogic Service Bus Configuration Project wizard

Use this wizard to create an ALSB configuration project. For configuration options, see ALSB Configuration page.

ALSB Configuration page

An ALSB configuration project is a grouping of ALSB projects and resources destined for a server, a location for system resources (SMTP, UDDI, and such), and a container for validation; for example, a resource in a project associated with one ALSB configuration cannot refer to a resource in a project associated to another ALSB configuration.

Use this page to create a new ALSB configuration project (in the New AquaLogic Service Bus Configuration Project wizard) or to to configure an existing one (in the Properties for ALSB Configuration editor).

The preserve, session, and customization file settings are used when publishing an ALSB configuration to the server, and used as defaults when configuring the Export wizard - Export to Server - Select Resources page.

Option
Description
Configuration name
Enter a name for this ALSB configuration or keep the default.
Advanced Options
Preserve environment variable values
Select this check box when you are re-importing a resource but want to preserve environment variable values in the existing resource.
Preserve security and policy settings
Select this check box to preserve the security configuration (excluding access control policies) and the references to the WS-policies bound directly to the service (instead of bound to the WSDL).
Preserve credentials
(user name and password)
Select this check box to preserve PKI credentials in service key providers, user name and passwords in service accounts, and user name and password credentials in SMTP servers, JNDI providers, and UDDI registries.
Discard session if activation fails
Select this check box to discard the session if the activation fails (for example, due to conflicts). For more information, see Activating Sessions in Using the AquaLogic Service Bus Console.
Session Name
The session name.
Description
The session description.
Deployment customization file
Specify a customization.xml file or click Browse, locate the file, then click Open. For information on customization, see Creating Customization Files in Using the AquaLogic Service Bus Console.
Keystore file
Specify a keystore.jks file or click Browse, locate the file, then click Open.
The key store settings are used when configuring a service key provider.
Password
Enter the password that you use to secure access to the key store.
Server
The name of the server associated with this ALSB configuration. This setting is automatically configured unless there is more than one server from which to choose. When multiple servers are associated with the same ALSB configuration, use the drop-down list to select the server you want to associate with this ALSB configuration.
The server setting is only used for transport specific configuration, when the transport benefits from being connected to a server (for example, when configuring the dispatch policy setting in the HTTP transport).

New AquaLogic Service Bus Project wizard

Use this page to create a new ALSB project.

Option
Description
Project name
Enter a unique name for the project. For more information, see Naming Projects and Folders in Using the AquaLogic Service Bus Console.
Project contents
Select the Use default check box to keep the project in the default location or click Browse and select a folder.
ALSB Configuration
Select an existing ALSB configuration or click New to open the New AquaLogic Service Bus Configuration Project wizard, where you can create a new configuration.

Custom Resources

You can define custom resources for use by ALSB using the New Custom Resource wizard and the Custom Resource editor, as described in the following topics:

New Custom Resource wizard

Use this wizard to create a new custom resource.

New Custom Resource Editor

Use this editor to modify the configuration of a custom resource. The General page identifies the type of custom resource. The Custom page provides options for editing the configuration for that type of custom resource.

New Custom Resource - Resource Type page

Use this page to select the type of custom resource to create. Select the type of custom resource to create from the list of available resource type.

Custom MQ Resource Configuration page

Use this page to configure a custom MQ connection resource. For information on MQ connection resources and MQ transports, see the following:

Export wizard

The Export wizard contains the following pages:

Export wizard - ALSB Configuration JAR Export page

Use this page to export ALSB resources to a configuration JAR file. For more information, see Exporting Resources in Using the AquaLogic Service Bus Console.

Option
Description
ALSB Configuration
Select an existing ALSB configuration and resources to export.
Export Level
Select whether to export projects or resources.

Note: A System project cannot be exported at the project level.

Note: Exporting projects might cause resource deletion when you import the full project JAR file. For more information, see Importing Resources in Using the AquaLogic Service Bus Console.

Include Dependencies
If you selected to export resources, select or clear this check box. Use the Include Dependencies option to export any other resources that this resource references
Export Destination
Enter the fully qualified name of a JAR file to export, or click Browse to select it.

Export wizard - Export to Server - Select Resources page

Use this page to select the projects or resources you want to export. Clear the check boxes next to any resources that you do not want to include in this export.

Option
Description
Resource
The name of the project and resource.
Operation
Create or update. The operation that will be performed on the resource.
Include Dependencies
Select this check box if you are exporting resources (not projects) and want to ensure that all the associate