Using the AquaLogic Service Bus Console
This section includes the following topics:
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
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
Each service type must define the following configurations:
$operation
, $body
, $header
, $attachments
)Table 14-3 Service Type Configuration
You can base SOAP and XML services on an existing WSDL resource. A WSDL document is available for proxy and business services for any transport. This WSDL is used as the base for the final WSDL document. 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. For a definition of a WSDL port, see http://www.w3.org/TR/wsdl#_ports. 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. Note: 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. |
|
You can base SOAP and XML services on an existing WSDL resource. A WSDL document is available for proxy and business services for any transport. This WSDL is used as the base for the final WSDL document. 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. For a definition of a WSDL Binding, see http://www.w3.org/TR/wsdl#_bindings. You may change the transport protocol of a service to another compatible one. The transport attribute of the For SOAP services, any existing For XML services, the only standard WSDL binding definition available is the one defined for HTTP. However, BEA has added its own standard definition for JMS. So, except in the case of the JMS transport protocol, the standard HTTP binding is used. As for SOAP, any existing |
|
Binding Definition: The only information this service type defines is that the service is receiving or sending SOAP messages—regardless of their WSDL binding definition. Therefore the binding configuration for this type is empty. In addition, as there is no binding configuration, the combination of this type and the content-type of the message is sufficient to determine whether or not there are attachments to the message. As per their definition, any services (SOAP or XML) do not have any WSDL definition. It is not possible to request a WSDL document for those services. The The The To learn more about the message context variables, see Message-Related Variables and Constructing Messages to Dispatch. |
|
Binding Definition: The only information this service type defines is that the service is receiving/sending XML messages—regardless of their WSDL binding definition. Therefore, the binding configuration for this type is empty. In addition, as there is no binding configuration, the combination of this type and the content-type of the message is sufficient to determine whether or not there are attachments to the message. As per their definition, any services (SOAP or XML) do not have any WSDL definition. It is not possible to request a WSDL document for those services. The The The The To learn more about the message context variables, see Message-Related Variables and Constructing Messages to Dispatch. |
|
Binding Definition: 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). As per their definition, messaging-based services do not have any WSDL definition. It is not possible to request a WSDL document for those services. There are four available content types to choose from for the request (and response): This service type is message based. There is no concept of multiple "operations" as for Web services. Therefore, the The The The To learn more about the message context variables, see Message-Related Variables and Constructing Messages to Dispatch. |
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
JMS1 |
|
XML (no WSDL)2 |
|
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:
Note: Click the name of a folder to select it. The Folder View page is displayed.
Note: A service type defines the types and packaging of the messages exchanged by the service. This is a required field.
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. |
|
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. |
|
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. |
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. |
|
This enables you to clone a new proxy service from the proxy service you select. |
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.
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.
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).
Table 14-6 Request Message Type Field
Table 14-7 Response Message Type Field
The Transport Configuration page is displayed. Continue in 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.
To target a target a JMS destination to multiple servers, use the following URI format:
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.
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.
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. 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.
|
|
|
|
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.
|
|
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 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 6. In the Response encoding field, accept the default 7. In the Client Response Timeout field, enter the amount of time to wait for the response, in seconds. |
|
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. |
|
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. 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 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.
Note: 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. |
|
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 4. Select Sort By Arrival to specify that events are delivered in the order of arrival, or leave blank not to do this.
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. 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. |
|
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 8. In the Post Read Action field, select what happens to a message after it has been read. This is a required field: 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. |
|
15. Select the Scan SubDirectories checkbox to recursively scan all the directories or leave blank not to do this. |
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.
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.
Table 14-10 Selection Algorithm Field
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.
Table 14-11 Selection Algorithm Field
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.
To learn more, see see Securing Inbound and Outbound Messages in the BEA AquaLogic Service Bus User Guide.
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.
The Project View or Folder View page is displayed. The new proxy service is included in the list of resources.
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.
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.
Listing and Locating Proxy Services
Viewing and Changing Proxy Services
Viewing and Changing Message Flow
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.
Table 14-12 Summary of Proxy Services Page
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. |
|
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. |
|
For proxy services, the Actions column displays up to four icons:
|
|
The Options column displays the following:
|
Viewing and Changing Message Flow
The View Details page enables you to view and edit details of a specific proxy service. To learn more, see Overview of Proxy Services.
The View Details page displays the following information
The user who created this proxy service or imported it into the configuration. |
|
The date and time that the user created this proxy service or imported it into the configuration. |
|
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. |
|
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. |
|
The View Details page displays the following General Configuration information:
Table 14-14 General Configuration Information
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
A message type for the request message: None, Binary, Text, MFL, or XML. |
|
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
If the transport protocol is Email, the page displays the following Email Transport Configuration information:
Table 14-17 Email Transport Configuration Information
If the transport protocol is File, the page displays the following File Transport Configuration information:
Table 14-18 File Transport Configuration Information
If the transport protocol is FTP, the page displays the following FTP Transport Configuration information:
Table 14-19 FTP Transport Configuration Information
If the transport protocol is HTTP, the page displays the following HTTP Transport Configuration information:
Table 14-20 HTTP Transport Configuration Information
If the transport protocol is HTTPS, the page displays the following HTTPS Transport Configuration information:
Table 14-21 HTTPS Transport Configuration Information
If the transport protocol is JMS, the page displays the following JMS Transport Configuration information.
Table 14-22 JMS Transport Configuration Information
The page displays the following Operation Selection Configuration information:
Table 14-23 Operation Selection Configuration Information
Note: You cannot change the Service Name or Service Type fields.
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.
Viewing and Changing 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.
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.
Viewing and Changing Proxy Services