Skip navigation links

Oracle BPEL Process Manager Client Java API Reference
10g Release 3 (10.1.3.1.0)

B28986-01


com.oracle.bpel.client.dispatch
Interface IDeliveryService

All Superinterfaces:
IService
All Known Subinterfaces:
IDeliveryService

public interface IDeliveryService
extends IService

This class has been deprecated and replaced by the IDeliveryService subinterface. If will be kept around to preserve backward compatibility until the 10.1.3 release. The delivery service allows users to feed messages into the BPEL domain for invocation or callback.

There are two ways to deliver messages to the domain: post and request. Which method to call depends on the wsdl interface of the BPEL process you wish to deliver the message to.

request
If the port type operation has both an input and output message.
post
If the port type operation only has an input message.

Field Summary
static java.lang.String LOCAL_SERVICE_NAME
          Name of local delivery service.
static java.lang.String SERVICE_NAME
          Name of the delivery service.

 

Method Summary
 void post(java.lang.String processId, java.lang.String operationName, NormalizedMessage message)
          Invokes the specified operation on the BPEL process using the passed message as input.
 void post(java.lang.String processId, java.lang.String revisionTag, java.lang.String operationName, NormalizedMessage message)
          Invokes the specified operation on the BPEL process using the passed message as input.
 void post(java.lang.String processId, java.lang.String revisionTag, java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName, NormalizedMessage message)
          Invokes the specified operation on the BPEL process using the passed message as input.
 NormalizedMessage request(java.lang.String processId, java.lang.String operationName, NormalizedMessage message)
          Invokes the specified operation on the BPEL process using the passed message as input.
 NormalizedMessage request(java.lang.String processId, java.lang.String revisionTag, java.lang.String operationName, NormalizedMessage message)
          Invokes the specified operation on the BPEL process using the passed message as input.
 NormalizedMessage request(java.lang.String processId, java.lang.String revisionTag, java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName, NormalizedMessage message)
          Invokes the specified operation on the BPEL process using the passed message as input.

 

Methods inherited from interface com.oracle.bpel.client.IService
getName

 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
Name of the delivery service. This name is used to lookup the service from a domain locator.
See Also:
Locator.lookupService(java.lang.String), Constant Field Values

LOCAL_SERVICE_NAME

static final java.lang.String LOCAL_SERVICE_NAME
Name of local delivery service. The local service can be used when the calling code is co-located on the same j2ee container as the BPEL server. The local service will connect to the BPEL server using local EJBs.
See Also:
Locator.lookupService(java.lang.String), Constant Field Values

Method Detail

request

NormalizedMessage request(java.lang.String processId,
                          java.lang.String operationName,
                          NormalizedMessage message)
                          throws ServerException,
                                 java.rmi.RemoteException
Invokes the specified operation on the BPEL process using the passed message as input. This method will wait for the result of the invocation.

This method will invoke the default revision of the BPEL process (that is, the one most recently deployed to the process domain).

Parameters:
processId - the BPEL process identifier
operationName - the operation to invoke on the process
message - the input message
Returns:
the reply from the invocation
Throws:
ServerException - if the process does not exist or if there was a problem with the invocation.
java.rmi.RemoteException - if there was a problem connecting to the j2ee server.

request

NormalizedMessage request(java.lang.String processId,
                          java.lang.String revisionTag,
                          java.lang.String operationName,
                          NormalizedMessage message)
                          throws ServerException,
                                 java.rmi.RemoteException
Invokes the specified operation on the BPEL process using the passed message as input. This method will wait for the result of the invocation.

This method will invoke the specified revision of the BPEL process. If revisionTag is null, the default process will be invoked.

Parameters:
processId - the BPEL process identifier
revisionTag - the BPEL process revision tag
operationName - the operation to invoke on the process
message - the input message
Returns:
the reply from the invocation
Throws:
ServerException - if the process does not exist or if there was a problem with the invocation.
java.rmi.RemoteException - if there was a problem connecting to the j2ee server.

request

NormalizedMessage request(java.lang.String processId,
                          java.lang.String revisionTag,
                          java.lang.String partnerLinkName,
                          java.lang.String roleName,
                          java.lang.String operationName,
                          NormalizedMessage message)
                          throws ServerException,
                                 java.rmi.RemoteException
Invokes the specified operation on the BPEL process using the passed message as input. This method will wait for the result of the invocation.

If the request will result in an instance being created the partner link and role names are ignored. The current implementation can only support a single instance creating activity. If the request is a callback to an existing instance, the partner link and role names will be used to properly correlate the request to the receiving activity.

Parameters:
processId - the BPEL process identifier
revisionTag - the BPEL process revision tag
partnerLinkName - name of the partner link that includes the port type that has this operation
roleName - name of the role in the partner link that uses the port type that has this operation
operationName - the operation to invoke on the process
message - the input message
Returns:
the reply from the invocation
Throws:
ServerException - if the process does not exist or if there was a problem with the invocation.
java.rmi.RemoteException - if there was a problem connecting to the j2ee server.

post

void post(java.lang.String processId,
          java.lang.String operationName,
          NormalizedMessage message)
          throws ServerException,
                 java.rmi.RemoteException
Invokes the specified operation on the BPEL process using the passed message as input. This method will submit the input for processing and return immediately; the message will be processed asynchronously.

This method will invoke the default revision of the BPEL process (that is, the one most recently deployed to the process domain).

Parameters:
processId - the BPEL process identifier
operationName - the operation to invoke on the process
message - the input message
Throws:
ServerException - if the process does not exist or if there was a problem with the invocation.
java.rmi.RemoteException - if there was a problem connecting to the j2ee server.

post

void post(java.lang.String processId,
          java.lang.String revisionTag,
          java.lang.String operationName,
          NormalizedMessage message)
          throws ServerException,
                 java.rmi.RemoteException
Invokes the specified operation on the BPEL process using the passed message as input. This method will submit the input for processing and return immediately; the message will be processed asynchronously.

This method will invoke the specified revision of the BPEL process. If revisionTag is null, the default process will be invoked.

Parameters:
processId - the BPEL process identifier
revisionTag - the BPEL process revision tag
operationName - the operation to invoke on the process
message - the input message
Throws:
ServerException - if the process does not exist or if there was a problem with the invocation.
java.rmi.RemoteException - if there was a problem connecting to the j2ee server.

post

void post(java.lang.String processId,
          java.lang.String revisionTag,
          java.lang.String partnerLinkName,
          java.lang.String roleName,
          java.lang.String operationName,
          NormalizedMessage message)
          throws ServerException,
                 java.rmi.RemoteException
Invokes the specified operation on the BPEL process using the passed message as input. This method will submit the input for processing and return immediately; the message will be processed asynchronously.

If the post will result in an instance being created the partner link and role names are ignored. The current implementation can only support a single instance creating activity. If the post is a callback to an existing instance, the partner link and role names will be used to properly correlate the post to the receiving activity.

Parameters:
processId - the BPEL process identifier
revisionTag - the BPEL process revision tag
partnerLinkName - name of the partner link that includes the port type that has this operation
roleName - name of the role in the partner link that uses the port type that has this operation
operationName - the operation to invoke on the process
message - the input message
Throws:
ServerException - if the process does not exist or if there was a problem with the invocation.
java.rmi.RemoteException - if there was a problem connecting to the j2ee server.

Skip navigation links

Oracle BPEL Process Manager Client Java API Reference
10g Release 3 (10.1.3.1.0)

B28986-01


Copyright © 2006, Oracle. All rights reserved.