org.fax4j.bridge

Class FaxBridgeFlowHelper<T>

java.lang.Object

org.fax4j.bridge.FaxBridgeFlowHelper<T>

Type Parameters:

T - The context type

public class FaxBridgeFlowHelper<T>
extends Object

This is an optional helper class to run the fax bridge flow from external classes.

Since:

0.41.4

Version:

1.01

Author:

Sagie Gur-Ari

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FaxBridgeFlowHelper.FlowResponse This class holds the response of the fax bridge flow invocation.

Constructor Summary

Constructors

Constructor and Description
FaxBridgeFlowHelper(ContextFaxBridge<T> faxBridge, String type, Properties configuration, Object flowOwner) This is the class constructor.

Method Summary

Modifier and Type	Method and Description
ContextFaxBridge<T>	getFaxBridge() This function returns the fax bridge.
FaxBridgeFlowHelper.FlowResponse	submitFaxJob(T inputData, Object contextData, boolean invokeVendorPolicy) This function invokes the submit fax job flow. As part of the flow, if requested, the vendor policy would be invoked as well.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaxBridgeFlowHelper

public FaxBridgeFlowHelper(ContextFaxBridge<T> faxBridge,
                           String type,
                           Properties configuration,
                           Object flowOwner)

This is the class constructor.

Parameters:

faxBridge - The fax bridge

type - The fax client type (may be null for default type)

configuration - The fax client configuration (may be null)

flowOwner - The flow owner (servlet, CLI main, ....) to be passed to the vendor policy

Method Detail

getFaxBridge

public ContextFaxBridge<T> getFaxBridge()

This function returns the fax bridge.

Returns:

The fax bridge

submitFaxJob

public FaxBridgeFlowHelper.FlowResponse submitFaxJob(T inputData,
                                                     Object contextData,
                                                     boolean invokeVendorPolicy)

This function invokes the submit fax job flow.
As part of the flow, if requested, the vendor policy would be invoked as well.

Parameters:

inputData - The input data for the fax bridge

contextData - The conext data used by the vendor policy (may be same as the input data)

invokeVendorPolicy - True to invoke the vendor policy

Returns:

The flow response