org.fax4j.bridge

Interface FaxBridge

All Superinterfaces:

ConfigurationHolder, ProviderImplementation

All Known Subinterfaces:

ContextFaxBridge<T>

All Known Implementing Classes:

AbstractContextFaxBridge, AbstractFax4JBridge, AbstractFaxBridge, EMail2FaxBridge, FaxBridgeImpl, HTTP2FaxBridge, Process2FaxBridge

public interface FaxBridge
extends ProviderImplementation, ConfigurationHolder

This interface defines only the common capabilities of the fax bridge.
Specific implementations may provide additional, more transport based capabilities.
Below table describes the configuration values relevant for this class.
Configuration:

Name	Description	Preconfigured Value	Default Value	Mandatory
org.fax4j.bridge.vendor.policy.class.name	The vendor policy class name.	org.fax4j.bridge.EmptyVendorPolicy	org.fax4j.bridge.EmptyVendorPolicy	false

Since:

0.40.6

Version:

1.03

Author:

Sagie Gur-Ari

Field Summary

Fields

Modifier and Type	Field and Description
static String	VENDOR_POLICY_CLASS_NAME The vendor policy class name property key

Method Summary

Modifier and Type	Method and Description
FaxJob	createFaxJob() Returns the internal fax client.
FaxClient	getFaxClient() Returns the internal fax client.
Logger	getLogger() Returns the internal logger.
VendorPolicy	getVendorPolicy() This function returns the vendor policy.
void	initialize(String type, Properties configuration, Object flowOwner) This function initializes the fax bridge.
void	submitFaxJob(FaxJob faxJob, FileInfo fileInfo) This function will submit a new fax job. The fax job ID may be populated by this method in the provided fax job object. The file information in the provided fax job will be ignored by this method, instead the file data will be taken from the FileInfo.

Methods inherited from interface org.fax4j.common.ProviderImplementation

getProvider

Methods inherited from interface org.fax4j.common.ConfigurationHolder

getConfiguration, getConfigurationValue, getConfigurationValue, getPropertyPart

Field Detail

VENDOR_POLICY_CLASS_NAME

static final String VENDOR_POLICY_CLASS_NAME

The vendor policy class name property key

See Also:

Constant Field Values

Method Detail

initialize

void initialize(String type,
                Properties configuration,
                Object flowOwner)

This function initializes the fax bridge.

Parameters:

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

getLogger

Logger getLogger()

Returns the internal logger.

Returns:

The internal logger

getFaxClient

FaxClient getFaxClient()

Returns the internal fax client.

Returns:

The fax client

getVendorPolicy

VendorPolicy getVendorPolicy()

This function returns the vendor policy.

Returns:

The vendor policy

createFaxJob

FaxJob createFaxJob()

Returns the internal fax client.

Returns:

The fax client

submitFaxJob

void submitFaxJob(FaxJob faxJob,
                  FileInfo fileInfo)

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.
The file information in the provided fax job will be ignored by this method, instead the file data will be taken from the FileInfo.

Parameters:

faxJob - The fax job object containing the needed information (not including the file information)

fileInfo - The file information of the requested fax