Package: com.appistry.fabric

Class Fabric

Implements

Fabric implements IFabric

Methods

Fabric

This the Fabric API object constructor.

Fabric(String fabricAddress,
       int fabricPort)

or

Fabric(String fabricAddress,
       int fabricPort,
       Encryption encryption)

or

Fabric(String fabricAddress,
       int fabricPort,
       int mcastTTL)

or

Fabric(String fabricAddress,
       int fabricPort,
       int mcastTTL,
       Encryption encryption)

or

Fabric(String fabricAddress,
       int fabricPort,
       int mcastTTL,
       Encryption encryption,
       int cacheRefreshInterval,
       int casheRefreshTimeout)

or

Fabric(FabricProperties properties)

getAddress

String getAddress()

This method returns the MCAST address to which the client submits request to the fabric.

getPort

int getPort()

The method returns the port to which the client submits requests to the fabric.

getEncryption

Encryption getEncryption()

This method returns the encryption type. Valid values are Encryption.SSL and Encryption.NONE. No encryption is the default.

getMcastTTL

int getMcastTTL()

This method returns the time to live parameter for multicast packets used by the fabric API.

getCacheRefreshTimeout

int getCacheRefreshTimeout()

This method returns the amount of time, in seconds, the fabric can take to create a list of workers available for processing requests.

getCacheRefreshInterval

int getCacheRefreshInterval()

This method returns the amount of time the fabric waits before refreshing the list of workers available for processing requests.

ping

Boolean ping()

This method verifies the client can connect to the fabric.

pingApplication

Boolean pingApplication (String applicationName,
                         String processFlowName)

This method verifies the client can connect to the fabric, and that the application and process flow are loaded on the fabric.

execute

void execute(FabricRequest request)

This method connects to the fabric and executes the specified process flow in a synchronous manner.

recover

This method attempts to recover a lost process flow's result from the fabric in a synchronous manner. Since the process flow results are not available until the process flow has completed, recover waits until the recovery completes or the specified timeout is met. If the request object that generated the original fabric request was destroyed, you must create a new request object and set the new request object's request ID to the destroyed request object's request ID.

IFabricRequest recover(String requestId)

or

IFabricRequest recover(String requestId,
                      int timeoutInSeconds)

or

IFabricRequest recover(String requestId,
                      String username,
                      String password,
                      int timeoutInSeconds)

submit

void submit(FabricRequest request)

This method connects to the fabric and submits the specified process flow in an asynchronous manner. Retrieve the result using the waitAny method.

submitCorrelated

void submitCorrelated(FabricRequest request)

This method connects to the fabric and submits the specified process flow in an asynchronous manner. Retrieve the result using the waitCorrelated method.

waitAny

This method specifies the fabric waits for any request submitted asynchronous by the submit or submitRecover methods. These requests may return in any order from the fabric.

FabricRequest waitAny()

or

FabricRequest waitAny(int timeoutInMilliseconds)

waitCorrelated

This method specifies the fabric waits for a particular request's result that was submitted using the submitCorrelated or submitRecoverCorrelated method.

Boolean waitCorrelated(FabricRequest request)

or

Boolean waitCorrelated(FabricRequest request, int timeoutInMilliseconds)

submitRecover

This method submits a recovery request for a lost process flow's result in an asynchronous manner. After submitting the recovery request, you must wait for the results using the [waitAny] method. If the request object that generated the original fabric request was destroyed, you must create a new request object and set the new request object's request ID to the destroyed request object's request ID.

void submitRecover(String requestId)

or

void submitRecover(String requestId,
                   int timeoutInSeconds)

or

void submitRecover(String requestId,
                   String username,
                   String password,
                   int timeoutInSeconds)

submitRecoverCorrelated

This method submits the recovery request for a lost process flow's result in an asynchronous manner. After submitting the recovery request, you must wait for the results using the waitCorrelated method. If the request object that generated the original fabric request was destroyed, you must create a new request object and set the new request object's request ID to the destroyed request object's request ID.

void submitRecoverCorrelated(String requestId)

or

void submitRecoverCorrelated(String requestId,
                             int timeoutInSeconds)

or

void submitRecoverCorrelated(String requestId,
                             String username,
                             String password,
                             int timeoutInSeconds)

getKeepaliveSendInterval

int getKeepaliveSendInterval()

Thie method returns maximum amount of time, in milliseconds, the client waits to receive a transmission over the TCP connection before sending a keepalive ping to the fabric. The client and fabric may have different values. In this is situation, the smaller of the two values is used. If the fabric has a smaller value, that value overrides this value.

getKeepaliveReadTimeout

int getKeepaliveReadTimeout()

This method returns the maximum amount of time, in milliseconds, the client waits for a response from a keepalive ping. If the timeout expires, the connection is considered disconnected. The client and fabric may have different values. In this is situation, the smaller of the two values is used. If the fabric has a smaller value, that value overrides this value.