Skip navigation.

eDocs Home > BEA AquaLogic Service Bus 2.1 Documentation > Using the AquaLogic Service Bus Console > Proxy Services

Using the AquaLogic Service Bus Console

  Previous Next vertical dots separating previous/next from contents/index/pdf Contents View as PDF   Get Adobe Reader

Proxy Services

This section includes the following topics:

 

Overview of Proxy Services

This section includes the following topics:

Proxy services are AquaLogic Service Bus definitions of Web services implemented locally on WebLogic Server. You define a proxy service in terms of WSDLs, pipelines, and policies. If the proxy service requires security credentials, you can create a proxy service provider to manage these security credentials from the AquaLogic Service Bus Console. For information on how to configure a proxy service provider, see Adding a Proxy Service Provider. You can configure access control policies on proxy services. To learn more, see Listing and Locating Access Control Policies, Editing Transport Authorization Policies, and Editing Service Authorization Policies.

You implement a proxy service through configuring its Message Flow. Message Flows can include pipeline pairs and the following nodes: Start, Route, and Branch. To learn more, see Overview of Proxy Services and Viewing and Changing Message Flow.

The following table lists the pages you can access from the Project Explorer and Resource Browser modules. The tasks and help topics associated with each are provided.

Table 14-1 Pages Accessed from Project Explorer and Resource Browser Modules

Page

Associated Tasks

Help Topics

Summary of Proxy Services

View a list of proxy services. The service name and alerts are displayed.

Listing and Locating Proxy Services

Filter the list.

Delete a proxy service

Deleting Proxy Services

Edit a Proxy Service

Add a proxy service.

Adding a Proxy Service

Proxy Service Details

View and edit details of a specific proxy service.

Viewing and Changing Proxy Services

Edit Message Flow

View the message flow

Viewing and Changing Message Flow

Change the message flow

Add a pipeline pair node

Adding a Pipeline Pair Node

Add a conditional branch node

Adding a Conditional Branch Node

Add an operational branch node

Adding an Operational Branch Node

Add a route node

Adding a Route Node

Add a stage

Adding a Stage

Edit Branch Node

Change branch details and add branch definitions

Viewing and Changing Conditional Branch Details

Edit Stage Configuration

Add an action

Adding an Action

Edit Error Handler

Add an error handler for a proxy service

Adding Error Handling for the Proxy Service

Add a pipeline error handler

Adding Pipeline Error Handling

Add a stage error handler

Adding Stage Error Handling

Add route node error handler

Adding Error Handling for the Route Node

XQuery Expression Editor

Edit an XQuery expression

Using the Inline XQuery Expression Editor

XQuery Condition Editor

Edit an XQuery condition

Using the XQuery Condition Editor

XPath Expression Editor

Edit an XPath expression

Using the XPath Expression Editor


 

Service Types

Each service type is modeled following the same pattern. Their configuration is composed of a common part and a service type specific part.

The common configuration consists of the following properties:

Table 14-2 Service Type Configuration


 

Property

Description

Resource Definition

The resource definition consists of:

  • The service name (that is, project, path, and local name)

  • An optional description for the service

  • The service type (read only)

Miscellaneous Configuration

This configuration consists of:

  • The service provider for proxy services

Note: A service provider is only required if the proxy service routes messages to HTTPS services that require client-certificate authentication, or in some message-level security scenarios.

Transport Configuration

You can configure the following parameters for each proxy service:

  • Endpoint URI—string, for example:
    /proxy1
    or
    jms://localhost:7001/QueueConnectionFactory/DestName. (This is required.)

    To target a target a JMS destination to multiple servers, use the following URI format:
    jms://host1:port,host2:port/QueueConnectionFactory/DestName

  • Get all headers from request. This is a Boolean value; the default is true.

  • User-specified Headers—a list of string header names, which is only applicable if you select False for the Get all headers option.

The transport you select must be able to support the transport mode (that is, request/response, one-way or both) required by the binding definition, and be configured accordingly.

For services exchanging messages in both modes, you must configure the binding layer so that it can choose the transport mode accordingly (for any transport implementing the request/response as two asynchronous calls, for example, JMS). This occurs automatically when the service is a concrete type, as it is described in the binding definition. When it is not a concrete type, to configure the binding layer, you must set the mode in the $outbound variable.

Based on the transport and WSDL, the transport mode is automatically selected, but you can overwrite it in $inbound or $outbound.


 

Each service type must define the following configurations:

Service Types and Transports

The following types of service types and transports are supported by AquaLogic Service Bus:

Table 14-4 Service Types and Transports Supported by AquaLogic Service Bus

Service Type

Transport Protocols

SOAP or XML WSDL

JMS1

HTTP(S)

SOAP (no WSDL)

JMS

HTTP(S)

XML (no WSDL)2

HTTP(S)

JMS

Email

File

FTP

Messaging Type (Binary, Text, MFL, XML)

HTTP(S)

JMS

Email

File

FTP

1. Web service security (WSS) is supported only over one-way JMS on inbound and outbound. Attempting to configure WSS with JMS request/response results in a session conflict.


2. HTTP GET is only supported for XML with no WSDL.


 

Related Topics

Overview of Business Services

 

Adding a Proxy Service

The Edit a Proxy Service - General Configuration page enables you to add a proxy service.

Proxy services are AquaLogic Service Bus definitions of Web services implemented locally on WebLogic Server. You define a proxy service in terms of WSDLs, pipelines, and policies. To learn more, see Overview of Proxy Services.

To add a proxy service, you must first configure general information for the service, configure general and protocol-dependent transport information for the service, then configure operation selection algorithms for the service if it includes operations. If this is a messaging service, you must also configure the message types. You can review the configuration before you create the proxy service.

The tasks in this procedure include:

To Add a Proxy Service - General Configuration

  1. If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. To learn more, see Using the Change Center.
  2. From the left navigation pane, select Project Explorer. The Project View page is displayed.
  3. Select the project to which you want to add the proxy service. You can add a proxy service directly under the project, or you can add the proxy service under a selected folder.

    4. Note: Click the name of a folder to select it. The Folder View page is displayed.

  4. From the Project View or Folder View page, in the Create Resource field, select Proxy Service from under Service. The Edit a Proxy Service - General Configuration page is displayed.
  5. In the Service Name field, enter a unique name for the proxy service.
  6. In the Description field, enter a description for the proxy service.
  7. In the Service Type field, do one of the following:

    8. Note: A service type defines the types and packaging of the messages exchanged by the service. This is a required field.

    Table 14-5 Service Type Field

    To...

    Complete These Steps...

    Create a service from WSDL port

      1. Select WSDL port from under Create a New Service.

      2. Click Browse. The WSDL Browser is displayed.

      3. In the WSDL Browser, select a WSDL resource, then select a port in the Definitions pane.

      4. Click Submit to close the dialog box and return to the General Configuration page.

    Note: When you create a business service or proxy service based on a WSDL, you can select only a WSDL port or a WSDL binding, as a WSDL may only have one of these entities defined. The WSDL port describes what the actual transport address is. You use it for a concrete interface.

    To learn more about this service type, see Service Types and Service Types and Transports in Overview of Proxy Services. See also Generating WSDLs from a Proxy Service in this topic.

    Create a service from WSDL binding

      1. Select WSDL binding from under Create a New Service.

      2. Click Browse. The WSDL Browser is displayed.

      3. In the WSDL Browser, select a WSDL resource, then select a binding in the Definitions pane.

      4. Click Submit to close the dialog box and return to the General Configuration page.

    Note: When you create a business service or proxy service based on a WSDL, you can select only a WSDL port or a WSDL binding, as a WSDL may only have one of these entities defined. The WSDL binding describes the structure of the interface and how it is packaged. You use it to map the transport address.

    To learn more about this service type, see Service Types and Service Types and Transports in Overview of Proxy Services. See also Generating WSDLs from a Proxy Service in this topic.

    Create a messaging service

    Select Messaging Service 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. Unlike Web services, the content-type of the request and response need not be the same.

    To learn more about this service type, see Service Types and Service Types and Transports in Overview of Proxy Services.

    Create a SOAP service that does not have an explicitly defined, concrete interface

    Select Any SOAP Service to create a SOAP service that does not have an explicitly defined, concrete interface.

    To learn more about this service type, see Service Types and Service Types and Transports in Overview of Proxy Services.

    Create an XML service that does not have an explicitly defined, concrete interface

    Select Any XML Service to create an XML service that does not have an explicitly defined, concrete interface.

    Note: HTTP GET is only supported in the Any XML Service service type.

    To learn more about this service type, see Service Types and Service Types and Transports in Overview of Proxy Services.

    Create a proxy service from an existing business service

      1. Select Business Service from under Create from Existing Service.

      2. Click Browse. The Service Browser is displayed.

      3. In the Service Browser, select a business service.

      4. Click Submit to close the dialog box and return to the General Configuration page.

    This enables you to create a proxy service with a route node that routes to the business service you select. To learn more about business services, see Overview of Business Services.

    Create a proxy service from an existing proxy service

      1. Select Proxy Service from under Create from Existing Service.

      2. Click Browse. The Service Browser is displayed.

      3. In the Service Browser, select a proxy service.

      4. Click Submit to close the dialog box and return to the General Configuration page.

    This enables you to clone a new proxy service from the proxy service you select.


     
  8. In the Proxy Service Provider field, select the name of a proxy service provider:
    1. Click Browse. The Service Provider Browser is displayed.
    2. In the Service Provider Browser, select a proxy service provider.
    3. Click Submit to close the dialog box and return to the General Configuration page.

      4. A proxy service provider is only required in certain cases: Outbound 2-way TLS/SSL, where the proxy service routes messages to HTTPS services that require client-certificate authentication, or in some Web service security scenarios; for example, if the proxy service requires messages to be encrypted. To learn more about proxy service providers, see Overview of Proxy Service Providers. To learn how to create a proxy service provider, see Adding a Proxy Service Provider.

      Note: 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.

      In the case of SOAP/WSS over JMS—Web service security (WSS) is supported only over one-way JMS on inbound and outbound. WSS with JMS request/response is not supported.

  9. Click Next.

    10. If you selected Messaging Service in the Service Type field, the Edit a Proxy Service - Message Type Configuration page is displayed. Continue in To Add a Proxy Service - Messaging Type Configuration.

    For all other service types, the Edit a Proxy Service - Transport Configuration page is displayed. Continue in To Add a Proxy Service - Transport Configuration.

To Add a Proxy Service - Messaging Type Configuration

If you selected Messaging Service in the Service Type field, the Edit a Proxy Service - Message Type Configuration page is displayed when you click Next on the Edit a Proxy Service - General Configuration page.

The binding definition for messaging services consists of configuring the content-type 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).

  1. Select a message type for the request and response messages:
    1. In the Request Message Type field, select a message type for the request message:

      2. Table 14-6 Request Message Type Field

      Message Type

      Description

      None

      Select None if there no content-type for the message.

      Binary

      Select Binary if the content-type of the message is unknown or not important.

      Text

      Select Text if the message can be restricted to text.

      MFL

      Select MFL if the message is a binary document conforming to an MFL definition. You can configure only one MFL file.

      Note: For MFLs, you can click Browse to select a MFL from the MFL Browser, then click Submit.

      XML

      Select XML if the message is an XML document. To provide some type information, you can choose to declare the XML schema type of the XML document exchanged.


       
    2. In the Response Message Type field, select a message type for the response message:

      3. Table 14-7 Response Message Type Field

      Message Type

      Description

      None

      Select None if there no content-type for the message.

      Binary

      Select Binary if the content-type of the message is unknown or not important.

      Text

      Select Text if the message can be restricted to text.

      MFL

      Select MFL if the message is a binary document conforming to an MFL definition. You can configure only one MFL file.

      Note: For MFLs, you can click Browse to select a MFL from the MFL Browser, then click Submit.

      XML

      Select XML if the message is an XML document. To provide some type information, you can choose to declare the XML schema type of the XML document exchanged.


       
  2. Click Next.

    3. The Transport Configuration page is displayed. Continue in To Add a Proxy Service - Transport Configuration.

To Add a Proxy Service - Transport Configuration

The Transport Configuration page is displayed when you click Next on the Edit a Proxy Service - General Configuration page. It is displayed for messaging services when you click Next on the Edit a Proxy Service - Message Type Configuration page.

This page enables you to configure transport information for the proxy service. To learn more about the types of service types and transports supported by AquaLogic Service Bus, see Service Types and Transports.

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

  1. In the Protocol field, select one of these transport protocols:
  2. In the Endpoint URI field, enter an endpoint URL in the format based on the transport protocol you selected in the Protocol field, then click Add:

    3. Table 14-8 Endpoint URI Field

    Transport Protocol

    Format

    Email

    mailfrom:mail-server-hostname:mail-server-port

    File

    file:///drivename:/somename

    FTP

    ftp://hostname:port/directory

    HTTP

    /someName

    HTTPS

    /someName

    JMS

    jms://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. To learn more, see JMS Endpoint URIs Must be Available To Activate a Session.


     

    Note: You can configure multiple URLs. You can click Delete in the Action column to delete them at any time. At run time, the URLs are selected based on the load balancing algorithm you selected in the Load Balancing Algorithm field.

  3. In the Get All Headers field, select Yes if you want to retrieve all the headers from the transport or select No if you want to retrieve a defined set of headers. If you select No, enter a set of headers in the Header field, then click Add.
  4. Click Next.

    5. An additional Transport Configuration page is displayed. This page enables you to configure protocol-dependent transport information for the proxy service. Continue in To Add a Proxy Service - Protocol-Dependent Transport Configuration.

To Add a Proxy Service - Protocol-Dependent Transport Configuration

The [Protocol] Transport Configuration page is displayed when you click Next on the Edit a Proxy Service - Transport Configuration page. This page enables you to configure additional transport information for the proxy service, based on the transport protocol you selected in the Protocol field.

  1. Based on the transport protocol you selected in the Protocol field, do one of the following:

    2. Table 14-9 Protocol Field

    Transport Protocol...

    Complete These Steps...

    HTTP

      1. Select the Basic Authentication Required checkbox to specify that basic authentication is required to access this service, or leave it blank to specify that basic authentication is not required. Basic authentication instructs WebLogic Server to authenticate the client using a username and password against the authentication providers configured in the security realm, such as a Lightweight Directory Access Protocol (LDAP) directory service and Windows Active Directory. The client must send its username and password on the HTTP request header.

    Note: Basic authentication is strongly discouraged over HTTP because the password is sent in clear text. However, it is safe to send passwords over HTTPS because HTTPS provides an encrypted channel.

    Warning: When you create an HTTP proxy service endpoint that requires Basic Authentication, a transport-authorization policy is not automatically associated with the inbound endpoint URI. For Basic Authentication to be enforced, you must define a transport-authorization policy for the endpoint. To learn more, see Securing Inbound and Outbound Messages in the BEA AquaLogic Service Bus User Guide.

      2. In the Dispatch Policy field, select a dispatch policy for this endpoint. Leave blank to use the default dispatch policy.

    Dispatch policy refers to the instance of WLS 9.0 Work Manager that you want to use for the service endpoint. For example, if the proxy service has a JMS transport protocol, the service endpoint is an MDB (message-driven bean) JAR file that you can associate with the specific dispatch policy.

      3. In the Request encoding field, do the following:

    For HTTP inbound transports, if the character set encoding parameter of the Content-Type header is not specified in Client Request, enter a character set encoding parameter in this field. If you do not enter a value, the field defaults to iso-8859-1.

    For HTTP outbound transports, if you have not configured a request encoding, the AquaLogic Service Bus runtime decides the most appropriate encoding while it makes a request to the business service. In the case of a non-passthrough scenario, the default char set encoding is utf-8 at runtime. However if it is a passthrough scenario, the runtime will pass through the encoding received with the outbound response.

    HTTP continued

      4. In the Response encoding field, do the following:

    For HTTP inbound transports, if you do not enter a response encoding, the binding layer decides the most appropriate encoding while it sends back the response to client. In the case of a non-passthrough scenario, the default char set encoding is utf-8 at runtime. However, in the case of a passthrough scenario, the runtime will pass through the encoding received with the outbound response.

    For HTTP outbound transports, if the character set encoding parameter of the Content-Type header is not specified in the Back End Service response, enter a character set encoding parameter in this field. If you do not enter a value, the field defaults to iso-8859-1.

    HTTPS

      1. In the Client Authentication field, select the client authentication method: None, Basic, or Client certificates.

    Warning: When you create an HTTPS proxy service endpoint that requires Basic Authentication, a transport-authorization policy is not automatically associated with the inbound endpoint URI. For Basic Authentication to be enforced, you must define a transport-authorization policy for the endpoint. To learn more, see Securing Inbound and Outbound Messages in the BEA AquaLogic Service Bus User Guide.

      2. In the Dispatch Policy field, select a dispatch policy for this endpoint. Leave blank to use the default dispatch policy.

    Dispatch policy refers to the instance of WLS 9.0 Work Manager that you want to use for the service endpoint. For example, if the proxy service has a JMS transport protocol, the service endpoint is an MDB (message-driven bean) JAR file that you can associate with the specific dispatch policy.

      3. In the Request encoding field, accept the default iso-8859-1 as the char set encoding for requests in HTTPS transports, or enter a different char set encoding.

      4. In the Response encoding field, accept the default iso-8859-1 as the char set encoding for requests in HTTPS transports, or enter a different char set encoding.

    JMS

      1. In the Destination Type field, select Queue or Topic.

      2. If you selected Queue in the Destination Type field, select the Is Response Required checkbox or leave it blank. This checkbox determines whether or not a response is expected after an outbound message is sent. When you select the checkbox, you must enter data in an additional field: Response URI.

      3. In the Response URI field, enter a response URI in the format jms://host:port/MyFactory/MyQueue.This field is required if you selected Is Response Required.
      To target multiple servers, use the following URI format:
      jms://host1:port,host2:port/QueueConnectionFactory/DestName

      4. In the Response Message Type field, select Bytes or Text. if you selected the Is Response Required field.

      5. In the Request encoding field, accept the default utf-8 as the char set encoding for requests in JMS transports, or enter a different char set encoding.

      6. In the Response encoding field, accept the default utf-8 as the char set encoding for requests in JMS transports, or enter a different char set encoding.

      7. In the Client Response Timeout field, enter the amount of time to wait for the response, in seconds.

      8. In the Dispatch Policy field, select a dispatch policy for this endpoint. Default signifies the default dispatch policy.

    Dispatch policy refers to the instance of WLS 9.0 Work Manager that you want to use for the service endpoint. For example, if the proxy service has a JMS transport protocol, the service endpoint is an MDB (message-driven bean) JAR file that you can associate with the specific dispatch policy.

    JMS continued

      9. Click Advanced Settings to display additonal fields.

      10. Select the Use SSL checkbox if the requests are made over a TLS/SSL connection or leave blank if they are not. TLS/SSL (Secure Sockets Layer) provides secure connections by allowing two applications connecting over a network to authenticate the other's identity and by encrypting the data exchanged between the applications. Authentication allows a server, and optionally a client, to verify the identity of the application on the other end of a network connection. Additionally, if the administrator has restricted access to individual JMS destinations (queues or topics) by setting access control on the JNDI entry for the destination, the Business Service must authenticate when looking up the entry in the JNDI tree with a username and password.

      11. In the Message Selector field, enter a message selector expression. Only messages with properties matching the expression are processed.

      12. Select the Durable Subscription checkbox if the subscription is durable or leave this checkbox blank if the subscription is not durable.

      13. In the Retry Count field, enter the number of delivery retries a message can have before it is moved to the error destination. This field only applies to WebLogic Server JMS destinations.

      14. In the Retry Interval field, enter the amount of time, in milliseconds, before rolled back or recovered messages are redelivered. This field only applies to WebLogic Server JMS destinations.

      15. In the Error Destination field, enter the name of the target destination for messages that have reached their redelivery limit. This field only applies to WebLogic Server JMS destinations.

      16. In the JMS service account field, select a service account to use for the JMS resource managed by the JMS server. A service account is an alias resource for a User ID and its associated password. To learn more about service accounts, see Overview of Service Accounts.

    Email

      1. In the Service Account field, enter a service account. You can click Browse to select service accounts from a browser. This is a required field.

      2. In the Polling Interval field, enter a polling interval, in seconds. This is a required field.

      3. In the Email Protocol field, select POP3 or IMAP as the server type for the email account. This is a required field.

      4. In the Read Limit field, specify the maximum number of messages to read per polling sweep. Enter 0 to specify no limit. This is a required field.

      5. Select the Pass By Reference field to stage the file in the archive directory and pass it as a reference in the headers, or leave the field blank not to do this.

      6. In the Post Read Action field, select what happens to a message after it has been read:

    Archive - the message is archived

    Delete - the message is deleted

    Move - the message is moved. Move is only available with the IMAP protocol.

    Note: This is a required field.

      7. In the Attachments field, select how attachments are handled:

    Archive - Attachments are saved to the Archive Directory

    Ignore - Attachments are ignored

    This is a required field.

      8. In the IMAP Move Folder field, enter the folder to which the message is moved if the Post Read Action field is set to Move.

      9. In the Download Directory field, enter a temporary location for downloading the emails. This is a required field.

      10. In the Archive Directory field, specify the path to the archive location if the Post Read Action field is set to Archive. The Archive Directory field is also a required field if you have selected the Pass By Reference field.

      11. In the Error Directory field, enter the file system directory path to write the message and any attachments if there is a problem. This is a required field.

      12. In the Request encoding field, accept the default iso-8859-1 as the character set encoding for requests in Email transports, or enter a different character set encoding.

    File

      1. In the File Mask field, enter the regular expression for the files to be picked. The default is *.*.This is a required field.

      2. In the Polling Interval field, enter a polling interval, in seconds. The default is 60. This is a required field.

      3. In the Read Limit field, specify the maximum number of messages to read per polling sweep. Enter 0 to specify no limit. The default is 10. This is a required field.

      4. Select Sort By Arrival to specify that events are delivered in the order of arrival, or leave blank not to do this.

    Note that when the Sort By Arrival option is selected for a proxy service that is executed in a clustered environment, messages are always sent to the same server. In other words, load balancing across servers is ignored when this option is selected.

      5. Select the Scan SubDirectories checkbox to recursively scan all the directories or leave blank not to do this.

      6. Select the Pass By Reference checkbox to stage the file in the archive directory and pass it as a reference in the headers, or leave the field blank not to do this.

      7. In the Post Read Action field, select what happens to a message after it has been read:

    Archive - the message is archived

    Delete - the message is deleted

    This is a required field.

      8. In the Stage Directory field, enter an intermediate directory to temporarily stage the files while processing them. This is a required field.

      9. In the Archive Directory field, specify the path to the archive location if the Post Read Action field is set to Archive. The Archive Directory field is also a required field if you have selected the Pass By Reference field.

      10. In the Error Directory field, enter the location where messages and attachments are posted if there is a problem. This is a required field.

      11. In the Request encoding field, accept the default utf-8 as the char set encoding for requests in File transports, or enter a different char set encoding.

    FTP

      1. In the User Authentication field, select anonymous if the user of the FTP server is anonymous or select external_user if the user of the FTP server is an externally configured account.

      2. In the Identity (e-mail id) or Service Account field, enter the mail ID for the anonymous user if you selected anonymous in the User Authentication field, or enter the service account if you selected external_user in the User Authentication field. This is a required field if you selected external_user.

      3. Select the Pass By Reference checkbox to stage the file in the archive directory and pass it as a reference in the headers.

      4. Select the Remote Streaming checkbox to directly stream the FTP files from the remote server at the time of processing or leave blank not to do this. When you select Remote Streaming, the archive directory is the remote directory on the remote FTP server machine. Therefore, you should specify the archive directory as relative to the FTP user directory.

      5. In the File Mask field, enter the regular expression for the files to be picked. The default is *.*.This is a required field.

      6. In the Polling Interval field, enter a polling interval, in seconds. The default is 60. This is a required field.

      7. In the Read Limit field, specify the maximum number of messages to read per polling sweep. Enter 0 to specify no limit. The default is 10. This is a required field.

      8. In the Post Read Action field, select what happens to a message after it has been read. This is a required field:

    Archive - the message is archived

    Delete - the message is deleted

      9. In the Transfer Node field, select ascii or binary as the transfer mode.

      10. In the Download Directory field, enter the directory on your local machine where files are downloaded during the file transfer. This is a required field.

      11. In the Archive Directory field, specify the path to the archive location if the Post Read Action field is set to Archive. The Archive Directory field is also a required field if you have selected the Pass By Reference field.

      12. In the Error Directory field, enter the location where messages are posted if there is a problem. This is a required field.

    Note: The archive, download, and error directories are absolute path, and they are automatically created. If you specify the relative path, the files are created relative to the Java process that starts the WebLogic Server.

      13. In the Request encoding field, accept the default utf-8 as the char set encoding for requests in FTP transports, or enter a different char set encoding.

    FTP continued

      14. Click Advanced Settings to display additional fields.

      15. Select the Scan SubDirectories checkbox to recursively scan all the directories or leave blank not to do this.

      16. Select the Sort By Arrival checkbox to deliver events in the order of arrival.

      17. In the Timeout field, enter the socket timeout interval, in seconds, before the connection is dropped. If you enter 0, there is no timeout.

      18. In the Retry Count field, specify the number of retries for FTP connection failures.


     
  2. Click Next.

    3. If this service has operations, the Edit a Proxy Service - Operation Selection Configuration page is displayed. Continue in To Add a Proxy Service - Operation Selection Configuration.

    If this service does not have operations, the General Configuration Review page is displayed. Continue in To Add a Proxy Service - General Configuration Review.

To Add a Proxy Service - Operation Selection Configuration

If this service has operations, the Operation Selection Configuration page is displayed when you click Next on the Protocol Transport Configuration page. This page enables you to enforce WS-I compliance 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.

AquaLogic Service Bus 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.

  1. Select the Enforce WS-I Compliance checkbox if you want to specify whether or not the service is WS-I compliant in the AquaLogic Service Bus Console. Checks are performed when the proxy service receives a message as a response from an invoked service with a Service Callout action, a Route Node action, or on a proxy service request pipeline. If you specify WS-I compliance testing for an invoked service, the pipeline generates a fault for response errors.
  2. In the Selection Algorithm field, select one of the following:

    3. Table 14-10 Selection Algorithm Field

    Selection Algorithm

    Description

    Transport Header

    If you select this selection algorithm, you can define the transport header that contains the lookup value.

    SOAPAction Header

    If you select this selection algorithm, operation mapping is done automatically from the WSDL associated with this proxy service.

    WS-Addressing

    If you select this selection algorithm, the lookup value is contained by the WS-Addressing Action tag located in the SOAP headers of the SOAP message.

    SOAP Headers

    If you select this selection algorithm, you can define an XPath expression evaluated against the SOAP headers, which allows you to get the lookup value.

    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.

    Note: If the proxy service is configured for a Web service security pass-through scenario with an encrypted body, you cannot select the SOAP Body Type selection algorithm. A similar caveat applies to pass-through encrypted SOAP headers.


     

    Note: If you are creating an XML service type based on a WSDL port or binding, the following selection algorithms are displayed on this page: Transport Header and Payload Type.

    Note: Additional fields are displayed depending on the selection algorithm you select.

  3. Based on the algorithm you selected in the Selection Algorithm field, do one of the following:

    4. Table 14-11 Selection Algorithm Field

    Selection Algorithm...

    Complete These Steps...

    Transport Header

      1. In the Header Name field, enter the transport header that extracts the value used as a key to select the operation being invoked.

      2. 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. This is a required field.

    SOAPAction Header

    There are no additional fields displayed for this selection algorithm.

    WS-Addressing

    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. This is a required field.

    SOAP Headers

      1. In the XPath Expression field, specify the XPath expression that extracts the value used as a key to select the operation being invoked.

      2. 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. This is a required field.

    SOAP Body Type

    There are no additional fields displayed for this selection algorithm.

    Payload Type

    There are no additional fields displayed for this selection algorithm.


     
  4. Click Next.

    5. The General Configuration Review page is displayed. Continue in To Add a Proxy Service - General Configuration Review.

Note: If the proxy service is created from a WSDL (port or binding) that has WS-Policies attached, the Web Services Security Configuration page is displayed when you click Next. This page displays read-only views of the effective request/response WS-Policy for all operations.

Do one of the following:

To learn more, see see Securing Inbound and Outbound Messages in the BEA AquaLogic Service Bus User Guide.

To Add a Proxy Service - General Configuration Review

The General Configuration Review page is displayed when you click Next on the Operation Selection Configuration page. This page enables you to review the configuration data that you have entered for this proxy service. If necessary, you can click Edit to make changes to the configuration before you save the proxy service.

Note: After you create a proxy service, the next step is to configure its Message Flow. Message Flow defines the implementation of a proxy service. Message Flows can include pipeline pairs and the following nodes: Start, Route, and Branch. To learn more, see Overview of Message Flow and Viewing and Changing Message Flow.

Note: The new proxy service is saved in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the core configuration is updated. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.

Generating WSDLs from a Proxy Service

When you create a proxy service based on a WSDL Binding, AquaLogic Service Bus sets the new service and port definitions in the WSDL generated for the proxy service. Regardless of whether you define a proxy service based on a WSDL port or a WSDL binding, the WSDL generated for the proxy service defines only a single port. If the service is generated from port X in the template WSDL, then port X is also defined in the generated WSDL. Any other ports defined in the template WSDL are not included in the generated WSDL. Furthermore, if you base the proxy service on a WSDL port, the generated WSDL uses that port name and preserves any WS-Policies associated with that port. The binding is determined from the port, and in turn, the port type is determined from the binding.

If the service is generated from binding Y in the template WSDL, the generated WSDL defines a new service and port (<service-name>QSService and <port-name>QSPort). None of the ports defined in the template WSDL are included in the generated WSDL.

If you base the service on a WSDL binding template, there may be multiple ports in that WSDL associated with that binding. Each port can use a different URL and have a different WS-Policy attached to it. Therefore, the generated WSDL uses the binding but generates an artificial port for that binding with no WS-Policy. For all WSDL-based services, the transport type and transport URL can be overwritten in the transport section of the service definition.

You can get the WSDL for an HTTP(S)-based proxy service by entering the URL for the service appended with ?WSDL in your browser's Address field.

Related Topics

Listing and Locating Proxy Services

Viewing and Changing Proxy Services

Deleting Proxy Services

Viewing and Changing Message Flow

 

Listing and Locating Proxy Services

The Summary of Proxy Services page enables you to view a list of proxy services. Proxy services are AquaLogic Service Bus definitions of Web services implemented locally on WebLogic Server. To learn more, see Overview of Proxy Services.

To List and Locate Proxy Services

  1. From the left navigation pane, select Proxy Services from under Resource Browser. The Summary of Proxy Services page is displayed. It displays the following information for each proxy service. For a more detailed description of the properties, see Viewing and Changing Proxy Services:

    2. Table 14-12 Summary of Proxy Services Page

    Property

    Description

    Name

    A unique name for the proxy service. The name is a link to the View Details page. To learn more, see Viewing and Changing Proxy Services.

    Path

    The path is the project name and the name of the folder in which the proxy service resides. It is a link to the project or folder that contains this resource. To learn more, see Viewing Project Details or Viewing Folder Details.

    Actions

    For proxy services, the Actions column displays up to four icons:

    • A Manage Monitoring icon, which is a link to the Monitoring Configuration - [service name] page. Click the icon to enable or disable monitoring for a specific service, enable or disable the service itself, and view or configure alert rules for a specific service. To learn more, see Listing and Locating Alert Rules.

    • A Launch Test Console icon, which you can click to invoke the Test Console, which you use to validate and test the design of your services and transformations. For business services, you can only use the Test Console at run time; that is, when the session is activated. To learn more, see Testing Services.

    • An Export WSDL icon displays for any WSDL-based proxy services. You use the Export WSDL functionality to quickly make a WSDL available for consumption by external tools such as IDEs. Note that this is different than the Export Resources functionality in the System Administration module, which you use to move and stage resources between two domains. Click the Export WSDL icon to export the WSDL. To learn more, see Exporting a WSDL.

    Options

    The Options column displays the following:

    You cannot delete a resource if it is referenced by other resources in AquaLogic Service Bus. Instead of the Delete icon, a Delete icon with a red X is displayed for these resources.


     
  2. To locate a specific proxy service, do one of the following:
    • Filter by proxy service name. In the Name and Path fields, enter the name and path of the search target, then click Search. The path is the project name and the name of the folder in which the proxy service resides. The services matching the search criteria are displayed.
    • Resort the list. Ascending and descending arrow buttons indicate sortable columns—in this case, the Name and Path columns. Click the button to change the sort order.
    • Scroll through the pages. Use the controls in the lower right corner. Go to a page by selecting the page number or by using the arrow buttons to go to the next, previous, first, or last page.

      • Note: Click View All to display all proxy services.

Related Topics

Adding a Proxy Service

Viewing and Changing Message Flow

 

Viewing and Changing Proxy Services

The View Details page enables you to view and edit details of a specific proxy service. To learn more, see Overview of Proxy Services.

To View and Edit Details of a Proxy Service

  1. Locate the proxy service. To learn more, see Listing and Locating Proxy Services.
  2. Click the proxy service name.

    3. The View Details page displays the following information

    Table 14-13 View Details Page

    Property

    Description

    Resource Name

    The name of this proxy service.

    Created By

    The user who created this proxy service or imported it into the configuration.

    Created On

    The date and time that the user created this proxy service or imported it into the configuration.

    References

    The number of objects that this proxy service references. If such references exist, click the link to view a list of the objects. To learn more, see Viewing References.

    Referenced by

    The number of objects that reference this proxy service. If such references exist, click the link to view a list of the objects. To learn more, see Viewing References.

    Description

    A description of this proxy service, if one exists.


     

    The View Details page displays the following General Configuration information:

    Table 14-14 General Configuration Information

    Property

    Description

    Service Type

    The service type

    Proxy Service Provider

    The name of the proxy service provider


     

    If the service type for this proxy service is Messaging Service, the page displays the following Message Type Configuration information:

    Table 14-15 Message Type Configuration Information

    Property

    Description

    Request Message Type

    A message type for the request message: None, Binary, Text, MFL, or XML.

    Response Message Type

    A message type for the response message: None, Binary, Text, MFL, or XML.


     

    The page displays the following Transport Configuration information:

    Table 14-16 Transport Configuration Information

    Property

    Description

    Protocol

    The transport protocol

    Endpoint URI

    The endpoint URI

    Get All Headers

    Whether all the headers or a defined set of headers are retrieved from the transport


     

    If the transport protocol is Email, the page displays the following Email Transport Configuration information:

    Table 14-17 Email Transport Configuration Information

    Property

    Description

    Email Protocol

    A server type for the email account:

    • pop3

    • imap

    Service Account

    The service account for this mail server

    Polling Interval

    A polling interval, in seconds.

    Read Limit

    The maximum number of messages read per polling sweep. 0 signifies no limit.

    Pass By Reference

    Whether or not the file is staged in the archive directory and passed as a reference in the headers

    Post Read Action

    Whether or not a message is archived, deleted or moved after it has been read:

    • Archive - the message is archived

    • Delete - the message is deleted

    • Move - the message is moved

    Note: Move is only available with the IMAP protocol.

    Attachments

    Whether or not attachments are archived or ignored:

    • Archive - Attachments are saved to the Archive Directory

    • Ignore - Attachments are ignored

    IMAP Move Folder

    The folder to which the message is moved if the Post Read Action field is set to Move.

    Download Directory

    The temporary location for downloading emails.

    Archive Directory

    The path to the archive location if the Post Read Action field is set to Archive. The Archive Directory field is also a required field if you have selected the Pass By Reference field.

    Error Directory

    The file system directory path to write the message and any attachments if there is a problem.

    Request encoding

    Displays the char set encoding for requests in Email transports. The default is iso-8859-1.


     

    If the transport protocol is File, the page displays the following File Transport Configuration information:

    Table 14-18 File Transport Configuration Information

    Property

    Description

    File Mask

    The regular expression applied for this file to be picked.

    Polling Interval

    The polling interval, in seconds.

    Read Limit

    The maximum number of messages to read per polling sweep. 0 signifies no limit.

    Sort by Arrival

    Whether or not events are delivered in the order of arrival.

    Scan Subdirectories

    Whether or not all the directories are recursively scanned.

    Pass By Reference

    Whether or not the file is staged in the archive directory and passed as a reference in the headers.

    Remote Streaming

    Whether or not the ftp files are directly streamed from the remote server at the time of processing.

    Post Read Action

    Whether or not a message is archived or deleted after it has been read:

    • Archive - the message is archived

    • Delete - the message is deleted

    Stage Directory

    The intermediate directory where files are temporarily staged while they are processed.

    Error Directory

    The file system directory path to write the message and any attachments if there is a problem.

    Archive Directory

    The path to the archive location if the Post Read Action field is set to Archive. The Archive Directory field is also a required field if you have selected the Pass By Reference field.

    Request encoding

    Displays the char set encoding for requests in File transports. The default is utf-8.


     

    If the transport protocol is FTP, the page displays the following FTP Transport Configuration information:

    Table 14-19 FTP Transport Configuration Information

    Property

    Description

    Identity (e-mail id)/ Service Account

    The mail ID for an anonymous user or service account for an externally configured user.

    Timeout

    The socket timeout, in seconds

    File Mask

    The regular expression applied for this file to be picked.

    Scan Subdirectories

    Whether or not all the directories are recursively scanned.

    Pass By Reference

    Whether or not the file is staged in the archive directory and passed as a reference in the headers.

    Post Read Action

    Whether or not a message is archived or deleted after it has been read:

    • Archive - the message is archived

    • Delete - the message is deleted

    Archive Directory

    The path to the archive location if the Post Read Action field is set to Archive. The Archive Directory field is also a required field if you have selected the Pass By Reference field.

    Download Directory

    The temporary location for downloading FTP files.

    Error Directory

    The file system directory path to write the message and any attachments if there is a problem.

    Retry Count

    The number of retries for FTP connection failures.

    Polling Interval

    The polling interval, in seconds.

    Read Limit

    The maximum number of messages to read per polling sweep. 0 signifies no limit.

    Sort By Arrival

    Whether or not events are delivered in the order of arrival

    Transfer Mode

    The transfer mode: Binary or ASCII

    Request encoding

    Displays the char set encoding for requests in FTP transports. The default is utf-8.


     

    If the transport protocol is HTTP, the page displays the following HTTP Transport Configuration information:

    Table 14-20 HTTP Transport Configuration Information

    Property

    Description

    Basic Authentication Required

    Whether or not basic authentication is required: displays Enabled if it is required.

    Request encoding

    Displays the char set encoding for requests in HTTP transports. The default is iso-8859-1.

    Response encoding

    Displays the char set encoding for responses in HTTP transports. The default iso-8859-1.


     

    If the transport protocol is HTTPS, the page displays the following HTTPS Transport Configuration information:

    Table 14-21 HTTPS Transport Configuration Information

    Property

    Description

    Client Authentication

    The client authentication method: None, Basic, or Client Certificates.

    Request encoding

    Displays the char set encoding for requests in HTTPS transports. The default is iso-8859-1.

    Response encoding

    Displays the char set encoding for responses in HTTPS transports. The default iso-8859-1.


     

    If the transport protocol is JMS, the page displays the following JMS Transport Configuration information.

    Table 14-22 JMS Transport Configuration Information

    Property

    Description

    Destination Type

    The destination type: Queue or Topic.

    Use SSL

    Whether or not the requests are made over a TLS/SSL connection.

    Is Response Required

    Whether or not a response is expected after an outbound message is sent.

    Request encoding

    Displays the char set encoding for requests in JMS transports. The default is utf-8.

    Response URI

    A response URI in the format jms://host:port/factoryJndiName/destJndiName

    To target multiple servers, use the following URI format:
    jms://host1:port,host2:port/QueueConnectionFactory/DestName

    JMS service account

    The service account to use for the JMS resource managed by the JMS server.


     

    The page displays the following Operation Selection Configuration information:

    Table 14-23 Operation Selection Configuration Information

    Property

    Description

    Enforce WS-I Compliance

    Displays Yes if you selected this option to specify whether or not the service is WS-I compliant in the AquaLogic Service Bus Console, and displays No if you did not want to specify this.

    Selection Algorithm

    The selection algorithm that determines the operation called by this proxy service.

    Header Name

    If you selected Transport Header in the Selection Algorithm field for this proxy service, this field displays the transport header that extracts the value used as a key to select the operation being invoked.

    XPath Expression

    If you selected SOAP Headers in the Selection Algorithm field for this proxy service, this field displays the XPath expression that extracts the value used as a key to select the operation being invoked.

    Operation Mapping

    If you selected Transport Headers, WS-Addressing or SOAP Headers in the Selection Algorithm field for this proxy service, this field displays the value for each operation. The value is used as the key of the operation.


     
  3. If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session or click Edit to enter an existing session to make changes to the current configuration. For more information, see Using the Change Center.
  4. To make a change to the fields on the configuration pages, click Edit for the appropriate page. See Adding a Proxy Service for a description of the pages and fields.

    5. Note: You cannot change the Service Name or Service Type fields.

  5. Do one of the following:
    • To return to the previous page, click Back.
    • To update the proxy service, click Finish. The Proxy Service is updated.

      • The Summary of Proxy Services page is displayed.

    • To disregard changes and return to the Summary of Proxy Services page, click Cancel.

Note: The proxy service is updated in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the core configuration is updated. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.

Related Topics

Adding a Proxy Service

Viewing and Changing Proxy Services

Deleting Proxy Services

 

Deleting Proxy Services

The Summary of Proxy Services page enables you to delete a proxy service. To learn more, see Overview of Proxy Services.

Note: You cannot delete a resource if it is referenced by other resources in AquaLogic Service Bus. Instead of the Delete icon, a Delete icon with a red X is displayed for these resources.

Note: You must delete all service-level access control policies and transport-level access control policies associated with a proxy service before you delete that service from AquaLogic Service Bus.

To Delete a Proxy Service

  1. If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. To learn more, see Using the Change Center.
  2. From the left navigation pane, select Proxy Services from under Resource Browser. The Summary of Proxy Services page is displayed.
  3. In the Options field of the proxy service you want to delete, click the Delete icon.

    4. The proxy service is removed from the list.

    Note: If necessary, you can undo the deletion of this resource. To learn more, see Undoing a Task.

    The proxy service is deleted in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the core configuration is updated. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.

Related Topics

Adding a Proxy Service

Viewing and Changing Proxy Services

Viewing and Changing Message Flow

 

Skip navigation bar  Back to Top Previous Next