A B C D E F G H I J L M N O P R S T U V W X

A

AbstractAdapterFaxClientSpi - Class in org.fax4j.spi.adapter

This class provides partial implementation of an adapter fax client service provider interface.
This implementation will proxy the requests to another internal SPI.

AbstractAdapterFaxClientSpi() - Constructor for class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This is the class constructor.

AbstractCloseable - Class in org.fax4j.util

Defines a basic closable class which prevents errors from being thrown during the close invocation.

AbstractCloseable() - Constructor for class org.fax4j.util.AbstractCloseable

This is the class constructor.

AbstractCommPortAdapter - Class in org.fax4j.spi.comm

This class provides partial implementation of the basic and common adapter capabilities.

AbstractCommPortAdapter() - Constructor for class org.fax4j.spi.comm.AbstractCommPortAdapter

This is the class constructor.

AbstractCommPortConnectionFactory - Class in org.fax4j.spi.comm

Provides partial implementation of the COMM port connection factory.

AbstractCommPortConnectionFactory() - Constructor for class org.fax4j.spi.comm.AbstractCommPortConnectionFactory

This is the class constructor.

AbstractConnectionFactory<T> - Class in org.fax4j.util

This class provides the basic common connection factory capabilities.

AbstractConnectionFactory() - Constructor for class org.fax4j.util.AbstractConnectionFactory

This is the class constructor.

AbstractContextFaxBridge<T> - Class in org.fax4j.bridge

This provides almost complete implementation of the context fax bridge.

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

AbstractContextFaxBridge() - Constructor for class org.fax4j.bridge.AbstractContextFaxBridge

This is the class constructor.

AbstractFax4JBridge - Class in org.fax4j.bridge

This class partial implementation of the fax bridge.
Specific implementations may provide additional, more transport based capabilities.

AbstractFax4JBridge() - Constructor for class org.fax4j.bridge.AbstractFax4JBridge

This is the class constructor.

AbstractFax4JClientSpi - Class in org.fax4j.spi

This class provides partial/common functionlity of the internal fax4j fax client service provider interface.
This class should be used only by internal fax4j SPIs, for SPIs written by vendors outside the fax4j, see the org.fax4j.spi.AbstractFaxClientSpi class.
This is the actual engine behind the fax4j framework.
It handles the fax client activities such as sending/suspending fax jobs and so on.
The SPI is an internal class that should be used internally only.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

For SPI specific configuration, see the relevant SPI class javadoc.

AbstractFax4JClientSpi() - Constructor for class org.fax4j.spi.AbstractFax4JClientSpi

This is the default constructor.

AbstractFax4JConnectionFactory<T> - Class in org.fax4j.util

This class provides the basic common connection factory capabilities.

AbstractFax4JConnectionFactory() - Constructor for class org.fax4j.util.AbstractFax4JConnectionFactory

This is the class constructor.

AbstractFax4JFaxModemAdapter - Class in org.fax4j.spi.comm

This class provides partial/common functionlity of the fax modem adapter interface.
This class should be used only by internal fax4j implementation and not by implementations written by external vendors.

AbstractFax4JFaxModemAdapter() - Constructor for class org.fax4j.spi.comm.AbstractFax4JFaxModemAdapter

This is the class constructor.

AbstractFaxBridge - Class in org.fax4j.bridge

This class partial implementation of the fax bridge.
Specific implementations may provide additional, more transport based capabilities.

AbstractFaxBridge() - Constructor for class org.fax4j.bridge.AbstractFaxBridge

This is the class constructor.

AbstractFaxClientSpi - Class in org.fax4j.spi

This class provides partial/common functionlity of the fax client service provider interface.
This is the actual engine behind the fax4j framework.
It handles the fax client activities such as sending/suspending fax jobs and so on.
The SPI is an internal class that should be used internally only.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

For SPI specific configuration, see the relevant SPI class javadoc.

AbstractFaxClientSpi() - Constructor for class org.fax4j.spi.AbstractFaxClientSpi

This is the default constructor.

AbstractFaxClientSpi.FaxJobExtendedPropertyConstants - Enum in org.fax4j.spi

This class holds the fax job extended properties.

AbstractFaxClientSpiInterceptor - Class in org.fax4j.spi

This class provides partial implementation of the fax client SPI interceptor which enables to invoke custom logic before and after the fax client SPI method invocations (such as logging).

AbstractFaxClientSpiInterceptor() - Constructor for class org.fax4j.spi.AbstractFaxClientSpiInterceptor

This is the default constructor.

AbstractFaxClientSpiProxy - Class in org.fax4j.spi

This class provides partial implementation of the fax client SPI proxy which enables to invoke interceptors before and after the fax client SPI method invocations.
With this proxy, it is possible to intercept all calls to the fax client SPIs and perform custom logic such as logging.

AbstractFaxClientSpiProxy() - Constructor for class org.fax4j.spi.AbstractFaxClientSpiProxy

This is the default constructor.

AbstractFaxEvent - Class in org.fax4j

Base class for all fax4j events.

AbstractFaxEvent(FaxJob) - Constructor for class org.fax4j.AbstractFaxEvent

This is the class constructor.

AbstractFaxJob - Class in org.fax4j.spi

This class provides common partial implementation of the fax job.

AbstractFaxJob() - Constructor for class org.fax4j.spi.AbstractFaxJob

This is the class constructor.

AbstractFaxJob2HTTPRequestConverter - Class in org.fax4j.spi.http

This class provides partial implementation of the fax job to HTTP request converter interface.

AbstractFaxJob2HTTPRequestConverter(Provider) - Constructor for class org.fax4j.spi.http.AbstractFaxJob2HTTPRequestConverter

This is the default constructor.

AbstractFaxJobMonitor - Class in org.fax4j.spi

This class provides partial implementation of the fax job monitor capabilities.

AbstractFaxJobMonitor() - Constructor for class org.fax4j.spi.AbstractFaxJobMonitor

This is the class constructor.

AbstractFaxModemAdapter - Class in org.fax4j.spi.comm

This class provides partial/common functionlity of the fax modem adapter interface.

AbstractFaxModemAdapter() - Constructor for class org.fax4j.spi.comm.AbstractFaxModemAdapter

This is the class constructor.

AbstractHTTPClient - Class in org.fax4j.spi.http

This abstract HTTP client provides partial implementation for common functionality.

AbstractHTTPClient() - Constructor for class org.fax4j.spi.http.AbstractHTTPClient

This is the default constructor.

AbstractHTTPResponseHandler - Class in org.fax4j.spi.http

This class provides partial implementation of the HTTP response handler interface.

AbstractHTTPResponseHandler(Provider) - Constructor for class org.fax4j.spi.http.AbstractHTTPResponseHandler

This is the default constructor.

AbstractHylaFAXClientConnectionFactory - Class in org.fax4j.spi.hylafax

Provides partial implementation of the HaylaFAX connection factory.

AbstractHylaFAXClientConnectionFactory() - Constructor for class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

This is the class constructor.

AbstractLogger - Class in org.fax4j.common

This is a partial implementation of the logger.

AbstractLogger() - Constructor for class org.fax4j.common.AbstractLogger

This is the default constructor.

AbstractMailConnectionFactory - Class in org.fax4j.spi.email

Provides partial implementation of the mail connection factory.

AbstractMailConnectionFactory() - Constructor for class org.fax4j.spi.email.AbstractMailConnectionFactory

This is the class constructor.

AbstractMailFaxClientSpi - Class in org.fax4j.spi.email

This class implements the fax client service provider interface.
This parial implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
Implementing SPI class will have to implement the createXXXFaxJobMessage methods.
These methods will return the message to be sent for that fax job operation.

AbstractMailFaxClientSpi() - Constructor for class org.fax4j.spi.email.AbstractMailFaxClientSpi

This is the default constructor.

AbstractMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.email

This class holds the SPI configuration constants.

AbstractMappingHTTPResponseHandler<T> - Class in org.fax4j.spi.http

This class provides an abstract mapping based implementation of the HTTP response handler interface.
This class expects to get a data object and will update the fax job as needed.
This class only supports extracting the fax job ID and fax job status from the response object, or in case of errors, extract the error message.

AbstractMappingHTTPResponseHandler() - Constructor for class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This is the default constructor.

AbstractMultiPart2JSONHTTPFaxClientSpi - Class in org.fax4j.spi.http

This class provides common base for HTTP based SPIs which submit multi part HTTP request and expect a JSON output.

AbstractMultiPart2JSONHTTPFaxClientSpi() - Constructor for class org.fax4j.spi.http.AbstractMultiPart2JSONHTTPFaxClientSpi

This is the default constructor.

AbstractProcessExecutor - Class in org.fax4j.util

The process executer enables to execute native processes.
This class provides only partial implementation of the executer.
Implementing classes must be statless and thread safe.

AbstractProcessExecutor() - Constructor for class org.fax4j.util.AbstractProcessExecutor

This is the class constructor.

AbstractRequestParser<T> - Class in org.fax4j.bridge

This class provides partial implementation of the fax bridge request parser used to extract the fax job and file info from the input data.

AbstractRequestParser() - Constructor for class org.fax4j.bridge.AbstractRequestParser

This is the class constructor.

AbstractService - Class in org.fax4j.common

This class provides partial implementation of the service interface.

AbstractService(Provider) - Constructor for class org.fax4j.common.AbstractService

This is the default constructor.

AbstractVendorPolicy - Class in org.fax4j.bridge

The vendor policy enables vendors to hook into the fax submitting flow, enabling to restrict access, bill customers and so on, before/after the fax is submitted.
This class implementation must be thread safe.

AbstractVendorPolicy(Provider) - Constructor for class org.fax4j.bridge.AbstractVendorPolicy

This is the class constructor.

AdapterFaxClientSpi - Class in org.fax4j.spi.adapter

This class implements the fax client service provider interface.
This implementation will proxy the requests to another internal SPI.
The internal SPI created will be based on configuration in the fax4j properties.
The configuration contains conditions such as OS, availability of java classes, availability of native libraries, availability of executables or validation that a certain fax4j property is defined and contains a value.
Once all conditions are met the internal SPI is created, otherwise the next SPI configuration is used.
If no SPI conditions are met, an exception will be thrown.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.adapter.internal.spi.types A ';' seperated list of SPI types.
This SPI will go over the list one by one based on the configured order and will validate the type conditions.
Once an SPI is found for which all conditions are met, the adapter SPI will create an instance of it and use it to proxy all fax operations to. mail;http;process;phaxio;hoiio;windows;vbs;linux;mac;hylafax;comm;interfax;nextivafax;send2fax;metrofax;faxage;extremefax;efax;rfax none true org.fax4j.spi.adapter.internal.spi.condition.xxx For each type defined in the org.fax4j.spi.adapter.internal.spi.types property, you can define custom conditions to validate.
These conditions include:
property - checks a fax4j property is defined and contains a value
OS - checks OS name contains the value (case insensitive)
java-class - checks that java class can be loaded
native-lib - checks that native lib can be loaded
executable - checks executable is on system path
stable - checks for a fax4j property org.fax4j.spi.xxx.stable is defined and equals true, where xxx is the SPI key (for example: org.fax4j.spi.adapter.stable=true)
Conditions are separated by a ';' character and the condition type and value are seperated by the ':' character, for example:
org.fax4j.spi.adapter.internal.spi.condition.vbs=OS:windows;executable:cscript.exe
The following conditions are always checked (even if not defined):
property:org.fax4j.spi.type.map.xxx where xxx is the SPI key (for example: org.fax4j.spi.type.map.adapter)
java-class:xxx where xxx is the SPI class name based on the fax4j mapping (for example: org.fax4j.spi.type.map.adapter=org.fax4j.spi.adapter.AdapterFaxClientSpi) stable org.fax4j.spi.adapter.internal.spi.condition.windows=OS:windows;native-lib:winfax
org.fax4j.spi.adapter.internal.spi.condition.vbs=OS:windows;executable:cscript.exe
org.fax4j.spi.adapter.internal.spi.condition.mail=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.address.template;property:org.fax4j.spi.mail.subject.template;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport
org.fax4j.spi.adapter.internal.spi.condition.http=property:org.fax4j.spi.http.client.class.name;property:org.fax4j.spi.http.host.name;property:org.fax4j.spi.http.faxjob2request.converter.class.name;property:org.fax4j.spi.http.response.handler.class.name
org.fax4j.spi.adapter.internal.spi.condition.process=property:org.fax4j.spi.process.submit.template.command
org.fax4j.spi.adapter.internal.spi.condition.linux=OS:linux;executable:efax;property:org.fax4j.spi.linux.submit.template.command
org.fax4j.spi.adapter.internal.spi.condition.mac=OS:mac;property:org.fax4j.spi.mac.print.queue.name
org.fax4j.spi.adapter.internal.spi.condition.hylafax=property:org.fax4j.spi.hylafax.host;property:org.fax4j.spi.hylafax.user;property:org.fax4j.spi.hylafax.mode;property:org.fax4j.spi.hylafax.type;property:org.fax4j.spi.hylafax.connection.factory.class.name;java-class:gnu.hylafax.HylaFAXClient
org.fax4j.spi.adapter.internal.spi.condition.comm=property:org.fax4j.spi.comm.port.name;property:org.fax4j.spi.comm.connection.factory.class.name;property:org.fax4j.spi.comm.fax.modem.class.name
org.fax4j.spi.adapter.internal.spi.condition.interfax=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport
org.fax4j.spi.adapter.internal.spi.condition.nextivafax=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport
org.fax4j.spi.adapter.internal.spi.condition.send2fax=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport
org.fax4j.spi.adapter.internal.spi.condition.metrofax=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport org.fax4j.spi.adapter.internal.spi.condition.faxage=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport org.fax4j.spi.adapter.internal.spi.condition.extremefax=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport org.fax4j.spi.adapter.internal.spi.condition.efax=property:org.fax4j.spi.mail.connection.factory.class.name;property:org.fax4j.spi.mail.user.name;property:org.fax4j.spi.mail.password;property:mail.host;java-class:javax.mail.Transport
org.fax4j.spi.adapter.internal.spi.condition.phaxio=property:org.fax4j.spi.phaxio.api.key;property:org.fax4j.spi.phaxio.api.secret;java-class:org.json.JSONObject
org.fax4j.spi.adapter.internal.spi.condition.hoiio=property:org.fax4j.spi.hoiio.app.id;property:org.fax4j.spi.hoiio.access.token;java-class:org.json.JSONObject
org.fax4j.spi.adapter.internal.spi.condition.rfax=property:org.fax4j.spi.rfax.port.name;property:org.fax4j.spi.rfax.fax.class;java-class:com.java4less.rfax.FaxModem none true org.fax4j.spi.adapter.configuration.override.xxx The adapter SPI enables to override the fax4j configuration for the internal SPI,
by defining org.fax4j.spi.adapter.configuration.override.xxx properties where xxx is the original property name for example:
org.fax4j.spi.adapter.configuration.override.org.fax4j.proxy.enabled=false overrides the org.fax4j.proxy.enabled property for the interal SPI. org.fax4j.spi.adapter.configuration.override.org.fax4j.proxy.enabled=false none false

AdapterFaxClientSpi() - Constructor for class org.fax4j.spi.adapter.AdapterFaxClientSpi

This is the default constructor.

AdapterFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.adapter

This class holds the SPI configuration constants.

addAdditionalContentParts(HTTPFaxClientSpi, FaxActionType, FaxJob, List<HTTPRequest.ContentPart<?>>) - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This function enables extending classes to add additional content parts.

addAdditionalParameters(List<HTTPRequest.ContentPart<?>>) - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This function adds the additional parameters.

addAllBuffer(List<String>, StringBuilder) - Method in class org.fax4j.util.DefaultProcessExecutor

Updates the command list and the buffer.

addCommandLineArgument(StringBuilder, String, String) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function adds the given command line argument to the buffer.

addContentPart(List<HTTPRequest.ContentPart<?>>, String, String) - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This function adds a string content part

addFaxClientActionEventListener(FaxClientActionEventListener) - Method in interface org.fax4j.common.FaxClientActions

This function adds the fax client action event listener to the internal fax event listeners data structure.

addFaxClientActionEventListener(FaxClientActionEventListener) - Method in class org.fax4j.FaxClient

This function adds the fax client action event listener to the internal fax event listeners data structure.

addFaxClientActionEventListener(FaxClientActionEventListener) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function adds the fax client action event listener to the internal fax event listeners data structure.

addFaxMonitorEventListener(FaxMonitorEventListener) - Method in interface org.fax4j.common.FaxClientActions

This function adds the fax monitor event listener to the internal fax event listeners data structure.
Fax jobs will be monitored only if there are active listeners registered.
If the listeners are added after a fob job was submitted, that fax job would not be monitored.
Not all SPIs support monitoring events, in which case this method will throw an exception.

addFaxMonitorEventListener(FaxMonitorEventListener) - Method in class org.fax4j.FaxClient

This function adds the fax monitor event listener to the internal fax event listeners data structure.
Fax jobs will be monitored only if there are active listeners registered.
If the listeners are added after a fob job was submitted, that fax job would not be monitored.
Not all SPIs support monitoring events, in which case this method will throw an exception.

addFaxMonitorEventListener(FaxMonitorEventListener) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function adds the fax monitor event listener to the internal fax event listeners data structure.
Fax jobs will be monitored only if there are active listeners registered.
If the listeners are added after a fob job was submitted, that fax job would not be monitored.
Not all SPIs support monitoring events, in which case this method will throw an exception.

addFileNamePart - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

True to add the file name as an additional part

additionalParameters - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

Additional parameters

addPart(List<String>, StringBuilder, int, boolean) - Method in class org.fax4j.util.DefaultProcessExecutor

Updates the command list and the buffer.

addToStringAttributes(String) - Method in class org.fax4j.spi.AbstractFaxJob

This function adds the common attributes for the toString printing.

APACHE_LOGGER - Variable in class org.fax4j.common.ApacheCommonsLogger

The apache commons logger

ApacheCommonsLogger - Class in org.fax4j.common

This is a simple proxy implementation of the logger that transfers all log events to the apache commons logger.

ApacheCommonsLogger() - Constructor for class org.fax4j.common.ApacheCommonsLogger

This is the default constructor.

ApacheHTTPClient - Class in org.fax4j.spi.http

This HTTP client is based on the Apache HTTP client and is used to submit HTTP requests.

ApacheHTTPClient() - Constructor for class org.fax4j.spi.http.ApacheHTTPClient

This is the default constructor.

appendBaseURL(StringBuilder, String, HTTPClientConfiguration) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function appends the base URL (protocol, host, port and resource) to the provided buffer.

appendParameters(StringBuilder, String) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function appends the parameters text to the base URL.

B

blockAndReleaseAllCloseableResources() - Static method in class org.fax4j.util.CloseableResourceManager

Blocks any call to register/unregister new resources and releases all resources currently registered.

C

cancelFaxJob(FaxJob) - Method in interface org.fax4j.common.FaxClientActions

This function will cancel an existing fax job.

cancelFaxJob(FaxJob) - Method in class org.fax4j.FaxClient

This function will cancel an existing fax job.

cancelFaxJob(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJob(HylaFaxJob, HylaFAXClient) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobIDParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The cancel fax action, fax job ID parameter name

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsFaxClientSpi

This function will cancel an existing fax job.

cancelFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function will cancel an existing fax job.

close() - Method in class org.fax4j.util.AbstractCloseable

Closes the connection.

CloseableResourceManager - Class in org.fax4j.util

This class is used to hold/release closeable resources.
All registered closeable resources will be closed when the JVM exists.

closeImpl() - Method in class org.fax4j.spi.comm.RXTXCommPortAdapter

Closes the connection.

closeImpl() - Method in class org.fax4j.util.AbstractCloseable

Closes the connection.

closeImpl() - Method in class org.fax4j.util.ConnectionImpl

Closes the connection.

closeMailConnection(Connection<MailResourcesHolder>) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function closes the provided mail connection.

closeResource(Closeable) - Static method in class org.fax4j.util.IOHelper

Closes the provided resource.

COMMAND_PARSER_CLASS_NAME_PROPERTY_KEY - Static variable in class org.fax4j.bridge.process.Process2FaxBridge

The command parser class name

CommandLineArgumentsParser - Interface in org.fax4j.bridge.process

This interface defines the command line parser used to extract the fax job and file info from the command line arguments.

CommFaxClientSpi - Class in org.fax4j.spi.comm

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending the data via COMM ports to the fax modem.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Beta

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.comm.port.name The COMM port name (COM1, ...) property key none none true org.fax4j.spi.comm.connection.factory.class.name The connection factory class name org.fax4j.spi.comm.CommPortConnectionFactoryImpl org.fax4j.spi.comm.CommPortConnectionFactoryImpl false org.fax4j.spi.comm.fax.modem.class.name The fax modem class name none none true org.fax4j.spi.comm.connection.timeout The timeout value when trying to own a COMM port 1500 1500 false
Limitations:
See the relevant COMM connection and fax modem documentation.

CommFaxClientSpi() - Constructor for class org.fax4j.spi.comm.CommFaxClientSpi

This is the default constructor.

CommFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.comm

This class holds the SPI configuration constants.

CommonHTTPClientConfiguration - Class in org.fax4j.spi.http

This is the common HTTP client configuration.

CommonHTTPClientConfiguration() - Constructor for class org.fax4j.spi.http.CommonHTTPClientConfiguration

This is the class constructor.

CommonHTTPClientConfiguration.HTTPClientConfigurationConstants - Enum in org.fax4j.spi.http

This class holds the configuration constants.

CommPortAdapter - Interface in org.fax4j.spi.comm

This class defines the COMM port adapter.

CommPortConnectionFactory - Interface in org.fax4j.spi.comm

This class defines the COMM port connection factory.

CONFIGURATION_FILE_NAME - Static variable in class org.fax4j.util.LibraryConfigurationLoader

The configuration file name

ConfigurationHolder - Interface in org.fax4j.common

Common interface for configuration holder components.

ConfigurationHolderImpl - Class in org.fax4j.common

This is a common basic implementation of the configuration holder.

ConfigurationHolderImpl(Map<String, String>) - Constructor for class org.fax4j.common.ConfigurationHolderImpl

This is the class constructor.

ConfigurationHolderImpl(Map<String, String>, String) - Constructor for class org.fax4j.common.ConfigurationHolderImpl

This is the class constructor.

Connection<T> - Interface in org.fax4j.util

This class defines basic common connection capabilities.

ConnectionFactory<T> - Interface in org.fax4j.util

This class defines the basic common connection factory capabilities.

ConnectionImpl<T> - Class in org.fax4j.util

This class provides the basic common connection implementation.

ConnectionImpl(T, ConnectionFactory<T>) - Constructor for class org.fax4j.util.ConnectionImpl

This is the class constructor.

ContentPart(String, T, HTTPRequest.ContentPartType) - Constructor for class org.fax4j.spi.http.HTTPRequest.ContentPart

This is the class constructor.

ContextFaxBridge<T> - Interface in org.fax4j.bridge

This interface defines only the common capabilities of the context fax bridge.

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

convertParametersTextToMap(HTTPRequest) - Method in class org.fax4j.bridge.http.SimpleHTTPRequestParser

This function converts the provided query string to a map object.

convertStringToBinary(String, String) - Static method in class org.fax4j.util.IOHelper

This function converts the provided string to binary data.

convertToObject(HTTPResponse) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function converts the HTTP response content to the specific object.

convertToObject(HTTPResponse) - Method in class org.fax4j.spi.http.JSONHTTPResponseHandler

This function converts the HTTP response content to the specific object.

convertToObject(HTTPResponse) - Method in class org.fax4j.spi.http.XMLHTTPResponseHandler

This function converts the HTTP response content to the specific object.

copyPropertiesToMap(Properties, Map<String, String>) - Static method in class org.fax4j.util.SpiUtil

This function copies all mappings from source properties to target map.

createBinaryRequestContent(HTTPRequest) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function creates a binary type request entity and populates it with the data from the provided HTTP request.

createCancelFaxJobHTTPRequest(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Creates the HTTP request from the fax job data.

createCancelFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createCancelFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createCancelFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Creates the process command from the fax job data.

createCancelFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

Creates the process command from the fax job data.

createChildFaxClientSpi(String, Properties) - Static method in class org.fax4j.spi.FaxClientSpiFactory

This function creates a new fax client SPI based on the provided configuration.
This is an internal framework method and should not be invoked by classes outside the fax4j framework.

createCommonHTTPRequest(HTTPFaxClientSpi, FaxActionType) - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

Creates a HTTP request with the common data.

createCommPortConnection() - Method in class org.fax4j.spi.comm.CommFaxClientSpi

Creates and returns the COMM port connection to be used.

createCommPortConnectionFactory() - Method in class org.fax4j.spi.comm.CommFaxClientSpi

Creates and returns the COMM port connection factory.

createConnection() - Method in class org.fax4j.util.AbstractConnectionFactory

Creates and returns the connection to be used.

createConnection() - Method in interface org.fax4j.util.ConnectionFactory

Creates and returns the connection to be used.

createConnectionForResource(T) - Method in class org.fax4j.util.AbstractConnectionFactory

Creates and returns the connection to be used.

createFaxClient() - Static method in class org.fax4j.FaxClientFactory

This function creates a new fax client based on the default configuration.

createFaxClient(String, Properties) - Static method in class org.fax4j.FaxClientFactory

This function creates a new fax client based on the provided configuration.

createFaxClientSpi(String) - Method in class org.fax4j.spi.adapter.AdapterFaxClientSpi

This function creates a new fax client SPI based on the provided configuration.

createFaxClientSpi(String, Properties) - Static method in class org.fax4j.spi.FaxClientSpiFactory

This function creates a new fax client SPI based on the provided configuration.
This is an internal framework method and should not be invoked by classes outside the fax4j framework.

createFaxClientSpiConfiguration() - Method in class org.fax4j.spi.adapter.AdapterFaxClientSpi

This function creates and returns the internal fax client SPI configuration.

createFaxJob() - Method in class org.fax4j.bridge.AbstractFaxBridge

This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.

createFaxJob() - Method in interface org.fax4j.bridge.FaxBridge

Returns the internal fax client.

createFaxJob() - Method in interface org.fax4j.common.FaxClientActions

This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.

createFaxJob() - Method in class org.fax4j.FaxClient

This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.

createFaxJob() - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.

createFaxJob2HTTPRequestConverter() - Method in class org.fax4j.spi.http.AbstractMultiPart2JSONHTTPFaxClientSpi

This function creates and returns a new faxjob to HTTP request converter instance.

createFaxJob2HTTPRequestConverter() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function creates and returns a new faxjob to HTTP request converter instance.

createFaxJobImpl() - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.

createFaxJobImpl() - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.

createFaxJobImpl() - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.

createFaxModemAdapter() - Method in class org.fax4j.spi.comm.CommFaxClientSpi

Creates and returns the fax modem adapter.

createGetFaxJobStatusHTTPRequest(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Creates the HTTP request from the fax job data.

createGetStatusFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Creates the process command from the fax job data.

createGetStatusFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

Creates the process command from the fax job data.

createHttpClient() - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function creates and returns a new HTTP client.

createHTTPClientConfiguration() - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

This function creates and returns the HTTP configuration object.

createHTTPClientConfiguration(ConfigurationHolder) - Method in class org.fax4j.spi.http.AbstractHTTPClient

This function creates the HTTP client configuration to be used later on by this HTTP client type.

createHTTPClientConfiguration(ConfigurationHolder) - Method in interface org.fax4j.spi.http.HTTPClient

This function creates the HTTP client configuration to be used later on by this HTTP client type.

createHTTPClientConfiguration() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function creates and returns the HTTP configuration object.

createHTTPClientConfiguration() - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

This function creates and returns the HTTP configuration object.

createHTTPRequest(HTTPFaxClientSpi, FaxActionType, FaxJob) - Method in interface org.fax4j.spi.http.FaxJob2HTTPRequestConverter

Creates the HTTP request from the fax job data.

createHTTPRequest(HTTPFaxClientSpi, FaxActionType, FaxJob) - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

Creates the HTTP request from the fax job data.

createHTTPRequest(HTTPFaxClientSpi, FaxActionType, FaxJob) - Method in class org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter

Creates the HTTP request from the fax job data.

createHTTPRequest(HTTPFaxClientSpi, FaxActionType, Enum<?>, FaxJob) - Method in class org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter

Creates the HTTP request from the fax job data.

createHTTPResponse(int, String) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function creates and returns the HTTP response object.

createHTTPResponseHandler() - Method in class org.fax4j.spi.http.AbstractMultiPart2JSONHTTPFaxClientSpi

This function creates and returns a new HTTP response handler.

createHTTPResponseHandler() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function creates and returns a new HTTP response handler.

createHylaFAXClient() - Method in class org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl

This function creates and returns the HylaFax client.

createHylaFAXClientConnectionFactory(String) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

Creates and returns the hylafax client connection factory.

createInstance(Class<?>) - Static method in class org.fax4j.util.ReflectionHelper

This function creates a new instance of the requested type.

createInstance(String) - Static method in class org.fax4j.util.ReflectionHelper

This function creates a new instance of the requested type.

createMacProcessOutputValidator() - Method in class org.fax4j.spi.mac.MacFaxClientSpi

This function creates and returns the process output validator.

createMailConnection() - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

Creates and returns the mail connection to be used to send the fax via mail.

createMailConnectionFactoryImpl(String) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

Creates and returns the mail connection factory.

createMethod(String, HTTPClient.HTTPMethod) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function creates and returns a new HTTP method.

createMultiPartRequestContent(HTTPRequest, HttpMethodBase) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function creates a multi part type request entity and populates it with the data from the provided HTTP request.

createProcessCommand(Enum<?>, FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Creates the process command from the fax job data.

createProcessCommand(String) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function creates and returns the fax4j.exe command.

createProcessCommandArgumentsForExistingFaxJob(String, FaxJob) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function creates and returns the command line arguments for the fax4j external exe when running an action on an existing fax job.

createProcessCommandArgumentsForSubmitFaxJob(FaxJob) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function creates and returns the command line arguments for the fax4j external exe when running the submit fax job action.

createProcessOutputHandler() - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function creates and returns the process output handler.

createProcessOutputHandler() - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function creates and returns the process output handler.

createProcessOutputValidator() - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function creates and returns the process output validator.

createProcessOutputValidator() - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function creates and returns the process output validator.

createReader(InputStream, String) - Static method in class org.fax4j.util.IOHelper

This function creates and returns a new reader for the provided input stream.

createRequestParser() - Method in class org.fax4j.bridge.AbstractContextFaxBridge

This function creates, initializes and returns a new request parser.

createRequestParser(String, String) - Method in class org.fax4j.bridge.AbstractContextFaxBridge

This function creates, initializes and returns a new request parser.

createResourceImpl() - Method in class org.fax4j.spi.comm.RXTXCommPortConnectionFactory

Creates and returns the resource.

createResourceImpl() - Method in class org.fax4j.spi.email.MailConnectionFactoryImpl

Creates and returns the resource.

createResourceImpl() - Method in class org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl

Creates and returns the resource.

createResourceImpl() - Method in class org.fax4j.util.AbstractConnectionFactory

Creates and returns the resource.

createResumeFaxJobHTTPRequest(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Creates the HTTP request from the fax job data.

createResumeFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createResumeFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createResumeFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Creates the process command from the fax job data.

createResumeFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

Creates the process command from the fax job data.

createService(Enum<?>, String, ConfigurationHolder, String) - Static method in class org.fax4j.common.ServiceFactory

This function creates, initializes and returns new service objects.

createService(String, String, ConfigurationHolder, String) - Static method in class org.fax4j.common.ServiceFactory

This function creates, initializes and returns new service objects.

createStringRequestContent(HTTPRequest) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function creates a string type request entity and populates it with the data from the provided HTTP request.

createSubmitFaxCommand(FaxJob) - Method in class org.fax4j.spi.mac.MacFaxClientSpi

Creates and returns the submit fax command.

createSubmitFaxJobHTTPRequest(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Creates the HTTP request from the fax job data.

createSubmitFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createSubmitFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createSubmitFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.interfax.InterfaxMailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createSubmitFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Creates the process command from the fax job data.

createSubmitFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

Creates the process command from the fax job data.

createSuspendFaxJobHTTPRequest(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Creates the HTTP request from the fax job data.

createSuspendFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createSuspendFaxJobMessage(FaxJob, MailResourcesHolder) - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException.

createSuspendFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Creates the process command from the fax job data.

createSuspendFaxJobProcessCommand(FaxJob) - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

Creates the process command from the fax job data.

createTransport(Session) - Method in class org.fax4j.spi.email.MailConnectionFactoryImpl

This function returns a transport for the provided session.

createURL(HTTPRequest, HTTPClientConfiguration) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function creates the full URL from the provided values.

createVendorPolicy() - Method in class org.fax4j.bridge.AbstractFaxBridge

This function returns the vendor policy.

createVendorPolicy() - Method in class org.fax4j.bridge.FaxBridgeImpl

This function returns the vendor policy.
This function will not initialize the vendor policy since the flow owner object needs to be provided.

createWriter(OutputStream, String) - Static method in class org.fax4j.util.IOHelper

This function creates and returns a new writer for the provided output stream.

D

DEBUG - Static variable in class org.fax4j.common.LogLevel

The DEBUG log level

DEBUG_LOG_LEVEL_VALUE - Static variable in class org.fax4j.common.LogLevel

The DEBUG log level

DEFAULT_PORT_PROPERTY_VALUE - Static variable in class org.fax4j.spi.hylafax.HylaFaxClientSpi

The fax server default port

DEFAULT_SPI_TYPE_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The default SPI type property key

DefaultCommandLineArgumentsParser - Class in org.fax4j.bridge.process

This class provides default predefined implementation of the command line parser used to extract the fax job and file info from the command line arguments.
This default parser expects the command line arguments as follows:
-file [full file name] -priority [priority value as defined in the enum] -target_address [target address] -target_name [target name] -sender_name [sender name] -sender_fax_number [sender fax number] -sender_email [sender email] -property:[property name] [property value]

DefaultCommandLineArgumentsParser() - Constructor for class org.fax4j.bridge.process.DefaultCommandLineArgumentsParser

This is the class constructor.

DefaultMailMessageParser - Class in org.fax4j.bridge.email

This class provides default predefined implementation of the HTTP request parser used to extract the fax job and file info from the HTTP request.
This default parser expects the mail message as follows:
Subject line: fax:[number] where number is the target address From email address would be used as sender email First attachment (or in case of none, the body text) would be used as the fax data

DefaultMailMessageParser() - Constructor for class org.fax4j.bridge.email.DefaultMailMessageParser

This is the class constructor.

DefaultProcessExecutor - Class in org.fax4j.util

The process executer enables to execute native processes.
This class provides the default implementation of the executer.

DefaultProcessExecutor() - Constructor for class org.fax4j.util.DefaultProcessExecutor

This is the class constructor.

E

EFaxMailFaxClientSpi - Class in org.fax4j.spi.efax

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The efax mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
This implementation is not meant to promote the commercial service but to serve as a service provider interface for it.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

EFaxMailFaxClientSpi() - Constructor for class org.fax4j.spi.efax.EFaxMailFaxClientSpi

This is the default constructor.

EFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.efax

This class holds the SPI configuration constants.

EMail2FaxBridge - Class in org.fax4j.bridge.email

This is the email2fax based implementation of the fax bridge.

EMail2FaxBridge() - Constructor for class org.fax4j.bridge.email.EMail2FaxBridge

This is the class constructor.

EMPTY_STRING - Static variable in class org.fax4j.util.SpiUtil

The empty string value

EmptyHTTPResponseHandler - Class in org.fax4j.spi.http

This class provides empty implementation of the HTTP response handler interface.

EmptyHTTPResponseHandler() - Constructor for class org.fax4j.spi.http.EmptyHTTPResponseHandler

This is the default constructor.

EmptyVendorPolicy - Class in org.fax4j.bridge

The vendor policy enables vendors to hook into the fax submitting flow, enabling to restrict access, bill customers and so on, before/after the fax is submitted.
This implementation simply lets the fax flow continue without doing any policy handling.

EmptyVendorPolicy() - Constructor for class org.fax4j.bridge.EmptyVendorPolicy

This is the class constructor.

enableAdminOperations - Variable in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

The enable admin operations flag

encodeTemplateParameter(String) - Method in class org.fax4j.util.SpiUtil.URLTemplateParameterEncoder

This function encodes the given template parameter text.

equals(Object) - Method in class org.fax4j.common.ProviderImpl

This function returns true if the provided object is equal to this object.

ERROR - Static variable in class org.fax4j.common.LogLevel

The ERROR log level

ERROR_LOG_LEVEL_VALUE - Static variable in class org.fax4j.common.LogLevel

The ERROR log level

executeProcess(String, FaxActionType) - Method in class org.fax4j.spi.mac.MacFaxClientSpi

This function executes the external command to send the fax.

executeProcess(FaxJob, String, FaxActionType) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Executes the process and returns the output.

executeProcess(ConfigurationHolder, String) - Method in class org.fax4j.util.AbstractProcessExecutor

This function executes the given command and returns the process output.

executeProcess(ConfigurationHolder, String) - Method in interface org.fax4j.util.ProcessExecutor

This function executes the given command and returns the process output.

executeProcess(ConfigurationHolder, String) - Static method in class org.fax4j.util.ProcessExecutorHelper

This function executes the given command and returns the process output.

executeProcessImpl(ConfigurationHolder, String) - Method in class org.fax4j.util.AbstractProcessExecutor

This function executes the given command and returns the process output.

executeProcessImpl(ConfigurationHolder, String) - Method in class org.fax4j.util.DefaultProcessExecutor

This function executes the given command and returns the process output.

ExitCodeProcessOutputValidator - Class in org.fax4j.spi.process

This process output validator simply checks the exit code is 0.

ExitCodeProcessOutputValidator() - Constructor for class org.fax4j.spi.process.ExitCodeProcessOutputValidator

This is the class constructor.

extractNativeResources() - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function extracts the native resources (the fax4j.exe and fax4j.dll) and pushes them to the fax4j temporary directory.

ExtremeFaxMailFaxClientSpi - Class in org.fax4j.spi.extremefax

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The Extreme Fax mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
This implementation is not meant to promote the commercial service but to serve as a service provider interface for it.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

ExtremeFaxMailFaxClientSpi() - Constructor for class org.fax4j.spi.extremefax.ExtremeFaxMailFaxClientSpi

This is the default constructor.

ExtremeFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.extremefax

This class holds the SPI configuration constants.

F

factoryConfigurationHolder - Variable in class org.fax4j.util.AbstractConnectionFactory

The configuration holder

FAX4J_PROVIDER - Static variable in class org.fax4j.common.Fax4JProvider

The fax4j provider

Fax4JProvider - Class in org.fax4j.common

This is the internal provider used by the internal fax4j SPI.

Fax4JProvider() - Constructor for class org.fax4j.common.Fax4JProvider

This is the class constructor.

FAX_CLIENT_CLASS_NAME_PROPERTY_KEY - Static variable in class org.fax4j.FaxClientFactory

The fax client class name property key

FAX_JOB_ID_TEMPLATE_PARAMETER - Static variable in class org.fax4j.util.SpiUtil

The fax job ID template parameter

FAX_JOB_ID_TEMPLATE_PARAMETER_STRING - Static variable in class org.fax4j.util.SpiUtil

The fax job ID template parameter

FAX_JOB_MONITOR_CLASS_NAME_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The fax job monitor class name property key

FaxActionType - Enum in org.fax4j.common

This is the fax action type enum.

FaxAgeMailFaxClientSpi - Class in org.fax4j.spi.faxage

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The FaxAge mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
This implementation is not meant to promote the commercial service but to serve as a service provider interface for it.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

FaxAgeMailFaxClientSpi() - Constructor for class org.fax4j.spi.faxage.FaxAgeMailFaxClientSpi

This is the default constructor.

FaxAgeMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.faxage

This class holds the SPI configuration constants.

FaxBridge - Interface in org.fax4j.bridge

This interface defines only the common capabilities of the fax bridge.
Specific implementations may provide additional, more transport based capabilities.

FaxBridgeFlowHelper<T> - Class in org.fax4j.bridge

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

FaxBridgeFlowHelper(ContextFaxBridge<T>, String, Properties, Object) - Constructor for class org.fax4j.bridge.FaxBridgeFlowHelper

This is the class constructor.

FaxBridgeFlowHelper.FlowResponse - Class in org.fax4j.bridge

This class holds the response of the fax bridge flow invocation.

FaxBridgeImpl - Class in org.fax4j.bridge

This class basic implementation of the fax bridge.
Specific implementations may provide additional, more transport based capabilities.

FaxBridgeImpl() - Constructor for class org.fax4j.bridge.FaxBridgeImpl

This is the class constructor.

FaxClient - Class in org.fax4j

This is the fax client.
The fax client enables to perform activities such as sending/suspending fax jobs and so on.
This is the class which will be used by external applications to invoke the actual fax related activites.
To create a new instance of the fax client, you will need to invoke the FaxClientFactory.createFaxClient method.
Here is a sample code that creates a new fax client and submits a new fax job:

FaxClient(FaxClientSpi) - Constructor for class org.fax4j.FaxClient

This is the default constructor.

FaxClientActionEvent - Class in org.fax4j

This class holds the fax client action event data.

FaxClientActionEvent(FaxClientActionEvent.FaxClientActionEventID, FaxJob) - Constructor for class org.fax4j.FaxClientActionEvent

This is the class constructor.

FaxClientActionEvent.FaxClientActionEventID - Enum in org.fax4j

This is the fax client action event ID enum.
This enum holds all the possible event ID.

FaxClientActionEventListener - Interface in org.fax4j

This interface defines the fax client action event listener.
The listener picks up events based on actions invoked on the fax client and not based on the status changes of the actual fax job.
For example is a fax job is submitted via fax client, than the faxJobSubmitted event method will be invoked.
However the fax job itself might still be pending transmission by the actual fax modem/server.

FaxClientActions - Interface in org.fax4j.common

Defines all the fax client actions and capabilities.

FaxClientFactory - Class in org.fax4j

This is the fax client factory which is used to create new instances of the fax client.
To create a new instance of the fax client, you will need to invoke the FaxClientFactory.createFaxClient method.
Here is a sample code that creates a new fax client and submits a new fax job:

faxClientSpi - Variable in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

The fax client SPI

FaxClientSpi - Interface in org.fax4j.spi

This interface defines the fax client service provider interface.
This is the actual engine behind the fax4j framework.
It handles the fax client activities such as sending/suspending fax jobs and so on.
The SPI is an internal class that should be used internally only.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

For SPI specific configuration, see the relevant SPI class javadoc.

FaxClientSpiFactory - Class in org.fax4j.spi

This is the fax client SPI factory which is used to create new instances of the fax client SPI.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

Below table describes the configuration values relevant for this class, for SPI specific configuration, see the relevant SPI class javadoc.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.type.map.xxx For each SPI type, there is a property that (with prefix: org.fax4j.spi.type.map.

FaxClientSpiInterceptor - Interface in org.fax4j.spi

This interface defines the fax client SPI interceptor which enables to invoke custom logic before and after the fax client SPI method invocations (such as logging).

FaxClientSpiProxy - Interface in org.fax4j.spi

This interface defines the fax client SPI proxy which enables to invoke interceptors before and after the fax client SPI method invocations.
With this proxy, it is possible to intercept all calls to the fax client SPIs and perform custom logic such as logging.

FaxClientSpiProxy.FaxClientSpiProxyEventType - Enum in org.fax4j.spi

This is the fax client SPI proxy event type.

FaxClientSpiProxyImpl - Class in org.fax4j.spi

This class provides basic implementation of the fax client SPI proxy which enables to invoke interceptors before and after the fax client SPI method invocations.
With this proxy, it is possible to intercept all calls to the fax client SPIs and perform custom logic such as logging.

FaxClientSpiProxyImpl() - Constructor for class org.fax4j.spi.FaxClientSpiProxyImpl

This is the default constructor.

FaxException - Exception in org.fax4j

A general exception class used by the fax4j framework.

FaxException(String) - Constructor for exception org.fax4j.FaxException

This is the default constructor.

FaxException(String, Throwable) - Constructor for exception org.fax4j.FaxException

This is the default constructor.

FaxJob - Interface in org.fax4j

This interface defines the fax job.

FaxJob.FaxJobPriority - Enum in org.fax4j

This is the fax job priority enum which holds the possible fax sending priority values.

FaxJob2HTTPRequestConverter - Interface in org.fax4j.spi.http

The fax job to HTTP request converter interface enables to convert fax jobs to HTTP requests which will be submitted to invoke the fax action remotly.

faxJobCancelled(FaxClientActionEvent) - Method in interface org.fax4j.FaxClientActionEventListener

This function is invoked after a fax job is cancelled.

faxJobCreated(FaxClientActionEvent) - Method in interface org.fax4j.FaxClientActionEventListener

This function is invoked after a new fax job is created.

FaxJobImpl - Class in org.fax4j.spi

This class provides basic implementation of the fax job.

FaxJobImpl() - Constructor for class org.fax4j.spi.FaxJobImpl

This is the class constructor.

FaxJobMonitor - Interface in org.fax4j.spi

This interface defines the fax job monitor capabilities.

FaxJobMonitorImpl - Class in org.fax4j.spi

This class provides the default implementation of the fax job monitor.

FaxJobMonitorImpl() - Constructor for class org.fax4j.spi.FaxJobMonitorImpl

This is the class constructor.

FaxJobMonitorImpl.PollerTask - Class in org.fax4j.spi

This class used the start the polling cycle.

faxJobResumed(FaxClientActionEvent) - Method in interface org.fax4j.FaxClientActionEventListener

This function is invoked after a fax job is resumed.

FaxJobStatus - Enum in org.fax4j

This is the fax job status enum which holds the possible fax status values.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

faxJobStatusChanged(FaxMonitorEvent) - Method in interface org.fax4j.FaxMonitorEventListener

This function is invoked when the fax job status is changed.

faxJobSubmitted(FaxClientActionEvent) - Method in interface org.fax4j.FaxClientActionEventListener

This function is invoked after a fax job is submitted.

faxJobSuspended(FaxClientActionEvent) - Method in interface org.fax4j.FaxClientActionEventListener

This function is invoked after a fax job is suspended.

FaxModemAdapter - Interface in org.fax4j.spi.comm

Defines a local fax modem adapter.
This adapter can only work with fax modems that are directly connected to the machine via COMM port.
The fax modem is not thread safe and it is up to the caller class to synchronize any non thread safe resource, such as the COMM adapter.

FaxMonitorEvent - Class in org.fax4j

This class holds the fax monitor event data.

FaxMonitorEvent(FaxMonitorEvent.FaxMonitorEventID, FaxJob, FaxJobStatus) - Constructor for class org.fax4j.FaxMonitorEvent

This is the class constructor.

FaxMonitorEvent.FaxMonitorEventID - Enum in org.fax4j

This is the fax monitor event ID enum.
This enum holds all the possible event ID.

FaxMonitorEventListener - Interface in org.fax4j

This interface defines the fax monitor event listener.
The listener picks up remote events based on changes done on the remote fax modem.

faxServerName - Variable in class org.fax4j.spi.vbs.VBSFaxClientSpi

The fax server name

FILE_TEMPLATE_PARAMETER - Static variable in class org.fax4j.util.SpiUtil

The file template parameter

FILE_TEMPLATE_PARAMETER_STRING - Static variable in class org.fax4j.util.SpiUtil

The file template parameter

fileContentParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The file content parameter name

FileInfo - Class in org.fax4j.bridge

This class defines the file info object.
Since bridges may get fax requests for file data which is part of the payload and not for a local file, the bridge will have to have enough information of the file data and type to pass to the fax client.
The file info object serves that purpose of holding all of the file information needed to send the fax.

FileInfo(File) - Constructor for class org.fax4j.bridge.FileInfo

This is the class constructor.

FileInfo(String, byte[]) - Constructor for class org.fax4j.bridge.FileInfo

This is the class constructor.

fileNameParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The file name parameter name

finalize() - Method in class org.fax4j.spi.comm.CommFaxClientSpi

Releases the COMM port connection if open.

finalize() - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

Releases the connection if open.

finalize() - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

Releases the connection if open.

findError(T) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function will look for errors in the object and if found will return the error message.
If no errors were found, this method will return null.

findValue(HTTPResponse, String) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function returns the requested value from the HTTP response content.
The path is a set of key names seperated by ';'.

findValue(T, String) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function returns the requested value from the object data.
The path is a set of key names seperated by ';'.

findValueImpl(T, String) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function returns the requested value from the object data.
The path is a set of key names seperated by ';'.

findValueImpl(JSONObject, String) - Method in class org.fax4j.spi.http.JSONHTTPResponseHandler

This function returns the requested value from the object data.
The path is a set of key names seperated by ';'.

findValueImpl(Document, String) - Method in class org.fax4j.spi.http.XMLHTTPResponseHandler

This function returns the requested value from the object data.
The path is a set of key names seperated by ';'.

fireFaxEvent(FaxClientActionEvent.FaxClientActionEventID, FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function fires a new fax event.

fireFaxEvent(FaxMonitorEvent.FaxMonitorEventID, FaxJob, FaxJobStatus) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function fires a new fax event.

fireFaxMonitorEvent(FaxMonitorEvent.FaxMonitorEventID, FaxJob, FaxJobStatus) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function fires a new fax monitor event.

fireFaxMonitorEvent(FaxMonitorEvent.FaxMonitorEventID, FaxJob, FaxJobStatus) - Method in interface org.fax4j.spi.FaxClientSpi

This function fires a new fax monitor event.

FIXED_POLLING_INTERVAL_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxJobMonitorImpl

The fax job polling interval fixed property key

fixedPollingInterval - Variable in class org.fax4j.spi.FaxJobMonitorImpl

The fixed polling interval settings

FlowResponse(FaxJob, boolean) - Constructor for class org.fax4j.bridge.FaxBridgeFlowHelper.FlowResponse

This is the class constructor.

format(Object[]) - Method in class org.fax4j.common.AbstractLogger

Converts the provided message object array to string.

format(Throwable) - Method in class org.fax4j.common.AbstractLogger

Converts the provided throwable to string.

formatHTTPResource(HTTPFaxClientSpi, FaxActionType, FaxJob) - Method in class org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter

This function formats the HTTP resource.

formatHTTPURLParameters(HTTPFaxClientSpi, FaxJob) - Method in class org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter

This function formats the HTTP URL parameters.

formatLogMessage(LogLevel, Object[], Throwable) - Method in class org.fax4j.common.AbstractLogger

Converts the provided data to string.

formatObject(Object) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function formats the provided object to enable embedding in VBS code.

formatTemplate(String, FaxJob) - Method in class org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter

This function formats the provided template.

formatTemplate(String, FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function formats the provided template.

formatTemplate(String, FaxJob, SpiUtil.TemplateParameterEncoder, boolean, boolean) - Static method in class org.fax4j.util.SpiUtil

This function formats the provided template.

G

generateScript(String, Object[]) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function generates the script and returns it.

getCommPortConnection() - Method in class org.fax4j.spi.comm.CommFaxClientSpi

Returns the COMM port connection to be used.

getConfiguration() - Method in class org.fax4j.bridge.AbstractFaxBridge

Returns the configuration.

getConfiguration() - Method in class org.fax4j.common.AbstractService

Returns the configuration.

getConfiguration() - Method in interface org.fax4j.common.ConfigurationHolder

Returns the configuration.

getConfiguration() - Method in class org.fax4j.common.ConfigurationHolderImpl

Returns the configuration.

getConfiguration() - Method in class org.fax4j.spi.AbstractFaxClientSpi

Returns the configuration.

getConfiguration(Properties) - Static method in class org.fax4j.spi.FaxClientSpiFactory

Returns the configuration to be used by the new SPI instance.
The configuration of the fax client SPI is made up of 3 layers.

getConfigurationValue(String) - Method in class org.fax4j.bridge.AbstractFaxBridge

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(Enum<?>) - Method in class org.fax4j.bridge.AbstractFaxBridge

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(String) - Method in class org.fax4j.common.AbstractService

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(Enum<?>) - Method in class org.fax4j.common.AbstractService

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(String) - Method in interface org.fax4j.common.ConfigurationHolder

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(Enum<?>) - Method in interface org.fax4j.common.ConfigurationHolder

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(String) - Method in class org.fax4j.common.ConfigurationHolderImpl

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(Enum<?>) - Method in class org.fax4j.common.ConfigurationHolderImpl

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(String) - Method in class org.fax4j.spi.AbstractFaxClientSpi

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(Enum<?>) - Method in class org.fax4j.spi.AbstractFaxClientSpi

Returns the value from the component configuration based on the provided configuration key.

getConfigurationValue(String) - Method in class org.fax4j.spi.AbstractFaxClientSpiInterceptor

Returns the value from the SPI configuration based on the provided configuration key.

getConfigurationValue(String) - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

Returns the value from the SPI configuration based on the provided configuration key.

getConfigurationValue(String) - Method in class org.fax4j.spi.AbstractFaxJobMonitor

Returns the value from the monitor configuration based on the provided configuration key.

getContent() - Method in class org.fax4j.bridge.FileInfo

This function returns the file content.

getContent() - Method in class org.fax4j.spi.http.HTTPRequest.ContentPart

This function returns the content of the part.

getContent() - Method in class org.fax4j.spi.http.HTTPResponse

This function returns the content.

getContentAsBinary() - Method in class org.fax4j.spi.http.HTTPRequest

This function returns the content.

getContentAsParts() - Method in class org.fax4j.spi.http.HTTPRequest

This function returns the content.

getContentAsString() - Method in class org.fax4j.spi.http.HTTPRequest

This function returns the content.

getContentPartAsString(Map<String, HTTPRequest.ContentPart<?>>, String) - Method in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

This function returns the content part string value.

getContentPartsAsMap(HTTPRequest) - Method in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

This function returns the HTTP request multi parts as map.

getContentType() - Method in class org.fax4j.spi.http.HTTPRequest

This function returns the content type of this request.

getDefaultEncoding() - Static method in class org.fax4j.util.IOHelper

This function returns the system default encoding.

getDefaultParserClassName() - Method in class org.fax4j.bridge.AbstractContextFaxBridge

This function returns the default request parser class name.

getDefaultParserClassName() - Method in class org.fax4j.bridge.email.EMail2FaxBridge

This function returns the default request parser class name.

getDefaultParserClassName() - Method in class org.fax4j.bridge.http.HTTP2FaxBridge

This function returns the default request parser class name.

getDefaultParserClassName() - Method in class org.fax4j.bridge.process.Process2FaxBridge

This function returns the default request parser class name.

getDescription() - Method in class org.fax4j.common.ProviderImpl

This function returns the provider description.

getDescription() - Method in interface org.fax4j.Provider

This function returns the provider description.

getEnum(String) - Static method in enum org.fax4j.spi.adapter.AdapterFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the enum for the provided value.

getErrorDetectionPathPropertyKey() - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

Returns the error detection path configuration key.

getErrorDetectionPathPropertyKey() - Method in class org.fax4j.spi.http.JSONHTTPResponseHandler

Returns the error detection path configuration key.

getErrorDetectionPathPropertyKey() - Method in class org.fax4j.spi.http.XMLHTTPResponseHandler

Returns the error detection path configuration key.

getErrorDetectionValuePropertyKey() - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

Returns the error detection value configuration key.

getErrorDetectionValuePropertyKey() - Method in class org.fax4j.spi.http.JSONHTTPResponseHandler

Returns the error detection value configuration key.

getErrorDetectionValuePropertyKey() - Method in class org.fax4j.spi.http.XMLHTTPResponseHandler

Returns the error detection value configuration key.

getErrorMessagePathPropertyKey() - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

Returns the error message path configuration key.

getErrorMessagePathPropertyKey() - Method in class org.fax4j.spi.http.JSONHTTPResponseHandler

Returns the error message path configuration key.

getErrorMessagePathPropertyKey() - Method in class org.fax4j.spi.http.XMLHTTPResponseHandler

Returns the error message path configuration key.

getErrorText() - Method in class org.fax4j.util.ProcessExecutorHelper.ProcessOutput

This function returns the process error text.

getExitCode() - Method in class org.fax4j.util.ProcessExecutorHelper.ProcessOutput

This function returns the process exit code.

getFax4jInternalTemporaryDirectory() - Static method in class org.fax4j.util.IOHelper

This function returns the fax4j library internal temporary directory.

getFaxBridge() - Method in class org.fax4j.bridge.FaxBridgeFlowHelper

This function returns the fax bridge.

getFaxClient() - Method in class org.fax4j.bridge.AbstractFaxBridge

Returns the internal fax client.

getFaxClient() - Method in interface org.fax4j.bridge.FaxBridge

Returns the internal fax client.

getFaxClientSpi() - Method in class org.fax4j.FaxClient

This function returns the fax client SPI.

getFaxClientSpi() - Method in class org.fax4j.spi.AbstractFaxClientSpiInterceptor

This function returns the fax client SPI.

getFaxClientSpi() - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

This function returns the fax client SPI.

getFaxClientSpiInterceptors() - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

This function returns the fax client SPI interceptors.

getFaxJob() - Method in class org.fax4j.AbstractFaxEvent

This function returns the fax job.

getFaxJob() - Method in class org.fax4j.bridge.FaxBridgeFlowHelper.FlowResponse

This function returns the fax job.

getFaxJob2HTTPRequestConverter() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Returns the fax job to HTTP request converter.

getFaxJobID(FaxJob) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function returns the fax job ID (if valid).

getFaxJobMonitor() - Method in class org.fax4j.spi.AbstractFaxClientSpi

Returns the fax job monitor.

getFaxJobMonitor() - Method in interface org.fax4j.spi.FaxClientSpi

Returns the fax job monitor.

getFaxJobStatus(FaxJob) - Method in interface org.fax4j.common.FaxClientActions

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatus(FaxJob) - Method in class org.fax4j.FaxClient

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatus() - Method in class org.fax4j.FaxMonitorEvent

This function returns the fax job status.

getFaxJobStatus(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatus(HTTPResponse) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function extracts the fax job status from the HTTP response data.

getFaxJobStatus(HTTPResponse) - Method in class org.fax4j.spi.http.EmptyHTTPResponseHandler

This function extracts the fax job status from the HTTP response data.

getFaxJobStatus(HTTPResponse) - Method in interface org.fax4j.spi.http.HTTPResponseHandler

This function extracts the fax job status from the HTTP response data.

getFaxJobStatus(ProcessExecutorHelper.ProcessOutput) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function extracts the fax job status from the process output.

getFaxJobStatus(FaxClientSpi, ProcessExecutorHelper.ProcessOutput) - Method in interface org.fax4j.spi.process.ProcessOutputHandler

This function extracts the fax job status from the process output.

getFaxJobStatus(FaxClientSpi, ProcessExecutorHelper.ProcessOutput) - Method in class org.fax4j.spi.vbs.VBSProcessOutputHandler

This function extracts the fax job status from the process output.

getFaxJobStatus(FaxClientSpi, ProcessExecutorHelper.ProcessOutput) - Method in class org.fax4j.spi.windows.WindowsProcessOutputHandler

This function extracts the fax job status from the process output.

getFaxJobStatusFromStatusString(String) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function returns the fax job status value based on the fax job status string value.

getFaxJobStatusFromWindowsFaxJobStatusString(String) - Method in class org.fax4j.spi.vbs.VBSProcessOutputHandler

This function returns the fax job status based on the windows fax job status string value.

getFaxJobStatusFromWindowsFaxJobStatusString(String) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function returns the fax job status based on the windows fax job status string value.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getFaxJobStatusImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

getField(Class<?>, String) - Static method in class org.fax4j.util.ReflectionHelper

This function returns the field wrapper for the requested field

getFile() - Method in class org.fax4j.bridge.FileInfo

This function returns the file.

getFile() - Method in interface org.fax4j.FaxJob

This function returns the file to fax.

getFile() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the file to fax.

getFile() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the file to fax.

getFileFromNativePath(String) - Static method in class org.fax4j.util.IOHelper

This function returns the file object of the first location in which the requested file is found.

getFileFromPathList(String, String[]) - Static method in class org.fax4j.util.IOHelper

This function returns the file object of the first location in which the requested file is found.

getFileInfo(Message) - Method in class org.fax4j.bridge.email.DefaultMailMessageParser

Returns the file info from the provided mail object.
This function does not handle multiple file attachments.

getFileInfoFromInputData(T) - Method in class org.fax4j.bridge.AbstractRequestParser

This function returns the file info from the input data.

getFileInfoFromInputData(T) - Method in interface org.fax4j.bridge.RequestParser

This function returns the file info from the input data.

getFileInfoFromInputDataImpl(T) - Method in class org.fax4j.bridge.AbstractRequestParser

This function returns the file info from the request data.

getFileInfoFromInputDataImpl(Message) - Method in class org.fax4j.bridge.email.DefaultMailMessageParser

This function returns the file info from the request data.

getFileInfoFromInputDataImpl(HTTPRequest) - Method in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

This function returns the file info from the request data.

getFileInfoFromInputDataImpl(HTTPRequest) - Method in class org.fax4j.bridge.http.SimpleHTTPRequestParser

This function returns the file info from the request data.

getFileInfoFromInputDataImpl(String[]) - Method in class org.fax4j.bridge.process.DefaultCommandLineArgumentsParser

This function returns the file info from the request data.

getFileInfoFromRequestImpl(HTTPRequest, Map<String, String>) - Method in class org.fax4j.bridge.http.SimpleHTTPRequestParser

This function returns the file info from the request data.

getFilePath() - Method in interface org.fax4j.FaxJob

This function returns the path to the file to fax.

getFilePath() - Method in class org.fax4j.spi.AbstractFaxJob

This function returns the path to the file to fax.

getFlowOwner() - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function returns the flow owner of this vendor policy.

getHeaderProperties() - Method in class org.fax4j.spi.http.HTTPRequest

This function returns the header properties.

getHostName() - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function returns the host name.

getHostName() - Method in interface org.fax4j.spi.http.HTTPClientConfiguration

This function returns the host name.

getHTTPClient() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Returns the HTTP client.

getHTTPClientConfiguration() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Returns the HTTP client configuration.

getHTTPResource(FaxActionType) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function returns the HTTP resource.

getHTTPResponseHandler() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Returns the HTTP response handler.

getHTTPURLParameters() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function returns the HTTP URL parameters.

getHylaFAXClient() - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

Returns an instance of the hyla fax client.

getHylaFaxJob() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

Returns the internal hylafax job.

getID() - Method in class org.fax4j.FaxClientActionEvent

This function returns the fax client action event ID.

getID() - Method in interface org.fax4j.FaxJob

This function returns the fax job ID.

getID() - Method in class org.fax4j.FaxMonitorEvent

This function returns the fax monitor event ID.

getID() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the fax job ID.

getID() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the fax job ID.

getInputStream() - Method in interface org.fax4j.spi.comm.CommPortAdapter

This function returns the input stream to the COMM port.

getInputStream() - Method in class org.fax4j.spi.comm.RXTXCommPortAdapter

This function returns the input stream to the COMM port.

getInstance() - Static method in class org.fax4j.common.LoggerManager

This function returns the global instance.

getInternalFaxClientSpi() - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function returns the internal fax client SPI.

getLogger() - Method in class org.fax4j.bridge.AbstractFaxBridge

Returns the internal logger.

getLogger() - Method in interface org.fax4j.bridge.FaxBridge

Returns the internal logger.

getLogger() - Method in class org.fax4j.common.AbstractService

Returns the internal logger.

getLogger() - Method in class org.fax4j.common.LoggerManager

This function returns the fax4j internal logger.

getLogger() - Method in class org.fax4j.spi.AbstractFaxClientSpi

Returns the internal logger.

getLogger() - Method in class org.fax4j.spi.AbstractFaxClientSpiInterceptor

Returns the internal logger.

getLogger() - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

Returns the internal logger.

getLogger() - Method in class org.fax4j.spi.AbstractFaxJobMonitor

Returns the internal logger.

getLogger() - Method in interface org.fax4j.spi.FaxClientSpi

Returns the internal logger.

getLogLevel() - Method in class org.fax4j.common.AbstractLogger

Returns the minimum log level.

getLogLevel() - Method in interface org.fax4j.common.Logger

Returns the minimum log level.

getMailAddressTemplate() - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function returns the mail address template.

getMailConnection() - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

Returns the mail connection to be used to send the fax via mail.

getMailSubjectTemplate() - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function returns the mail subject template.

getMethod(FaxActionType) - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function returns the HTTP method based on the provided fax action type.

getMethod(FaxActionType) - Method in interface org.fax4j.spi.http.HTTPClientConfiguration

This function returns the HTTP method based on the provided fax action type.

getName() - Method in class org.fax4j.bridge.FileInfo

This function returns the file name (no path).

getName() - Method in class org.fax4j.common.LogLevel

This function returns the log level name.

getName() - Method in class org.fax4j.common.ProviderImpl

This function returns the provider name, for example mycompany.

getName() - Method in interface org.fax4j.Provider

This function returns the provider name, for example mycompany.

getName() - Method in class org.fax4j.spi.http.HTTPRequest.ContentPart

This function returns the part name/key.

getOutputPart(ProcessExecutorHelper.ProcessOutput, String) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function returns the relevant part from the process output.

getOutputStream() - Method in interface org.fax4j.spi.comm.CommPortAdapter

This function returns the output stream to the COMM port.

getOutputStream() - Method in class org.fax4j.spi.comm.RXTXCommPortAdapter

This function returns the output stream to the COMM port.

getOutputText() - Method in class org.fax4j.util.ProcessExecutorHelper.ProcessOutput

This function returns the process output text.

getParametersText() - Method in class org.fax4j.spi.http.HTTPRequest

This function returns the URL parameters text.

getPasswordAuthentication() - Method in class org.fax4j.spi.email.MailAuthenticator

This funcion returns a password authentication.

getPathToResponseData(FaxActionType) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function returns the path to the relevant response data.

getPort() - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function returns the port.

getPort() - Method in interface org.fax4j.spi.http.HTTPClientConfiguration

This function returns the port.

getPortIdentifier(String) - Method in class org.fax4j.spi.comm.RXTXCommPortConnectionFactory

This function returns the COMM port identifier object.

getPortName() - Method in class org.fax4j.spi.comm.AbstractCommPortConnectionFactory

This function returns the port name.

getPriority() - Method in interface org.fax4j.FaxJob

This function returns the priority.

getPriority() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the priority.

getPriority() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the priority.

getProcessOutputHandler() - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function returns the process output handler.

getProcessOutputValidator() - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function returns the process output validator.

getProductInfoPrintout() - Static method in class org.fax4j.ProductInfo

Returns the product info printout.

getProperty(String, String) - Method in interface org.fax4j.FaxJob

This function returns the fax job property for the given key.

getProperty(String, String) - Method in class org.fax4j.spi.FaxJobImpl

This function returns the fax job property for the given key.

getProperty(String, String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the fax job property for the given key.

getPropertyPart() - Method in class org.fax4j.bridge.AbstractFaxBridge

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.common.AbstractService

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts are the values after the common prefix and before any specific configuration key, or in other words the top context of the configuration.
For example: org.fax4j.[partvalue].some.key
The org.fax4j is the common prefix, the some.key is the suffix and partvalue is the part to be replaced.

getPropertyPart() - Method in interface org.fax4j.common.ConfigurationHolder

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.common.ConfigurationHolderImpl

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts are the values after the common prefix and before any specific configuration key, or in other words the top context of the configuration.
For example: org.fax4j.[partvalue].some.key
The org.fax4j is the common prefix, the some.key is the suffix and partvalue is the part to be replaced.

getPropertyPart() - Method in class org.fax4j.spi.AbstractFaxClientSpi

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.spi.linux.LinuxFaxClientSpi

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getPropertyPart() - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

getProvider() - Method in class org.fax4j.bridge.AbstractFax4JBridge

This function returns the provider.

getProvider() - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function returns the vendor policy provider.

getProvider() - Method in interface org.fax4j.bridge.VendorPolicy

This function returns the vendor policy provider.

getProvider() - Method in class org.fax4j.common.AbstractService

This function returns the provider.

getProvider() - Method in interface org.fax4j.common.ProviderImplementation

This function returns the provider.

getProvider() - Method in class org.fax4j.FaxClient

This function returns the provider.

getProvider() - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function returns the provider.

getProvider() - Method in class org.fax4j.spi.comm.AbstractFax4JFaxModemAdapter

This function returns the provider.

getProvider() - Method in class org.fax4j.spi.http.AbstractHTTPClient

This function returns the provider.

getProvider() - Method in class org.fax4j.util.AbstractFax4JConnectionFactory

This function returns the provider.

getRequestParserConfigurationKey() - Method in class org.fax4j.bridge.AbstractContextFaxBridge

This function returns the key used to fetch the request parser class name from the fax4j.properties.

getRequestParserConfigurationKey() - Method in class org.fax4j.bridge.email.EMail2FaxBridge

This function returns the key used to fetch the request parser class name from the fax4j.properties.

getRequestParserConfigurationKey() - Method in class org.fax4j.bridge.http.HTTP2FaxBridge

This function returns the key used to fetch the request parser class name from the fax4j.properties.

getRequestParserConfigurationKey() - Method in class org.fax4j.bridge.process.Process2FaxBridge

This function returns the key used to fetch the request parser class name from the fax4j.properties.

getResource() - Method in class org.fax4j.spi.http.HTTPRequest

This function returns the requested resource.

getResource() - Method in interface org.fax4j.util.Connection

This function returns the resource held by the connection.

getResource() - Method in class org.fax4j.util.ConnectionImpl

This function returns the resource held by the connection.

getResponseDataEncoding() - Method in class org.fax4j.spi.http.AbstractHTTPResponseHandler

This function returns the response data encoding.

getSenderEmail(Message) - Method in class org.fax4j.bridge.email.DefaultMailMessageParser

Returns the sender email from the provided mail object.

getSenderEmail() - Method in interface org.fax4j.FaxJob

This function returns the fax job sender email address.

getSenderEmail() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the fax job sender email address.

getSenderEmail() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the fax job sender email address.

getSenderFaxNumber() - Method in interface org.fax4j.FaxJob

This function returns the fax job sender fax number.

getSenderFaxNumber() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the fax job sender fax number.

getSenderFaxNumber() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the fax job sender fax number.

getSenderName() - Method in interface org.fax4j.FaxJob

This function returns the fax job sender name.

getSenderName() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the fax job sender name.

getSenderName() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the fax job sender name.

getServerNameFromConfiguration(FaxClientSpi) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function returns the server name from the SPI configuration.

getSession() - Method in class org.fax4j.spi.email.MailResourcesHolder

This function returns the mail session.

getStatusCode() - Method in class org.fax4j.spi.http.HTTPResponse

This function returns the response status.

getStatusFaxJobIDParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The get fax job status fax action, fax job ID parameter name

getSystemConfiguration() - Static method in class org.fax4j.util.LibraryConfigurationLoader

This function returns the system configuration (internal and external fax4j.properties files).

getTargetAddress(Message) - Method in class org.fax4j.bridge.email.DefaultMailMessageParser

Returns the target address from the provided mail object.

getTargetAddress() - Method in interface org.fax4j.FaxJob

This function returns the fax job target address.

getTargetAddress() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the fax job target address.

getTargetAddress() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the fax job target address.

getTargetName() - Method in interface org.fax4j.FaxJob

This function returns the fax job target name.

getTargetName() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the fax job target name.

getTargetName() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the fax job target name.

getTemplate(String) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function returns the template for the given template name.

getText() - Method in class org.fax4j.util.IOHelper.OutputReadThread

The text read from the stream.

getThreadContextClassLoader() - Static method in class org.fax4j.util.ReflectionHelper

This function returns the thread context class loader.

getTimeOut() - Method in class org.fax4j.spi.comm.AbstractCommPortConnectionFactory

This function returns the timeout.

getTransport() - Method in class org.fax4j.spi.email.MailResourcesHolder

This function returns the mail transport.

getType() - Method in class org.fax4j.spi.http.HTTPRequest.ContentPart

This function returns the content type.

getType(String) - Static method in class org.fax4j.util.ReflectionHelper

This function returns the class based on the class name.

getValue() - Method in class org.fax4j.common.LogLevel

This function returns the log level value.

getVBSExePath() - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function return the VBS exe path.

getVBSFailedLineErrorMessage(String) - Method in class org.fax4j.spi.vbs.VBSProcessOutputValidator

This function returns the VBS error line for the exception message.

getVendorPolicy() - Method in class org.fax4j.bridge.AbstractFaxBridge

This function returns the vendor policy.

getVendorPolicy() - Method in interface org.fax4j.bridge.FaxBridge

This function returns the vendor policy.

H

hashCode() - Method in class org.fax4j.common.ProviderImpl

This function returns the hash code value of the object.

HOIIO_PROPERTY_PART - Static variable in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

The Hoiio property part

HoiioFaxClientSpi - Class in org.fax4j.spi.hoiio

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending HTTP requests to a Hoiio service.
This implementation is not meant to promote the Hoiio commercial product but to serve as a service provider interface for those using this product.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.hoiio.client.class.name The HTTP client class name used to submit the HTTP requests org.fax4j.spi.http.ApacheHTTPClient org.fax4j.spi.http.ApacheHTTPClient false org.fax4j.spi.hoiio.app.id The hoiio Application ID none none true org.fax4j.spi.hoiio.access.token The hoiio access token none none true
Dependencies:
HTTP client required jars.

HoiioFaxClientSpi() - Constructor for class org.fax4j.spi.hoiio.HoiioFaxClientSpi

This is the default constructor.

HoiioFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.hoiio

This class holds the SPI configuration constants.

host - Variable in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

The fax server host

HTTP2FaxBridge - Class in org.fax4j.bridge.http

This is the HTTP web2fax based implementation of the fax bridge.

HTTP2FaxBridge() - Constructor for class org.fax4j.bridge.http.HTTP2FaxBridge

This is the class constructor.

HTTP_PROPERTY_PART - Static variable in class org.fax4j.spi.http.HTTPFaxClientSpi

The HTTP property part

HTTP_REQUEST_PARSER_CLASS_NAME_PROPERTY_KEY - Static variable in class org.fax4j.bridge.http.HTTP2FaxBridge

The HTTP request parser class name

HTTPClient - Interface in org.fax4j.spi.http

This interface defines the HTTP client used to submit HTTP requests.

HTTPClient.HTTPMethod - Enum in org.fax4j.spi.http

This enum holds the supported HTTP methods.

HTTPClientConfiguration - Interface in org.fax4j.spi.http

This interface holds the HTTP client configuration.
Each HTTP client will have different configuration requirements and therefore this interface is just a flagging interface.

HTTPFaxClientSpi - Class in org.fax4j.spi.http

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending HTTP requests to a web server that supports sending fax messages.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.http.client.class.name The HTTP client class name used to submit the HTTP requests org.fax4j.spi.http.ApacheHTTPClient org.fax4j.spi.http.ApacheHTTPClient false org.fax4j.spi.http.faxjob2request.converter.class.name The fax job to HTTP request converter class name used to convert the fax job data into the relevant HTTP request. org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter false org.fax4j.spi.http.response.handler.class.name The HTTP response handler class name used to update the fax job data based on the HTTP response. org.fax4j.spi.http.JSONHTTPResponseHandler org.fax4j.spi.http.JSONHTTPResponseHandler false org.fax4j.spi.http.host.name The target (service provider) host name. none none true org.fax4j.spi.http.port The target port number. none none false org.fax4j.spi.http.ssl True to use SSL (HTTPS), false for simple HTTP false false false org.fax4j.spi.http.submit.resource The default HTTP resource of the submit fax job request none none false org.fax4j.spi.http.suspend.resource The default HTTP resource of the suspend fax job request none none false org.fax4j.spi.http.resume.resource The default HTTP resource of the resume fax job request none none false org.fax4j.spi.http.cancel.resource The default HTTP resource of the cancel fax job request none none false org.fax4j.spi.http.get.status.resource The default HTTP resource of the get fax job status request none none false org.fax4j.spi.http.url.parameters The default HTTP URL parameters of the request none none false org.fax4j.spi.http.submit.method The HTTP method for the submit action POST POST false org.fax4j.spi.http.suspend.method The HTTP method for the suspend action POST POST false org.fax4j.spi.http.resume.method The HTTP method for the resume action POST POST false org.fax4j.spi.http.cancel.method The HTTP method for the cancel action POST POST false org.fax4j.spi.http.get.status.method The HTTP method for the get fax job status action POST POST false
Dependencies:
HTTP client required jars.

HTTPFaxClientSpi() - Constructor for class org.fax4j.spi.http.HTTPFaxClientSpi

This is the default constructor.

HTTPFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.http

This class holds the SPI configuration constants.

HTTPRequest - Class in org.fax4j.spi.http

Holds the HTTP request data used to send the fax data to the web server.
This class is not thread safe.

HTTPRequest() - Constructor for class org.fax4j.spi.http.HTTPRequest

This is the default constructor.

HTTPRequest.ContentPart<T> - Class in org.fax4j.spi.http

This class holds the content part data.

HTTPRequest.ContentPartType - Enum in org.fax4j.spi.http

This enum defines the content part types which are supported.

HTTPRequest.ContentType - Enum in org.fax4j.spi.http

This enum defines the content types which are supported.

HTTPRequestParser - Interface in org.fax4j.bridge.http

This interface defines the HTTP parser used to extract the fax job and file info from the HTTP request.

HTTPResponse - Class in org.fax4j.spi.http

Holds the HTTP response data extracted after the fax request was sent to the web server.
This class is not thread safe.

HTTPResponse() - Constructor for class org.fax4j.spi.http.HTTPResponse

This is the default constructor.

HTTPResponseHandler - Interface in org.fax4j.spi.http

This interface defines the HTTP response handler which is used to update the fax job based on the HTTP response data.

HylaFAXClientConnectionFactory - Interface in org.fax4j.spi.hylafax

This interface defines the HaylaFAX connection factory.

HylaFAXClientConnectionFactoryImpl - Class in org.fax4j.spi.hylafax

Provides the default implementation of the HaylaFAX connection factory.

HylaFAXClientConnectionFactoryImpl() - Constructor for class org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl

This is the class constructor.

HylaFaxClientSpi - Class in org.fax4j.spi.hylafax

This class implements the fax client service provider interface.
This implementation is based on the open source hylafax project.
It implements the hylafax protocol used by the open source hylafax fax server.
See http://sourceforge.net/projects/gnu-hylafax/ for more info.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Beta

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.hylafax.connection.factory.class.name The connection factory class name org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl false org.fax4j.spi.hylafax.host See gnu-hylafax project for more info. none none true org.fax4j.spi.hylafax.port See gnu-hylafax project for more info. none gnu.hylafax.HylaFAXClientProtocol.DEFAULT_PORT false org.fax4j.spi.hylafax.user See gnu-hylafax project for more info. none none true org.fax4j.spi.hylafax.password See gnu-hylafax project for more info. none none false org.fax4j.spi.hylafax.admin See gnu-hylafax project for more info. false false false org.fax4j.spi.hylafax.mode See gnu-hylafax project for more info. Z none true org.fax4j.spi.hylafax.type See gnu-hylafax project for more info. A none true
Limitations:
See http://sourceforge.net/projects/gnu-hylafax/ web site.

HylaFaxClientSpi() - Constructor for class org.fax4j.spi.hylafax.HylaFaxClientSpi

This is the default constructor.

HylaFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.hylafax

This class holds the SPI configuration constants.

HylaFaxJob - Class in org.fax4j.spi.hylafax

This class provides the hylafax implementation of the fax job.

HylaFaxJob(Job) - Constructor for class org.fax4j.spi.hylafax.HylaFaxJob

This is the class constructor.

I

INFO - Static variable in class org.fax4j.common.LogLevel

The INFO log level

INFO_LOG_LEVEL_VALUE - Static variable in class org.fax4j.common.LogLevel

The INFO log level

Initializable - Interface in org.fax4j.common

Common interface for initializable components.

initialize(String, Properties, Object) - Method in class org.fax4j.bridge.AbstractFaxBridge

This function initializes the fax bridge.

initialize(Map<String, String>) - Method in class org.fax4j.bridge.AbstractRequestParser

This function initializes the component.

initialize(Object) - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function initializes the vendor policy.

initialize(String, Properties, Object) - Method in interface org.fax4j.bridge.FaxBridge

This function initializes the fax bridge.

initialize(Object) - Method in interface org.fax4j.bridge.VendorPolicy

This function initializes the vendor policy.

initialize(Map<String, String>) - Method in class org.fax4j.common.AbstractService

This function initializes the component.

initialize(Map<String, String>) - Method in interface org.fax4j.common.Initializable

This function initializes the component.

initialize(Map<String, String>, Logger, FaxJobMonitor) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function initializes the fax client SPI.
This method is called by the FaxClientSpiFactory.

initialize(FaxClientSpi) - Method in class org.fax4j.spi.AbstractFaxClientSpiInterceptor

This function initializes the fax client SPI interceptor.
This method is called by the FaxClientSpiFactory.

initialize(FaxClientSpi, FaxClientSpiInterceptor[]) - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

This function initializes the fax client SPI proxy.
This method is called by the FaxClientSpiFactory.

initialize(Map<String, String>, Logger) - Method in class org.fax4j.spi.AbstractFaxJobMonitor

This function initializes the fax job monitor.
This method is called by the FaxClientSpiFactory.

initialize(FaxClientSpi) - Method in class org.fax4j.spi.comm.AbstractFaxModemAdapter

This function initializes the fax modem adapter.

initialize(FaxClientSpi) - Method in interface org.fax4j.spi.comm.FaxModemAdapter

This function initializes the fax modem adapter.

initialize(Map<String, String>, Logger, FaxJobMonitor) - Method in interface org.fax4j.spi.FaxClientSpi

This function initializes the fax client SPI.
This method is called by the FaxClientSpiFactory.

initialize(FaxClientSpi) - Method in interface org.fax4j.spi.FaxClientSpiInterceptor

This function initializes the fax client SPI interceptor.
This method is called by the FaxClientSpiFactory.

initialize(FaxClientSpi, FaxClientSpiInterceptor[]) - Method in interface org.fax4j.spi.FaxClientSpiProxy

This function initializes the fax client SPI proxy.
This method is called by the FaxClientSpiFactory.

initialize(Map<String, String>, Logger) - Method in interface org.fax4j.spi.FaxJobMonitor

This function initializes the fax job monitor.
This method is called by the FaxClientSpiFactory.

initialize(ConfigurationHolder) - Method in class org.fax4j.util.AbstractConnectionFactory

This function initializes the connection factory.

initialize(ConfigurationHolder) - Method in interface org.fax4j.util.ConnectionFactory

This function initializes the connection factory.

initializeAdditionalParameters() - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This function builds and returns the additional parameters map.

initializeChildFaxClientSpi() - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function initializes the child fax client SPI.

initializeChildFaxClientSpi() - Method in class org.fax4j.spi.adapter.AdapterFaxClientSpi

This function initializes the fax client SPI.

initializeChildFaxClientSpi() - Method in class org.fax4j.spi.windows.WindowsFaxClientSpi

This function initializes the fax client SPI.

initializeFaxActionType2ResourceMap() - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

This function initializes the fax action type to resource mappings.

initializeFaxActionType2ResourceMap() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function initializes the fax action type to resource mappings.

initializeFaxActionType2ResourceMap() - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

This function initializes the fax action type to resource mappings.

initializeImpl() - Method in class org.fax4j.bridge.AbstractContextFaxBridge

This function initializes the fax bridge.

initializeImpl() - Method in class org.fax4j.bridge.AbstractFaxBridge

This function initializes the fax bridge.

initializeImpl(Map<String, String>) - Method in class org.fax4j.bridge.AbstractRequestParser

This function initializes the component.

initializeImpl() - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function initializes the vendor policy.

initializeImpl(Map<String, String>) - Method in class org.fax4j.bridge.email.DefaultMailMessageParser

This function initializes the component.

initializeImpl() - Method in class org.fax4j.bridge.EmptyVendorPolicy

This function initializes the vendor policy.

initializeImpl(Map<String, String>) - Method in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

This function initializes the component.

initializeImpl(Map<String, String>) - Method in class org.fax4j.bridge.http.SimpleHTTPRequestParser

This function initializes the component.

initializeImpl(Map<String, String>) - Method in class org.fax4j.bridge.process.DefaultCommandLineArgumentsParser

This function initializes the component.

initializeImpl() - Method in class org.fax4j.common.AbstractService

This function initializes the component.

initializeImpl() - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.AbstractFaxClientSpiInterceptor

This function initializes the fax client SPI interceptor.

initializeImpl() - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

This function initializes the fax client SPI proxy.

initializeImpl() - Method in class org.fax4j.spi.AbstractFaxJobMonitor

This function initializes the fax job monitor.

initializeImpl() - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.comm.AbstractCommPortConnectionFactory

This function initializes the connection factory.

initializeImpl(FaxClientSpi) - Method in class org.fax4j.spi.comm.AbstractFaxModemAdapter

This function initializes the fax modem adapter.

initializeImpl() - Method in class org.fax4j.spi.comm.CommFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.email.AbstractMailConnectionFactory

This function initializes the connection factory.

initializeImpl() - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.FaxClientSpiProxyImpl

This function initializes the fax client SPI proxy.

initializeImpl() - Method in class org.fax4j.spi.FaxJobMonitorImpl

This function initializes the fax job monitor.

initializeImpl() - Method in class org.fax4j.spi.http.AbstractHTTPResponseHandler

This function initializes the component.

initializeImpl() - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function initializes the component.

initializeImpl() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This function initializes the component.

initializeImpl() - Method in class org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter

This function initializes the component.

initializeImpl() - Method in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

This function initializes the connection factory.

initializeImpl() - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.java4less.RFaxFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.linux.LinuxFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.LogFaxClientSpiInterceptor

This function initializes the fax client SPI interceptor.

initializeImpl() - Method in class org.fax4j.spi.mac.MacFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function initializes the fax client SPI.

initializeImpl() - Method in class org.fax4j.util.AbstractConnectionFactory

This function initializes the connection factory.

initializeLogger() - Static method in class org.fax4j.common.ApacheCommonsLogger

This function initializes and returns the logger.

initializeLogger() - Static method in class org.fax4j.common.JDKLogger

This function initializes and returns the logger.

initializeMailTemplates() - Method in class org.fax4j.spi.efax.EFaxMailFaxClientSpi

This function initializes the mail templates.

initializeMailTemplates() - Method in class org.fax4j.spi.email.MailFaxClientSpi

This function initializes the mail templates.

initializeMailTemplates() - Method in class org.fax4j.spi.extremefax.ExtremeFaxMailFaxClientSpi

This function initializes the mail templates.

initializeMailTemplates() - Method in class org.fax4j.spi.faxage.FaxAgeMailFaxClientSpi

This function initializes the mail templates.

initializeMailTemplates() - Method in class org.fax4j.spi.interfax.InterfaxMailFaxClientSpi

This function initializes the mail templates.

initializeMailTemplates() - Method in class org.fax4j.spi.metrofax.MetroFaxMailFaxClientSpi

This function initializes the mail templates.

initializeMailTemplates() - Method in class org.fax4j.spi.nextivafax.NextivafaxMailFaxClientSpi

This function initializes the mail templates.

initializeMailTemplates() - Method in class org.fax4j.spi.send2fax.Send2FaxMailFaxClientSpi

This function initializes the mail templates.

initializeURLParameters() - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

This function returns the HTTP URL parameters from the configuration.

initializeURLParameters() - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function returns the HTTP URL parameters from the configuration.

initializeURLParameters() - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

This function returns the HTTP URL parameters from the configuration.

InterfaxMailFaxClientSpi - Class in org.fax4j.spi.interfax

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The interfax mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
This implementation is not meant to promote the commercial service but to serve as a service provider interface for it.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

InterfaxMailFaxClientSpi() - Constructor for class org.fax4j.spi.interfax.InterfaxMailFaxClientSpi

This is the default constructor.

InterfaxMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.interfax

This class holds the SPI configuration constants.

invoke(Object, Method, Object[]) - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

This function is invoked for each fax client SPI method invocation.
This method invokes the fax client SPI interceptors.

invokeExistingFaxJobAction(String, FaxJob, FaxActionType) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

Invokes a basic fax action

invokeFaxJobIDValidation(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function invokes the fax job null validation.

invokeFaxJobNullValidation(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function invokes the fax job null validation.

invokeInterceptors(FaxClientSpiProxy.FaxClientSpiProxyEventType, Method, Object[], Object, Throwable) - Method in class org.fax4j.spi.AbstractFaxClientSpiProxy

This function invokes the interceptor for the given event.

invokeInterceptors(FaxClientSpiProxy.FaxClientSpiProxyEventType, Method, Object[], Object, Throwable) - Method in class org.fax4j.spi.FaxClientSpiProxyImpl

This function invokes the interceptor for the given event.

invokeInterceptorsImpl(FaxClientSpiProxy.FaxClientSpiProxyEventType, Method, Object[], Object, Throwable) - Method in class org.fax4j.spi.FaxClientSpiProxyImpl

This function invokes the interceptor for the given event.

invokeMethod(Class<?>, Object, String, Class<?>[], Object[]) - Static method in class org.fax4j.util.ReflectionHelper

This function invokes the requested method.

invokePolicyForRequest(Object) - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokePolicyForRequest(Object) - Method in interface org.fax4j.bridge.VendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokePolicyForRequestImpl(Object) - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokePolicyForRequestImpl(Object) - Method in class org.fax4j.bridge.EmptyVendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokePolicyForResponse(Object, FaxJob) - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokePolicyForResponse(Object, FaxJob) - Method in interface org.fax4j.bridge.VendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokePolicyForResponseImpl(Object, FaxJob) - Method in class org.fax4j.bridge.AbstractVendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokePolicyForResponseImpl(Object, FaxJob) - Method in class org.fax4j.bridge.EmptyVendorPolicy

This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on.
In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false.

invokeScript(FaxJob, String, Object[], FaxActionType) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

Invokes the VB script and returns its output.

invokeScript(String) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

Invokes the VB script and returns the output.

IOHelper - Class in org.fax4j.util

This is an internal IO utility class.

IOHelper.OutputReadThread - Class in org.fax4j.util

This class reads the output of the process.

isContinueFlow() - Method in class org.fax4j.bridge.FaxBridgeFlowHelper.FlowResponse

This function returns the continue flow flag.

isFaxMonitorEventsSupported() - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function returns true if the fax monitor events are supported by this SPI.

isFaxMonitorEventsSupported() - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function returns true if the fax monitor events are supported by this SPI.

isFaxMonitorEventsSupported() - Method in interface org.fax4j.spi.FaxClientSpi

This function returns true if the fax monitor events are supported by this SPI.

isFaxMonitorEventsSupported() - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function returns true if the fax monitor events are supported by this SPI.

isFaxMonitorEventsSupported() - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function returns true if the fax monitor events are supported by this SPI.

isFaxMonitorEventsSupported() - Method in class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This function returns true if the fax monitor events are supported by this SPI.

isNativeLibraryLoaded() - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function returns true if the native library was loaded.

isOpen() - Method in interface org.fax4j.spi.comm.CommPortAdapter

Returns true if the adapter is valid and open.

isOpen() - Method in class org.fax4j.spi.comm.RXTXCommPortAdapter

Returns true if the adapter is valid and open.

isRunning() - Method in class org.fax4j.spi.FaxJobMonitorImpl.PollerTask

This function returns the running flag.

isSSL() - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function returns the SSL flag value.

isSSL() - Method in interface org.fax4j.spi.http.HTTPClientConfiguration

This function returns the SSL flag value.

J

JDK_LOGGER - Variable in class org.fax4j.common.JDKLogger

The JDK logger

JDKLogger - Class in org.fax4j.common

This is a simple proxy implementation of the logger that transfers all log events to the JDK logger.

JDKLogger() - Constructor for class org.fax4j.common.JDKLogger

This is the default constructor.

JSONHTTPResponseHandler - Class in org.fax4j.spi.http

This class provides a JSON based implementation of the HTTP response handler interface.
This class expects to get JSON response data and will update the fax job as needed.
This class only supports extracting the fax job ID and fax job status from the JSON response object, or in case of errors, extract the error message.

JSONHTTPResponseHandler() - Constructor for class org.fax4j.spi.http.JSONHTTPResponseHandler

This is the default constructor.

JSONHTTPResponseHandler.JSONHTTPResponseHandlerConfigurationConstants - Enum in org.fax4j.spi.http

This class holds the configuration constants.

L

LibraryConfigurationLoader - Class in org.fax4j.util

This is an internal utility used to load the library configuration.

LinuxFaxClientSpi - Class in org.fax4j.spi.linux

This class implements the fax client service provider interface.
This implementation will proxy the requests to linux native fax commands.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.linux.submit.template.command The linux submit fax job template command. efax -d /dev/modem -t ${target.address} ${file} none true org.fax4j.spi.linux.suspend.template.command The suspend fax job template command. none none false org.fax4j.spi.linux.resume.template.command The resume fax job template command. none none false org.fax4j.spi.linux.cancel.template.command The cancel fax job template command. none none false org.fax4j.spi.linux.get.status.template.command The get status fax job template command. none none false org.fax4j.spi.linux.output.validator The process output validator class name. org.fax4j.spi.process.ExitCodeProcessOutputValidator org.fax4j.spi.process.ExitCodeProcessOutputValidator false org.fax4j.spi.linux.output.handler The process output handler class name. none none false
Limitations:
This SPI will only work on linux OS.

LinuxFaxClientSpi() - Constructor for class org.fax4j.spi.linux.LinuxFaxClientSpi

This is the default constructor.

LinuxFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.linux

This class holds the SPI configuration constants.

loadNativeLibrary(Logger) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

Loads the native library if not loaded before.

LOCK - Variable in class org.fax4j.spi.FaxJobMonitorImpl

The lock object

log(LogLevel, Object[], Throwable) - Method in class org.fax4j.common.AbstractLogger

Logs the provided data.

logDebug(Object[], Throwable) - Method in class org.fax4j.common.AbstractLogger

Logs the provided data at the debug level.

logDebug(Object[], Throwable) - Method in interface org.fax4j.common.Logger

Logs the provided data at the debug level.

logError(Object[], Throwable) - Method in class org.fax4j.common.AbstractLogger

Logs the provided data at the error level.

logError(Object[], Throwable) - Method in interface org.fax4j.common.Logger

Logs the provided data at the error level.

logEvent(FaxClientSpiProxy.FaxClientSpiProxyEventType, Method, Object[], Object, Throwable) - Method in class org.fax4j.spi.LogFaxClientSpiInterceptor

This function logs the event.

LogFaxClientSpiInterceptor - Class in org.fax4j.spi

This class provides the logging implementation of the fax client SPI interceptor which enables to log all fax client SPI method invocations.

LogFaxClientSpiInterceptor() - Constructor for class org.fax4j.spi.LogFaxClientSpiInterceptor

This is the default constructor.

Logger - Interface in org.fax4j.common

This interface defines a simple logger used by the fax4j.
This interface can be implemented to proxy the log requests to another logger framework.

LOGGER - Variable in class org.fax4j.util.AbstractConnectionFactory

The logger

LOGGER - Variable in class org.fax4j.util.AbstractProcessExecutor

The logger

LOGGER_CLASS_NAME_PROPERTY_KEY - Static variable in class org.fax4j.common.LoggerManager

The logger class name property key

LOGGER_LOG_LEVEL_PROPERTY_KEY - Static variable in class org.fax4j.common.LoggerManager

The logger log level property key

LoggerManager - Class in org.fax4j.common

Manages the internal fax4j logger.

logImpl(LogLevel, Object[], Throwable) - Method in class org.fax4j.common.AbstractLogger

Logs the provided data.

logImpl(LogLevel, Object[], Throwable) - Method in class org.fax4j.common.ApacheCommonsLogger

Logs the provided data.

logImpl(LogLevel, Object[], Throwable) - Method in class org.fax4j.common.JDKLogger

Logs the provided data.

logImpl(LogLevel, Object[], Throwable) - Method in class org.fax4j.common.SimpleLogger

Logs the provided data.

logInfo(Object[], Throwable) - Method in class org.fax4j.common.AbstractLogger

Logs the provided data at the info level.

logInfo(Object[], Throwable) - Method in interface org.fax4j.common.Logger

Logs the provided data at the info level.

LogLevel - Class in org.fax4j.common

This is the logger log levels.

M

MacFaxClientSpi - Class in org.fax4j.spi.mac

This class implements the fax client service provider interface.
This implementation will proxy the requests to mac native fax commands.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Beta

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mac.submit.command The submit fax job command lp lp false org.fax4j.spi.mac.print.queue.parameter The print queue parameter -d -d false org.fax4j.spi.mac.print.queue.name The print queue name none none true org.fax4j.spi.mac.general.parameters The general parameters -o -o false org.fax4j.spi.mac.phone.parameter The phone parameter phone phone false org.fax4j.spi.mac.fax.to.parameter The fax to parameter faxTo faxTo false
Limitations:
This SPI will only work on Mac OS.

MacFaxClientSpi() - Constructor for class org.fax4j.spi.mac.MacFaxClientSpi

This is the default constructor.

MacFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.mac

This class holds the SPI configuration constants.

MAIL_MESSAGE_PARSER_CLASS_NAME_PROPERTY_KEY - Static variable in class org.fax4j.bridge.email.EMail2FaxBridge

The mail message request parser class name

mailAddressTemplate - Variable in class org.fax4j.spi.email.MailFaxClientSpi

The mail address template

MailAuthenticator - Class in org.fax4j.spi.email

This class implements the javax.mail.Authenticator

MailAuthenticator(String, String) - Constructor for class org.fax4j.spi.email.MailAuthenticator

This is the class constructor.

MailConnectionFactory - Interface in org.fax4j.spi.email

This class defines the mail connection factory.

MailConnectionFactoryImpl - Class in org.fax4j.spi.email

This class provides basic implementation of the mail connection factory.

MailConnectionFactoryImpl() - Constructor for class org.fax4j.spi.email.MailConnectionFactoryImpl

This is the class constructor.

mailConnectionProperties - Variable in class org.fax4j.spi.email.AbstractMailConnectionFactory

The mail connection properties

MailFaxClientSpi - Class in org.fax4j.spi.email

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
The SPI supports embedding the target destination number into the TO address field and subject field by setting the org.fax4j.spi.mail.address.template and org.fax4j.spi.mail.subject.template properties.
For example: org.fax4j.spi.mail.address.template={0}@myprovider.com
For example: org.fax4j.spi.mail.subject.template=fax:{0}
The {0} will be replaced with the destination number.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.address.template The address template used when sending the mail message.
In order to provide the target fax number as part of the email address you must specify {0} in the template.
For example: org.fax4j.spi.mail.address.template={0}@myprovider.com none none true org.fax4j.spi.mail.subject.template The subject template used when sending the mail message.
In order to provide the target fax number as part of the email subject line you must specify {0} in the template.
For example: org.fax4j.spi.mail.subject.template=fax:{0} none none true org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.connection.factory.class.name The connection factory class name org.fax4j.spi.email.MailConnectionFactoryImpl org.fax4j.spi.email.MailConnectionFactoryImpl false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

MailFaxClientSpi() - Constructor for class org.fax4j.spi.email.MailFaxClientSpi

This is the default constructor.

MailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.email

This class holds the SPI configuration constants.

MailMessageParser - Interface in org.fax4j.bridge.email

This interface defines the mail message parser used to extract the fax job and file info from the email data.

MailResourcesHolder - Class in org.fax4j.spi.email

This class holds the java mail objects.

MailResourcesHolder(Session, Transport) - Constructor for class org.fax4j.spi.email.MailResourcesHolder

This is the default constructor.

mailSubjectTemplate - Variable in class org.fax4j.spi.email.MailFaxClientSpi

The mail subject template

main(String[]) - Static method in class org.fax4j.ProductInfo

Prints the product info to the system out and exists the process.

MetroFaxMailFaxClientSpi - Class in org.fax4j.spi.metrofax

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The MetroFax mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
This implementation is not meant to promote the commercial service but to serve as a service provider interface for it.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

MetroFaxMailFaxClientSpi() - Constructor for class org.fax4j.spi.metrofax.MetroFaxMailFaxClientSpi

This is the default constructor.

MetroFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.metrofax

This class holds the SPI configuration constants.

mode - Variable in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

The mode

monitorFaxJob(FaxClientSpi, FaxJob) - Method in class org.fax4j.spi.AbstractFaxJobMonitor

This function starts monitoring the requested fax job.

monitorFaxJob(FaxClientSpi, FaxJob) - Method in interface org.fax4j.spi.FaxJobMonitor

This function starts monitoring the requested fax job.

monitorFaxJobImpl(FaxClientSpi, FaxJob) - Method in class org.fax4j.spi.AbstractFaxJobMonitor

This function starts monitoring the requested fax job.

monitorFaxJobImpl(FaxClientSpi, FaxJob) - Method in class org.fax4j.spi.FaxJobMonitorImpl

This function starts monitoring the requested fax job.

MultiPartFaxJob2HTTPRequestConverter - Class in org.fax4j.spi.http

This class implements the fax job to HTTP request converter interface.
This class will construct a multi part HTTP requests.
The parameter names are set in the fax4j configuration and their values are extracted from the fax job.

MultiPartFaxJob2HTTPRequestConverter() - Constructor for class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This is the default constructor.

MultiPartFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants - Enum in org.fax4j.spi.http

This class holds the configuration constants.

MultiPartHTTPRequestParser - Class in org.fax4j.bridge.http

This class provides a multi part implementation of the HTTP request parser used to extract the fax job and file info from the HTTP request.

MultiPartHTTPRequestParser() - Constructor for class org.fax4j.bridge.http.MultiPartHTTPRequestParser

This is the class constructor.

MultiPartHTTPRequestParser.HTTPRequestParserConfigurationConstants - Enum in org.fax4j.bridge.http

This class holds the configuration constants.

N

NATIVE_LOCK - Static variable in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

The lock used to synchronize native calls

NextivafaxMailFaxClientSpi - Class in org.fax4j.spi.nextivafax

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The nextivafax mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
This implementation is not meant to promote the commercial service but to serve as a service provider interface for it.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

NextivafaxMailFaxClientSpi() - Constructor for class org.fax4j.spi.nextivafax.NextivafaxMailFaxClientSpi

This is the default constructor.

NextivafaxMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.nextivafax

This class holds the SPI configuration constants.

NONE - Static variable in class org.fax4j.common.LogLevel

The NONE log level

NONE_LOG_LEVEL_VALUE - Static variable in class org.fax4j.common.LogLevel

The NONE log level

O

onMethodInvocationError(Method, Object[], Throwable) - Method in interface org.fax4j.spi.FaxClientSpiInterceptor

This function is invoked by the fax client SPI proxy in of an error while invoking the method in the fax client SPI itself.

onMethodInvocationError(Method, Object[], Throwable) - Method in class org.fax4j.spi.LogFaxClientSpiInterceptor

This function is invoked by the fax client SPI proxy in of an error while invoking the method in the fax client SPI itself.

org.fax4j - package org.fax4j

The fax4j library, is a standard on which java based applications can communicate with fax devices in order to submit new faxes or perform other related actions.

org.fax4j.bridge - package org.fax4j.bridge

Provides the API classes for the fax client bridge.
The fax4j bridge is used to transform applications to fax bridges for example an email server to provide email2fax functionality.

org.fax4j.bridge.email - package org.fax4j.bridge.email

Provides the API classes for the email2fax bridge.

org.fax4j.bridge.http - package org.fax4j.bridge.http

Provides the API classes for a HTTP based web2fax bridge.

org.fax4j.bridge.process - package org.fax4j.bridge.process

Provides the API classes for a standalone process based cli2fax bridge.

org.fax4j.common - package org.fax4j.common

Contains common internal classes used by the fax4j library.

org.fax4j.spi - package org.fax4j.spi

Provides the API classes for the fax client SPI.
The class/interfaces defined in this package should only be used internally by the fax4j library or by classes implemeting a new fax client SPI.

org.fax4j.spi.adapter - package org.fax4j.spi.adapter

Provides the adapter fax client SPI implementation.

org.fax4j.spi.comm - package org.fax4j.spi.comm

Provides the COMM port communication based fax client SPI implementation.

org.fax4j.spi.efax - package org.fax4j.spi.efax

Provides the efax based fax client SPI implementation.

org.fax4j.spi.email - package org.fax4j.spi.email

Provides the email based fax client SPI implementation.

org.fax4j.spi.extremefax - package org.fax4j.spi.extremefax

Provides the extreme fax based fax client SPI implementation.

org.fax4j.spi.faxage - package org.fax4j.spi.faxage

Provides the faxage based fax client SPI implementation.

org.fax4j.spi.hoiio - package org.fax4j.spi.hoiio

Provides the hoiio based fax client SPI implementation.

org.fax4j.spi.http - package org.fax4j.spi.http

Provides the HTTP based fax client SPI implementation.

org.fax4j.spi.hylafax - package org.fax4j.spi.hylafax

Provides the HylaFAX fax client SPI implementation.

org.fax4j.spi.interfax - package org.fax4j.spi.interfax

Provides the interfax based fax client SPI implementation.

org.fax4j.spi.java4less - package org.fax4j.spi.java4less

Provides the java4less RFax fax client SPI implementation.

org.fax4j.spi.linux - package org.fax4j.spi.linux

Provides the native linux fax client SPI implementation.

org.fax4j.spi.mac - package org.fax4j.spi.mac

Provides the native Mac fax client SPI implementation.

org.fax4j.spi.metrofax - package org.fax4j.spi.metrofax

Provides the metrofax based fax client SPI implementation.

org.fax4j.spi.nextivafax - package org.fax4j.spi.nextivafax

Provides the nextivafax based fax client SPI implementation.

org.fax4j.spi.phaxio - package org.fax4j.spi.phaxio

Provides the phaxio based fax client SPI implementation.

org.fax4j.spi.process - package org.fax4j.spi.process

Provides the process based fax client SPI implementation.
These implementations use external executables/scripts to invoke fax actions.

org.fax4j.spi.send2fax - package org.fax4j.spi.send2fax

Provides the send2fax based fax client SPI implementation.

org.fax4j.spi.vbs - package org.fax4j.spi.vbs

Provides the VB script based fax client SPI implementation.

org.fax4j.spi.windows - package org.fax4j.spi.windows

Provides the native windows fax client SPI implementation.

org.fax4j.util - package org.fax4j.util

Provides general utilities used internally by the fax4j library.

OutputReadThread(InputStream) - Constructor for class org.fax4j.util.IOHelper.OutputReadThread

This is the default constructor.

P

parseCommand(ConfigurationHolder, String) - Method in class org.fax4j.util.DefaultProcessExecutor

This function parsers the command and converts to a command array.

password - Variable in class org.fax4j.spi.email.AbstractMailConnectionFactory

The mail connection password

password - Variable in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

The fax server password

PHAXIO_PROPERTY_PART - Static variable in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

The Phaxio property part

PhaxioFaxClientSpi - Class in org.fax4j.spi.phaxio

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending HTTP requests to a Phaxio service.
This implementation is not meant to promote the Phaxio commercial product but to serve as a service provider interface for those using this product.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.phaxio.client.class.name The HTTP client class name used to submit the HTTP requests org.fax4j.spi.http.ApacheHTTPClient org.fax4j.spi.http.ApacheHTTPClient false org.fax4j.spi.phaxio.api.key The phaxio API key none none true org.fax4j.spi.phaxio.api.secret The phaxio API secret none none true
Dependencies:
HTTP client required jars.

PhaxioFaxClientSpi() - Constructor for class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

This is the default constructor.

PhaxioFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.phaxio

This class holds the SPI configuration constants.

pollerTask - Variable in class org.fax4j.spi.FaxJobMonitorImpl

The poller task

PollerTask(FaxJobMonitorImpl) - Constructor for class org.fax4j.spi.FaxJobMonitorImpl.PollerTask

This is the class constructor.

pollForFaxJobStatues(FaxJob[]) - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function polls the new statues for the provided fax jobs.

pollForFaxJobStatues(FaxJob[]) - Method in interface org.fax4j.spi.FaxClientSpi

This function polls the new statues for the provided fax jobs.

pollForFaxJobStatuesImpl(FaxJob[]) - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function polls the new statues for the provided fax jobs.

pollForFaxJobStatuesImpl(FaxJob[]) - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function polls the new statues for the provided fax jobs.

POLLING_INTERVAL_IN_MILLIES_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxJobMonitorImpl

The fax job polling interval in millies property key

POLLING_THREAD_PRIORITY_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxJobMonitorImpl

The fax job polling thread priority property key

pollingInterval - Variable in class org.fax4j.spi.FaxJobMonitorImpl

The poller task interval between invocations

pollingThreadPriority - Variable in class org.fax4j.spi.FaxJobMonitorImpl

The poller thread priority

populateFaxActionType2ReponseDataPathMappings(FaxActionType[], Enum<?>[]) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function populates the fax action type to response data path mappings based on the configuration of the handler.

populateFaxActionType2ReponseDataPathMappings() - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function populates the fax action type to response data path mappings based on the configuration of the handler.

populateFaxActionType2ReponseDataPathMappings() - Method in class org.fax4j.spi.http.JSONHTTPResponseHandler

This function populates the fax action type to response data path mappings based on the configuration of the handler.

populateFaxActionType2ReponseDataPathMappings() - Method in class org.fax4j.spi.http.XMLHTTPResponseHandler

This function populates the fax action type to response data path mappings based on the configuration of the handler.

populateStatusString2FaxStatusMappings(FaxJobStatus[], Enum<?>[]) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function populates the status strings to fax status enum values based on the configuration of the handler.

populateStatusString2FaxStatusMappings() - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

This function populates the status strings to fax status enum values based on the configuration of the handler.

populateStatusString2FaxStatusMappings() - Method in class org.fax4j.spi.http.JSONHTTPResponseHandler

This function populates the status strings to fax status enum values based on the configuration of the handler.

populateStatusString2FaxStatusMappings() - Method in class org.fax4j.spi.http.XMLHTTPResponseHandler

This function populates the status strings to fax status enum values based on the configuration of the handler.

port - Variable in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

The fax server port

postMethodInvocation(Method, Object[], Object) - Method in interface org.fax4j.spi.FaxClientSpiInterceptor

This function is invoked by the fax client SPI proxy after invoking the method in the fax client SPI itself.

postMethodInvocation(Method, Object[], Object) - Method in class org.fax4j.spi.LogFaxClientSpiInterceptor

This function is invoked by the fax client SPI proxy after invoking the method in the fax client SPI itself.

preMethodInvocation(Method, Object[]) - Method in interface org.fax4j.spi.FaxClientSpiInterceptor

This function is invoked by the fax client SPI proxy before invoking the method in the fax client SPI itself.

preMethodInvocation(Method, Object[]) - Method in class org.fax4j.spi.LogFaxClientSpiInterceptor

This function is invoked by the fax client SPI proxy before invoking the method in the fax client SPI itself.

preNativeCall() - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function is invoked before any native call to set the native layer debug mode.

printProductInfo() - Static method in class org.fax4j.ProductInfo

Prints the product info to the system out.

priorityParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The priority parameter name

Process2FaxBridge - Class in org.fax4j.bridge.process

This is the process cli2fax based implementation of the fax bridge.

Process2FaxBridge() - Constructor for class org.fax4j.bridge.process.Process2FaxBridge

This is the class constructor.

PROCESS_EXECUTER_CLASS_NAME_PROPERTY_KEY - Static variable in interface org.fax4j.util.ProcessExecutor

The process executer class name property key

ProcessExecutor - Interface in org.fax4j.util

The process executer enables to execute native processes.
Implementing classes must be statless and thread safe.

ProcessExecutorHelper - Class in org.fax4j.util

This is an internal process execution utility class.

ProcessExecutorHelper.ProcessOutput - Class in org.fax4j.util

This holds the process output.

ProcessFaxClientSpi - Class in org.fax4j.spi.process

This class implements the fax client service provider interface.
This implementation will invoke the requests by executing an external process (executable/script) that enables to invoke the fax action.
This class will use request templates to construct the process command.
The template parameters are updated with the values from the fax4j configuration or FaxJob data.
All template parameters are defined as ${templatename} variables, for example: myexe.exe -target ${target.address} -file ${file}

Below table describes the template parameters.
Template Parameters:

Template Parameter Description file The fax job file path target.address The fax job target address target.name The fax job target name sender.name The fax job sender name sender.fax.number The fax job sender fax number sender.email The fax job sender email
In case there is no template defined for a certain fax action, this class will throw an UnsupportedOperationException exception.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.process.submit.template.command The submit fax job template command. none none false org.fax4j.spi.process.suspend.template.command The suspend fax job template command. none none false org.fax4j.spi.process.resume.template.command The resume fax job template command. none none false org.fax4j.spi.process.cancel.template.command The cancel fax job template command. none none false org.fax4j.spi.process.get.status.template.command The get status fax job template command. none none false org.fax4j.spi.process.output.validator The process output validator class name. org.fax4j.spi.process.ExitCodeProcessOutputValidator org.fax4j.spi.process.ExitCodeProcessOutputValidator false org.fax4j.spi.process.output.handler The process output handler class name. none none false org.fax4j.spi.process.use.windows.command.prefix True to add a windows command prefix to the command template. false false false org.fax4j.spi.process.windows.command.prefix True to add a windows command prefix to the command template. rundll32 SHELL32.DLL,ShellExec_RunDLL rundll32 SHELL32.DLL,ShellExec_RunDLL false
Dependencies:
External executable/script must be available

ProcessFaxClientSpi() - Constructor for class org.fax4j.spi.process.ProcessFaxClientSpi

This is the default constructor.

ProcessFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.process

This class holds the SPI configuration constants.

ProcessOutput(String, String, int) - Constructor for class org.fax4j.util.ProcessExecutorHelper.ProcessOutput

This is the class constructor.

ProcessOutputHandler - Interface in org.fax4j.spi.process

This interface defines the process output handler which is used to update the fax job based on the process output information.

ProcessOutputValidator - Interface in org.fax4j.spi.process

This interface defines the process output validator which is used to validate if the process ended correctly.

ProductInfo - Class in org.fax4j

This class is used to print the product info of the fax4j library.

Provider - Interface in org.fax4j

This is the provider interface.
Each SPI enables access to the SPI provider by returning an instance of this interface.

ProviderImpl - Class in org.fax4j.common

This class implements the provider interface.

ProviderImpl(String, String) - Constructor for class org.fax4j.common.ProviderImpl

This is the class constructor.

ProviderImplementation - Interface in org.fax4j.common

Defines the methods for classes that have a provider.

R

readAndWriteStreams(InputStream, OutputStream) - Static method in class org.fax4j.util.IOHelper

Reads the data from the input stream and writes to the output stream.

readFile(File) - Static method in class org.fax4j.util.IOHelper

Reads the data from the file.

readInternalAndExternalConfiguration() - Static method in class org.fax4j.util.LibraryConfigurationLoader

This function reads and returns the internal and external fax4j properties.

readInternalConfiguration() - Static method in class org.fax4j.util.LibraryConfigurationLoader

This function reads and returns the internal fax4j properties.

readStream(InputStream) - Static method in class org.fax4j.util.IOHelper

Reads the data from the stream.

readTextFile(File) - Static method in class org.fax4j.util.IOHelper

Reads the text from the file.

readTextStream(Reader) - Static method in class org.fax4j.util.IOHelper

Reads the text from the stream.

ReflectionHelper - Class in org.fax4j.util

Holds general functions for working with reflection and dynamic invocation of code/classes.

registerCloseable(Closeable) - Static method in class org.fax4j.util.CloseableResourceManager

Registers the provided closeable.
Will throw an error in case the manager is no longer active (due to JVM shutdown).

releaseCommPortConnection() - Method in class org.fax4j.spi.comm.CommFaxClientSpi

Releases the COMM port connection if open.

releaseConnection(Connection<T>) - Method in class org.fax4j.util.AbstractConnectionFactory

Releases the connection.

releaseConnection(Connection<T>) - Method in interface org.fax4j.util.ConnectionFactory

Releases the connection.

releaseResource(T) - Method in class org.fax4j.util.AbstractConnectionFactory

Releases the resource from the connection.

releaseResourceImpl(CommPortAdapter) - Method in class org.fax4j.spi.comm.AbstractCommPortConnectionFactory

Releases the resource from the connection.

releaseResourceImpl(MailResourcesHolder) - Method in class org.fax4j.spi.email.MailConnectionFactoryImpl

Releases the resource from the connection.

releaseResourceImpl(HylaFAXClient) - Method in class org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl

Releases the resource from the connection.

releaseResourceImpl(T) - Method in class org.fax4j.util.AbstractConnectionFactory

Releases the resource from the connection.

removeAllFaxClientActionEventListeners() - Method in interface org.fax4j.common.FaxClientActions

This function removes all fax client action event listeners from the internal fax event listeners data structure.

removeAllFaxClientActionEventListeners() - Method in class org.fax4j.FaxClient

This function removes all fax client action event listeners from the internal fax event listeners data structure.

removeAllFaxClientActionEventListeners() - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function removes all fax client action event listeners from the internal fax event listeners data structure.

removeAllFaxMonitorEventListeners() - Method in interface org.fax4j.common.FaxClientActions

This function removes all fax monitor event listeners from the internal fax event listeners data structure.
Not all SPIs support monitoring events.

removeAllFaxMonitorEventListeners() - Method in class org.fax4j.FaxClient

This function removes all fax monitor event listeners from the internal fax event listeners data structure.
Not all SPIs support monitoring events.

removeAllFaxMonitorEventListeners() - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function removes all fax monitor event listeners from the internal fax event listeners data structure.
Not all SPIs support monitoring events.

removeFaxClientActionEventListener(FaxClientActionEventListener) - Method in interface org.fax4j.common.FaxClientActions

This function removes the fax client action event listener from the internal fax event listeners data structure.

removeFaxClientActionEventListener(FaxClientActionEventListener) - Method in class org.fax4j.FaxClient

This function removes the fax client action event listener from the internal fax event listeners data structure.

removeFaxClientActionEventListener(FaxClientActionEventListener) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function removes the fax client action event listener from the internal fax event listeners data structure.

removeFaxMonitorEventListener(FaxMonitorEventListener) - Method in interface org.fax4j.common.FaxClientActions

This function removes the fax monitor event listener from the internal fax event listeners data structure.
Not all SPIs support monitoring events.

removeFaxMonitorEventListener(FaxMonitorEventListener) - Method in class org.fax4j.FaxClient

This function removes the fax monitor event listener from the internal fax event listeners data structure.
Not all SPIs support monitoring events.

removeFaxMonitorEventListener(FaxMonitorEventListener) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function removes the fax monitor event listener from the internal fax event listeners data structure.
Not all SPIs support monitoring events.

replaceTemplateParameter(String, String, String, SpiUtil.TemplateParameterEncoder) - Static method in class org.fax4j.util.SpiUtil

This function replaces the parameter with the provided value.

RequestParser<T> - Interface in org.fax4j.bridge

This interface defines the fax bridge request parser used to extract the fax job and file info from the input data.

RESPONSE_DATA_ENCODING_PROPERTY_KEY - Static variable in class org.fax4j.spi.http.AbstractHTTPResponseHandler

The response data encoding property key

resumeFaxJob(FaxJob) - Method in interface org.fax4j.common.FaxClientActions

This function will resume an existing fax job.

resumeFaxJob(FaxJob) - Method in class org.fax4j.FaxClient

This function will resume an existing fax job.

resumeFaxJob(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will resume an existing fax job.

resumeFaxJob(HylaFaxJob, HylaFAXClient) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobIDParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The resume fax action, fax job ID parameter name

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsFaxClientSpi

This function will resume an existing fax job.

resumeFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function will resume an existing fax job.

RFaxFaxClientSpi - Class in org.fax4j.spi.java4less

This class implements the fax client service provider interface.
This implementation is based on the java4less commercial product.
This implementation is not meant to promote the java4less commercial product but to serve as a service provider interface for those using this product.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Draft

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.rfax.port.name See java4less website for more info. none none true org.fax4j.spi.rfax.fax.class See java4less website for more info. none none true
Limitations:
See java4less web site.

RFaxFaxClientSpi() - Constructor for class org.fax4j.spi.java4less.RFaxFaxClientSpi

This is the default constructor.

RFaxFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.java4less

This class holds the SPI configuration constants.

RFaxFaxClientSpi.FaxJobExtendedPropertyConstants - Enum in org.fax4j.spi.java4less

This class holds the fax job extended properties.

run() - Method in class org.fax4j.spi.FaxJobMonitorImpl.PollerTask

Invoked by the timer to start the polling cycle.

run() - Method in class org.fax4j.util.IOHelper.OutputReadThread

Reads the data from the stream.

runPollingCycle() - Method in class org.fax4j.spi.FaxJobMonitorImpl

Runs the polling cycle to fetch and create monitor events.

RXTXCommPortAdapter - Class in org.fax4j.spi.comm

This class holds the COMM port objects.

RXTXCommPortAdapter(CommPort) - Constructor for class org.fax4j.spi.comm.RXTXCommPortAdapter

This is the class constructor.

RXTXCommPortConnectionFactory - Class in org.fax4j.spi.comm

This class implements the COMM port connection factory using the RXTX COMM API.

RXTXCommPortConnectionFactory() - Constructor for class org.fax4j.spi.comm.RXTXCommPortConnectionFactory

This is the class constructor.

S

Send2FaxMailFaxClientSpi - Class in org.fax4j.spi.send2fax

This class implements the fax client service provider interface.
This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages.
The send2fax mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation.
By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection.
To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password
All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties.
This SPI only supports to submit new fax jobs.
This implementation is not meant to promote the commercial service but to serve as a service provider interface for it.

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties.
These properties will be passed to the java mail framework. mail.transport.protocol=smtp
mail.smtp.port=25 none false
Limitations:
This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server.

Send2FaxMailFaxClientSpi() - Constructor for class org.fax4j.spi.send2fax.Send2FaxMailFaxClientSpi

This is the default constructor.

Send2FaxMailFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.send2fax

This class holds the SPI configuration constants.

SENDER_EMAIL_TEMPLATE_PARAMETER - Static variable in class org.fax4j.util.SpiUtil

The sender email template parameter

SENDER_EMAIL_TEMPLATE_PARAMETER_STRING - Static variable in class org.fax4j.util.SpiUtil

The sender email template parameter

SENDER_FAX_NUMBER_TEMPLATE_PARAMETER - Static variable in class org.fax4j.util.SpiUtil

The sender fax number template parameter

SENDER_FAX_NUMBER_TEMPLATE_PARAMETER_STRING - Static variable in class org.fax4j.util.SpiUtil

The sender fax number template parameter

SENDER_NAME_TEMPLATE_PARAMETER - Static variable in class org.fax4j.util.SpiUtil

The sender name template parameter

SENDER_NAME_TEMPLATE_PARAMETER_STRING - Static variable in class org.fax4j.util.SpiUtil

The sender name template parameter

senderEMailParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The sender email parameter name

senderFaxNumberParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The sender fax number parameter name

senderNameParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The sender name parameter name

sendMail(FaxJob, Connection<MailResourcesHolder>, Message) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will send the mail message.

Service - Interface in org.fax4j.common

Common interface for services.
Services have common initialization and setup process.

ServiceFactory - Class in org.fax4j.common

The factory that creates, initializes and returns new service objects.

setContent(byte[]) - Method in class org.fax4j.spi.http.HTTPRequest

This function sets the content.

setContent(String) - Method in class org.fax4j.spi.http.HTTPRequest

This function sets the content.

setContent(HTTPRequest.ContentPart<?>[]) - Method in class org.fax4j.spi.http.HTTPRequest

This function sets the content.

setContent(String) - Method in class org.fax4j.spi.http.HTTPResponse

This function sets the content.

setFile(File) - Method in interface org.fax4j.FaxJob

This function sets the file to fax.

setFile(File) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the file to fax.

setFile(File) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the file to fax.

setFilePath(String) - Method in interface org.fax4j.FaxJob

This function sets the path to the file to fax.

setFilePath(String) - Method in class org.fax4j.spi.AbstractFaxJob

This function sets the path to the file to fax.

setHeaderProperties(Properties) - Method in class org.fax4j.spi.http.HTTPRequest

This function sets the header properties.

setHostName(String) - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function sets the host name.

setID(String) - Method in interface org.fax4j.FaxJob

This function sets the fax job ID.

setID(String) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the fax job ID.

setID(String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the fax job ID.

setLogLevel(LogLevel) - Method in class org.fax4j.common.AbstractLogger

Sets the minimum log level.

setLogLevel(LogLevel) - Method in interface org.fax4j.common.Logger

Sets the minimum log level.

setMethod(FaxActionType, HTTPClient.HTTPMethod) - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function sets the HTTP method based on the provided fax action type.

setParametersText(String) - Method in class org.fax4j.spi.http.HTTPRequest

This function sets the URL parameters text.

setPort(int) - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function sets the port.

setPriority(FaxJob.FaxJobPriority) - Method in interface org.fax4j.FaxJob

This function sets the priority.

setPriority(FaxJob.FaxJobPriority) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the priority.

setPriority(FaxJob.FaxJobPriority) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the priority.

setProperty(String, String) - Method in interface org.fax4j.FaxJob

This function sets the fax job property.

setProperty(String, String) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the fax job property.

setProperty(String, String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the fax job property.

setPropertyPart(String) - Method in class org.fax4j.common.AbstractService

This function sets the property part value.
This function should be called before the initialize method.
See org.fax4j.common.ConfigurationHolder.getPropertyPart() for more info.

setPropertyPart(String) - Method in interface org.fax4j.common.Service

This function sets the property part value.
This function should be called before the initialize method.
See org.fax4j.common.ConfigurationHolder.getPropertyPart() for more info.

setRequestContent(HTTPRequest, HttpMethodBase) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function sets the request content.

setResource(String) - Method in class org.fax4j.spi.http.HTTPRequest

This function sets the requested resource.

setRunning(boolean) - Method in class org.fax4j.spi.FaxJobMonitorImpl.PollerTask

This function sets the running flag.

setSenderEmail(String) - Method in interface org.fax4j.FaxJob

This function sets the fax job sender email address.

setSenderEmail(String) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the fax job sender email address.

setSenderEmail(String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the fax job sender email address.

setSenderFaxNumber(String) - Method in interface org.fax4j.FaxJob

This function sets the fax job sender fax number.

setSenderFaxNumber(String) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the fax job sender fax number.

setSenderFaxNumber(String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the fax job sender fax number.

setSenderName(String) - Method in interface org.fax4j.FaxJob

This function sets the fax job sender name.

setSenderName(String) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the fax job sender name.

setSenderName(String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the fax job sender name.

setSSL(boolean) - Method in class org.fax4j.spi.http.CommonHTTPClientConfiguration

This function sets the SSL flag value.

setStatusCode(int) - Method in class org.fax4j.spi.http.HTTPResponse

This function sets the response status.

setTargetAddress(String) - Method in interface org.fax4j.FaxJob

This function sets the fax job target address.

setTargetAddress(String) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the fax job target address.

setTargetAddress(String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the fax job target address.

setTargetName(String) - Method in interface org.fax4j.FaxJob

This function sets the fax job target name.

setTargetName(String) - Method in class org.fax4j.spi.FaxJobImpl

This function sets the fax job target name.

setTargetName(String) - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function sets the fax job target name.

setupHTTPRequestHeaderProperties(HTTPRequest, HttpMethodBase) - Method in class org.fax4j.spi.http.ApacheHTTPClient

This function sets the header properties in the HTTP method.

setupSubmitFaxJobInput(FaxJob) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function creates an input array with the needed info to submit a new fax job based on the provided data.

shouldAddContentPart(String) - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This function enables to filter out parameters from the HTTP request.
Default implementation uses the default IGNORE_PARAMETER_KEY enum value.

shouldAddFileNamePart() - Method in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

This function returns true if the converter should add a file name content part.

SimpleHTTPRequestParser - Class in org.fax4j.bridge.http

This class provides a simple predefined implementation of the HTTP request parser used to extract the fax job and file info from the HTTP request.
This parser expects the HTTP request as follows:
URL parameters:
file [file name without path] priority [priority value as defined in the enum] target_address [target address] target_name [target name] sender_name [sender name] sender_fax_number [sender fax number] sender_email [sender email] property:[property name] [property value] The request Payload should hold the file content only.

SimpleHTTPRequestParser() - Constructor for class org.fax4j.bridge.http.SimpleHTTPRequestParser

This is the class constructor.

SimpleLogger - Class in org.fax4j.common

This is a basic implementation of the logger.
It enables to print the output to the system out stream.

SimpleLogger() - Constructor for class org.fax4j.common.SimpleLogger

This is the default constructor.

SPI_CLASS_NAME_TYPE_MAP_PROPERTY_KEY_PREFIX - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The SPI class name to type mapping property key prefix

SPI_INTERCEPTOR_LIST_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The SPI interceptor list property key

SPI_INTERCEPTOR_LIST_SEPARATOR - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The SPI interceptor list separator ';'

SPI_INTERCEPTOR_TYPE_PROPERTY_KEY_PREFIX - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The SPI interceptor type property key prefix

SPI_PROXY_CLASS_NAME_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The SPI proxy class name property key

SPI_PROXY_ENABLED_PROPERTY_KEY - Static variable in class org.fax4j.spi.FaxClientSpiFactory

The SPI proxy enabled property key

SpiUtil - Class in org.fax4j.util

This is an internal general utility class.

SpiUtil.URLTemplateParameterEncoder - Class in org.fax4j.util

This class implements the URL encoder.

startTask() - Method in class org.fax4j.spi.FaxJobMonitorImpl.PollerTask

Starts the task.

stopMonitoringAllFaxJobs(FaxClientSpi) - Method in class org.fax4j.spi.AbstractFaxJobMonitor

This function will stop the monitoring of all fax jobs registered by the provided fax client SPI.
Other fax jobs registered by other SPIs will keep on being monitored.

stopMonitoringAllFaxJobs(FaxClientSpi) - Method in interface org.fax4j.spi.FaxJobMonitor

This function will stop the monitoring of all fax jobs registered by the provided fax client SPI.
Other fax jobs registered by other SPIs will keep on being monitored.

stopMonitoringAllFaxJobsImpl(FaxClientSpi) - Method in class org.fax4j.spi.AbstractFaxJobMonitor

This function will stop the monitoring of all fax jobs registered by the provided fax client SPI.
Other fax jobs registered by other SPIs will keep on being monitored.

stopMonitoringAllFaxJobsImpl(FaxClientSpi) - Method in class org.fax4j.spi.FaxJobMonitorImpl

This function will stop the monitoring of all fax jobs registered by the provided fax client SPI.
Other fax jobs registered by other SPIs will keep on being monitored.

submitFaxJob(T) - Method in class org.fax4j.bridge.AbstractContextFaxBridge

This function will submit a new fax job.

submitFaxJob(FaxJob, FileInfo) - Method in class org.fax4j.bridge.AbstractFaxBridge

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.

submitFaxJob(T) - Method in interface org.fax4j.bridge.ContextFaxBridge

This function will submit a new fax job.

submitFaxJob(FaxJob, FileInfo) - Method in interface org.fax4j.bridge.FaxBridge

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.

submitFaxJob(T, Object, boolean) - Method in class org.fax4j.bridge.FaxBridgeFlowHelper

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

submitFaxJob(FaxJob) - Method in interface org.fax4j.common.FaxClientActions

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJob(FaxJob) - Method in class org.fax4j.FaxClient

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJob(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJob(FaxJob, CommPortAdapter) - Method in class org.fax4j.spi.comm.AbstractFaxModemAdapter

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJob(FaxJob, CommPortAdapter) - Method in interface org.fax4j.spi.comm.FaxModemAdapter

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJob(HylaFaxJob, HylaFAXClient) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob, CommPortAdapter) - Method in class org.fax4j.spi.comm.AbstractFaxModemAdapter

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.comm.CommFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob, CommPortAdapter) - Method in class org.fax4j.spi.comm.CommFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.java4less.RFaxFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.mac.MacFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFaxJobViaFaxModem(FaxJob) - Method in class org.fax4j.spi.java4less.RFaxFaxClientSpi

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

submitFileContentParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The submit fax action, file content parameter name

submitFileNameParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The submit fax action, file name parameter name

submitHTTPRequest(HTTPRequest, HTTPClientConfiguration, HTTPClient.HTTPMethod) - Method in class org.fax4j.spi.http.ApacheHTTPClient

Submits the HTTP request and returns the HTTP response.

submitHTTPRequest(HTTPRequest, HTTPClientConfiguration, HTTPClient.HTTPMethod) - Method in interface org.fax4j.spi.http.HTTPClient

Submits the HTTP request and returns the HTTP response.

submitHTTPRequest(FaxJob, HTTPRequest, FaxActionType) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Submits the HTTP request and returns the HTTP response.

submitHTTPRequestImpl(HTTPRequest, HTTPClient.HTTPMethod) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Submits the HTTP request and returns the HTTP response.

submitSenderEMailParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The submit fax action, sender email parameter name

submitSenderFaxNumberParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The submit fax action, sender fax number parameter name

submitSenderNameParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The submit fax action, sender name parameter name

submitTargetAddressParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The submit fax action, target address parameter name

submitTargetNameParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The submit fax action, target name parameter name

suspendFaxJob(FaxJob) - Method in interface org.fax4j.common.FaxClientActions

This function will suspend an existing fax job.

suspendFaxJob(FaxJob) - Method in class org.fax4j.FaxClient

This function will suspend an existing fax job.

suspendFaxJob(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJob(HylaFaxJob, HylaFAXClient) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobIDParameter - Variable in class org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter

The suspend fax action, fax job ID parameter name

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFax4JClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.adapter.AbstractAdapterFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.email.AbstractMailFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.hylafax.HylaFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.vbs.VBSFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsFaxClientSpi

This function will suspend an existing fax job.

suspendFaxJobImpl(FaxJob) - Method in class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This function will suspend an existing fax job.

SYSTEM_EOL - Static variable in interface org.fax4j.common.Logger

The system eol string value

T

TARGET_ADDRESS_TEMPLATE_PARAMETER - Static variable in class org.fax4j.util.SpiUtil

The target address template parameter

TARGET_ADDRESS_TEMPLATE_PARAMETER_STRING - Static variable in class org.fax4j.util.SpiUtil

The target address template parameter

TARGET_NAME_TEMPLATE_PARAMETER - Static variable in class org.fax4j.util.SpiUtil

The target name template parameter

TARGET_NAME_TEMPLATE_PARAMETER_STRING - Static variable in class org.fax4j.util.SpiUtil

The target name template parameter

targetAddressParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The target address parameter name

targetNameParameter - Variable in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

The target name parameter name

TEMPLATE_PARAMETER_PREFIX - Static variable in class org.fax4j.util.SpiUtil

The template parameter prefix

TEMPLATE_PARAMETER_SUFFIX - Static variable in class org.fax4j.util.SpiUtil

The template parameter suffix

TemplateFaxJob2HTTPRequestConverter - Class in org.fax4j.spi.http

This class implements the fax job to HTTP request converter interface.
This class will use request templates to construct the HTTP requests.
Only the HTTP resource, URL parameters and HTTP content accept template parameters.
The HTTP resource is the URL part after the domain, for example http://www.mydomain.com/myresource.
The HTTP URL parameters is the URL part after the ?, for example http://www.mydomain.com/myresource?param1=value1.
The HTTP content is not part of the URL and contains the POST information.
The template parameters are than updated with the values from the fax4j configuration or FaxJob data.
All template parameters are defined as ${templatename} variables, for example: http://www.mydomain.com/myresource?faxnum=${target.address}

Below table describes the template parameters.
Template Parameters:

Template Parameter Description file The fax job file content (in case of template) or name (in case of resource or URL parameters) target.address The fax job target address target.name The fax job target name sender.name The fax job sender name sender.fax.number The fax job sender fax number sender.email The fax job sender email fax.job.id The fax job ID
In case there is no template defined for a certain fax action, this class will return null.

TemplateFaxJob2HTTPRequestConverter() - Constructor for class org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter

This is the default constructor.

TemplateFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants - Enum in org.fax4j.spi.http

This class holds the configuration constants.

throwUnsupportedException() - Method in class org.fax4j.spi.AbstractFaxClientSpi

This function throws unsupported operation exception.

TIMEOUT_DEFAULT_VALUE - Static variable in class org.fax4j.spi.comm.CommFaxClientSpi

The timeout default value

toString() - Method in enum org.fax4j.bridge.http.MultiPartHTTPRequestParser.HTTPRequestParserConfigurationConstants

This function returns the string value.

toString() - Method in class org.fax4j.common.ProviderImpl

This function string value of the provider used for printing purposes.

toString() - Method in class org.fax4j.FaxClientActionEvent

Returns a String representation of this fax client action event object.

toString() - Method in class org.fax4j.FaxMonitorEvent

Returns a String representation of this fax monitor event object.

toString() - Method in enum org.fax4j.spi.AbstractFaxClientSpi.FaxJobExtendedPropertyConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.adapter.AdapterFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.comm.CommFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.efax.EFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.email.AbstractMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.email.MailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.extremefax.ExtremeFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.faxage.FaxAgeMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in class org.fax4j.spi.FaxJobImpl

This function returns the string value of the fax job.

toString() - Method in enum org.fax4j.spi.hoiio.HoiioFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.http.CommonHTTPClientConfiguration.HTTPClientConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.http.HTTPFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.http.JSONHTTPResponseHandler.JSONHTTPResponseHandlerConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.http.XMLHTTPResponseHandler.XMLHTTPResponseHandlerConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.hylafax.HylaFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in class org.fax4j.spi.hylafax.HylaFaxJob

This function returns the string value of the fax job.

toString() - Method in enum org.fax4j.spi.interfax.InterfaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.java4less.RFaxFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.java4less.RFaxFaxClientSpi.FaxJobExtendedPropertyConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.linux.LinuxFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.mac.MacFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.metrofax.MetroFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.nextivafax.NextivafaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.phaxio.PhaxioFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.process.ProcessFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.send2fax.Send2FaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.vbs.VBSFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.vbs.VBSFaxClientSpi.FaxJobExtendedPropertyConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.windows.WindowsFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.windows.WindowsFaxClientSpi.FaxJobExtendedPropertyConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.windows.WindowsProcessFaxClientSpi.Fax4jExeConstants

This function returns the string value.

toString() - Method in enum org.fax4j.spi.windows.WindowsProcessFaxClientSpi.FaxClientSpiConfigurationConstants

This function returns the string value.

transportHost - Variable in class org.fax4j.spi.email.AbstractMailConnectionFactory

The transport host

transportPort - Variable in class org.fax4j.spi.email.AbstractMailConnectionFactory

The transport port

transportProtocol - Variable in class org.fax4j.spi.email.AbstractMailConnectionFactory

The transport protocol

type - Variable in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

The type

U

unregisterCloseable(Closeable) - Static method in class org.fax4j.util.CloseableResourceManager

Unregisters the provided closeable.
Will throw an error in case the manager is no longer active (due to JVM shutdown).

updateFaxJob(FaxJob, HTTPResponse, FaxActionType) - Method in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

Updates the fax job based on the data from the HTTP response data.

updateFaxJob(FaxJob, HTTPResponse, FaxActionType) - Method in class org.fax4j.spi.http.EmptyHTTPResponseHandler

Updates the fax job based on the data from the HTTP response data.

updateFaxJob(FaxJob, HTTPResponse, FaxActionType) - Method in class org.fax4j.spi.http.HTTPFaxClientSpi

Updates the fax job based on the data from the HTTP response.

updateFaxJob(FaxJob, HTTPResponse, FaxActionType) - Method in interface org.fax4j.spi.http.HTTPResponseHandler

Updates the fax job based on the data from the HTTP response data.

updateFaxJob(FaxJob, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

Updates the fax job based on the data from the process output.

updateFaxJob(FaxClientSpi, FaxJob, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in interface org.fax4j.spi.process.ProcessOutputHandler

Updates the fax job based on the data from the process output.

updateFaxJob(FaxClientSpi, FaxJob, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in class org.fax4j.spi.vbs.VBSProcessOutputHandler

Updates the fax job based on the data from the process output.

updateFaxJob(FaxClientSpi, FaxJob, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in class org.fax4j.spi.windows.WindowsProcessOutputHandler

Updates the fax job based on the data from the process output.

updateFaxJob2HTTPRequestConverterConfiguration(Map<String, String>) - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

Hook for extending classes.

updateFaxJob2HTTPRequestConverterConfiguration(Map<String, String>) - Method in class org.fax4j.spi.http.AbstractMultiPart2JSONHTTPFaxClientSpi

Hook for extending classes.

updateFaxJob2HTTPRequestConverterConfiguration(Map<String, String>) - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

Hook for extending classes.

updateFaxJobFromInputData(T, FaxJob) - Method in class org.fax4j.bridge.AbstractRequestParser

This function update the fax job from the input data.
This fax job will not have any file data.

updateFaxJobFromInputData(T, FaxJob) - Method in interface org.fax4j.bridge.RequestParser

This function update the fax job from the input data.
This fax job will not have any file data.

updateFaxJobFromInputDataImpl(T, FaxJob) - Method in class org.fax4j.bridge.AbstractRequestParser

This function update the fax job from the request data.
This fax job will not have any file data.

updateFaxJobFromInputDataImpl(Message, FaxJob) - Method in class org.fax4j.bridge.email.DefaultMailMessageParser

This function update the fax job from the request data.
This fax job will not have any file data.

updateFaxJobFromInputDataImpl(HTTPRequest, FaxJob) - Method in class org.fax4j.bridge.http.MultiPartHTTPRequestParser

This function update the fax job from the request data.
This fax job will not have any file data.

updateFaxJobFromInputDataImpl(HTTPRequest, FaxJob) - Method in class org.fax4j.bridge.http.SimpleHTTPRequestParser

This function update the fax job from the request data.
This fax job will not have any file data.

updateFaxJobFromInputDataImpl(String[], FaxJob) - Method in class org.fax4j.bridge.process.DefaultCommandLineArgumentsParser

This function update the fax job from the request data.
This fax job will not have any file data.

updateFaxJobFromRequestImpl(HTTPRequest, FaxJob, Map<String, String>) - Method in class org.fax4j.bridge.http.SimpleHTTPRequestParser

This function update the fax job from the request data.
This fax job will not have any file data.

updateFaxJobWithFileInfo(FaxJob, FileInfo) - Method in class org.fax4j.bridge.AbstractFaxBridge

This function stores the file in the local machine and updates the fax job with the new file data.

updateFaxJobWithFileInfo(FaxJob, FileInfo) - Method in class org.fax4j.bridge.FaxBridgeImpl

This function stores the file in the local machine and updates the fax job with the new file data.

updateHTTPResponseHandlerConfiguration(Map<String, String>) - Method in class org.fax4j.spi.hoiio.HoiioFaxClientSpi

Hook for extending classes.

updateHTTPResponseHandlerConfiguration(Map<String, String>) - Method in class org.fax4j.spi.http.AbstractMultiPart2JSONHTTPFaxClientSpi

Hook for extending classes.

updateHTTPResponseHandlerConfiguration(Map<String, String>) - Method in class org.fax4j.spi.phaxio.PhaxioFaxClientSpi

Hook for extending classes.

URL_ENCODER - Static variable in class org.fax4j.util.SpiUtil

The URL encoder

urlDecode(String) - Static method in class org.fax4j.util.SpiUtil

This function URL decodes the given text.

urlEncode(String) - Static method in class org.fax4j.util.SpiUtil

This function URL encodes the given text.

URLTemplateParameterEncoder() - Constructor for class org.fax4j.util.SpiUtil.URLTemplateParameterEncoder

This is the class constructor.

userName - Variable in class org.fax4j.spi.email.AbstractMailConnectionFactory

The mail connection user name

userName - Variable in class org.fax4j.spi.hylafax.AbstractHylaFAXClientConnectionFactory

The fax server user name

useWin2kAPI - Variable in class org.fax4j.spi.vbs.VBSFaxClientSpi

The use windows 2000 API flag

useWindowsCommandPrefix - Variable in class org.fax4j.spi.process.ProcessFaxClientSpi

The use windows command prefix flag

UTF_8_ENCODING_NAME - Static variable in class org.fax4j.util.SpiUtil

The UTF-8 encoding

V

validateCondition(String, String) - Method in class org.fax4j.spi.adapter.AdapterFaxClientSpi

Validates the SPI condition.

validateFaxJobID(FaxJob) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function validates the provided fax job ID (not checking fax server, only format).

validateFaxJobID(String) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function validates the provided fax job ID (not checking fax server, only format).

validateFaxJobID(int) - Static method in class org.fax4j.spi.windows.WindowsFaxClientSpiHelper

This function validates the provided fax job ID (not checking fax server, only format).

validateProcessOutput(FaxClientSpi, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in class org.fax4j.spi.process.ExitCodeProcessOutputValidator

This function validates the process output for errors.
If not valid, an exception should be thrown.

validateProcessOutput(ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in class org.fax4j.spi.process.ProcessFaxClientSpi

This function validates the process output for errors.
If not valid, an exception should be thrown.

validateProcessOutput(FaxClientSpi, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in interface org.fax4j.spi.process.ProcessOutputValidator

This function validates the process output for errors.
If not valid, an exception should be thrown.

validateProcessOutput(FaxClientSpi, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in class org.fax4j.spi.vbs.VBSProcessOutputValidator

This function validates the process output for errors.
If not valid, an exception should be thrown.

validateProcessOutput(FaxClientSpi, ProcessExecutorHelper.ProcessOutput, FaxActionType) - Method in class org.fax4j.spi.windows.WindowsProcessOutputValidator

This function validates the process output for errors.
If not valid, an exception should be thrown.

valueOf(String) - Static method in enum org.fax4j.bridge.http.MultiPartHTTPRequestParser.HTTPRequestParserConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.common.FaxActionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.FaxClientActionEvent.FaxClientActionEventID

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.FaxJob.FaxJobPriority

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.FaxJobStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.FaxMonitorEvent.FaxMonitorEventID

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.AbstractFaxClientSpi.FaxJobExtendedPropertyConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.adapter.AdapterFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.comm.CommFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.efax.EFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.email.AbstractMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.email.MailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.extremefax.ExtremeFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.faxage.FaxAgeMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.FaxClientSpiProxy.FaxClientSpiProxyEventType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.hoiio.HoiioFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.CommonHTTPClientConfiguration.HTTPClientConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.HTTPClient.HTTPMethod

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.HTTPFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.HTTPRequest.ContentPartType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.HTTPRequest.ContentType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.JSONHTTPResponseHandler.JSONHTTPResponseHandlerConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.http.XMLHTTPResponseHandler.XMLHTTPResponseHandlerConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.hylafax.HylaFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.interfax.InterfaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.java4less.RFaxFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.java4less.RFaxFaxClientSpi.FaxJobExtendedPropertyConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.linux.LinuxFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.mac.MacFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.metrofax.MetroFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.nextivafax.NextivafaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.phaxio.PhaxioFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.process.ProcessFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.send2fax.Send2FaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.vbs.VBSFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.vbs.VBSFaxClientSpi.FaxJobExtendedPropertyConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.windows.WindowsFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.windows.WindowsFaxClientSpi.FaxJobExtendedPropertyConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.windows.WindowsProcessFaxClientSpi.Fax4jExeConstants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.fax4j.spi.windows.WindowsProcessFaxClientSpi.FaxClientSpiConfigurationConstants

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.fax4j.bridge.http.MultiPartHTTPRequestParser.HTTPRequestParserConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.common.FaxActionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.FaxClientActionEvent.FaxClientActionEventID

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.FaxJob.FaxJobPriority

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.FaxJobStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.FaxMonitorEvent.FaxMonitorEventID

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.AbstractFaxClientSpi.FaxJobExtendedPropertyConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.adapter.AdapterFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.comm.CommFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.efax.EFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.email.AbstractMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.email.MailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.extremefax.ExtremeFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.faxage.FaxAgeMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.FaxClientSpiProxy.FaxClientSpiProxyEventType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.hoiio.HoiioFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.CommonHTTPClientConfiguration.HTTPClientConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.HTTPClient.HTTPMethod

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.HTTPFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.HTTPRequest.ContentPartType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.HTTPRequest.ContentType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.JSONHTTPResponseHandler.JSONHTTPResponseHandlerConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.TemplateFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.http.XMLHTTPResponseHandler.XMLHTTPResponseHandlerConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.hylafax.HylaFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.interfax.InterfaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.java4less.RFaxFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.java4less.RFaxFaxClientSpi.FaxJobExtendedPropertyConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.linux.LinuxFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.mac.MacFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.metrofax.MetroFaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.nextivafax.NextivafaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.phaxio.PhaxioFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.process.ProcessFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.send2fax.Send2FaxMailFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.vbs.VBSFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.vbs.VBSFaxClientSpi.FaxJobExtendedPropertyConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.windows.WindowsFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.windows.WindowsFaxClientSpi.FaxJobExtendedPropertyConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.windows.WindowsProcessFaxClientSpi.Fax4jExeConstants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.fax4j.spi.windows.WindowsProcessFaxClientSpi.FaxClientSpiConfigurationConstants

Returns an array containing the constants of this enum type, in the order they are declared.

VALUES_SEPERATOR - Static variable in class org.fax4j.spi.http.AbstractMappingHTTPResponseHandler

The values seperator ';'

vbsExePath - Variable in class org.fax4j.spi.vbs.VBSFaxClientSpi

The VBS exe path

VBSFaxClientSpi - Class in org.fax4j.spi.vbs

This class implements the fax client service provider interface.
This implementation will proxy the requests to VB scripts that will invoke the windows fax API.
It is highly recommanded that the windows SPI will be used instead of this SPI.
It is possible to see all faxes submitted from this SPI in the windows fax window available from the Start→Settings→Printers and Faxes→Fax
The executable used to invoke the VBS is defaulted to cscript.

VBSFaxClientSpi() - Constructor for class org.fax4j.spi.vbs.VBSFaxClientSpi

This is the default constructor.

VBSFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.vbs

This class holds the SPI configuration constants.

VBSFaxClientSpi.FaxJobExtendedPropertyConstants - Enum in org.fax4j.spi.vbs

This class holds the fax job extended properties.

VBSProcessOutputHandler - Class in org.fax4j.spi.vbs

This class implements the VBS process output handler which is used to update the fax job based on the process output information.

VBSProcessOutputHandler() - Constructor for class org.fax4j.spi.vbs.VBSProcessOutputHandler

This is the class constructor.

VBSProcessOutputValidator - Class in org.fax4j.spi.vbs

This process output validator checks the fax4j vbscript output data for errors.

VBSProcessOutputValidator() - Constructor for class org.fax4j.spi.vbs.VBSProcessOutputValidator

This is the class constructor.

VENDOR_POLICY_CLASS_NAME - Static variable in interface org.fax4j.bridge.FaxBridge

The vendor policy class name property key

VendorPolicy - Interface in org.fax4j.bridge

The vendor policy enables vendors to hook into the fax submitting flow, enabling to restrict access, bill customers and so on, before/after the fax is submitted.
Implementing classes must have a default empty constructor and the implementation must be thread safe.

W

WIN_2K_OS_NAME - Static variable in class org.fax4j.spi.vbs.VBSFaxClientSpi

The windows 2000 OS name

WINDOWS_EXECUTE_PREFIX_DEFAULT_VALUE - Static variable in class org.fax4j.spi.process.ProcessFaxClientSpi

The windows execute prefix

WindowsFaxClientSpi - Class in org.fax4j.spi.windows

This class implements the fax client service provider interface.
This implementation will proxy the requests to windows native fax API.
It is possible to see all faxes submitted from this SPI in the windows fax window available from the Start→Settings→Printers and Faxes→Fax

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.windows.server.name The fax server host name. none none false org.fax4j.spi.windows.use.jni True to use JNI, false to use the external fax4j.exe false false false
Limitations:
This SPI will only work on Windows OS (windows 2000 and up).

WindowsFaxClientSpi() - Constructor for class org.fax4j.spi.windows.WindowsFaxClientSpi

This is the default constructor.

WindowsFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.windows

This class holds the SPI configuration constants.

WindowsFaxClientSpi.FaxJobExtendedPropertyConstants - Enum in org.fax4j.spi.windows

This class holds the fax job extended properties.

WindowsFaxClientSpiHelper - Class in org.fax4j.spi.windows

This is a helper class for the windows based SPIs.

WindowsJNIFaxClientSpi - Class in org.fax4j.spi.windows

This class implements the fax client service provider interface.
This implementation will proxy the requests to windows native fax API.
This SPI should not be used directly and instead the WindowsFaxClientSpi should be used, as it will proxy the requests to this internal SPI based on the configuration and machine setup.
It is possible to see all faxes submitted from this SPI in the windows fax window available from the Start→Settings→Printers and Faxes→Fax

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.windows.server.name The fax server host name. none none false
Limitations:
This SPI will only work on Windows OS (windows 2000 and up).

WindowsJNIFaxClientSpi() - Constructor for class org.fax4j.spi.windows.WindowsJNIFaxClientSpi

This is the default constructor.

WindowsProcessFaxClientSpi - Class in org.fax4j.spi.windows

This class implements the fax client service provider interface.
This implementation will proxy the requests to windows native fax API.
This SPI should not be used directly and instead the WindowsFaxClientSpi should be used, as it will proxy the requests to this internal SPI based on the configuration and machine setup.
It is possible to see all faxes submitted from this SPI in the windows fax window available from the Start→Settings→Printers and Faxes→Fax

The configuration of the fax4j framework is made up of 3 layers.
The configuration is based on simple properties.
Each layer overrides the lower layers by adding/changing the property values.
The first layer is the internal fax4j.properties file located in the fax4j jar.
This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers.
The second layer is the external fax4j.properties file that is located on the classpath.
This file is optional and provides the ability to override the internal configuration for the entire fax4j framework.
The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client.
These properties enable to override the configuration of the lower 2 layers.

SPI Status (Draft, Beta, Stable): Stable

Below table describes the configuration values relevant for this class.
Configuration:

Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.windows.server.name The fax server host name. none none false
Limitations:
This SPI will only work on Windows OS (windows 2000 and up).

WindowsProcessFaxClientSpi() - Constructor for class org.fax4j.spi.windows.WindowsProcessFaxClientSpi

This is the default constructor.

WindowsProcessFaxClientSpi.Fax4jExeConstants - Enum in org.fax4j.spi.windows

This class holds the fax4j exe constants.

WindowsProcessFaxClientSpi.FaxClientSpiConfigurationConstants - Enum in org.fax4j.spi.windows

This class holds the SPI configuration constants.

WindowsProcessOutputHandler - Class in org.fax4j.spi.windows

This class implements the windows process output handler which is used to update the fax job based on the process output information.

WindowsProcessOutputHandler() - Constructor for class org.fax4j.spi.windows.WindowsProcessOutputHandler

This is the class constructor.

WindowsProcessOutputValidator - Class in org.fax4j.spi.windows

This process output validator checks the fax4j.exe output data for errors.

WindowsProcessOutputValidator() - Constructor for class org.fax4j.spi.windows.WindowsProcessOutputValidator

This is the class constructor.

writeFile(byte[], File) - Static method in class org.fax4j.util.IOHelper

Writes the content to the file.

writeTextFile(String, File) - Static method in class org.fax4j.util.IOHelper

Writes the text to the file.

X

XMLHTTPResponseHandler - Class in org.fax4j.spi.http

This class provides a XML based implementation of the HTTP response handler interface.
This class expects to get XML response data and will update the fax job as needed.
This class only supports extracting the fax job ID and fax job status from the XML response object, or in case of errors, extract the error message.

XMLHTTPResponseHandler() - Constructor for class org.fax4j.spi.http.XMLHTTPResponseHandler

This is the default constructor.

XMLHTTPResponseHandler.XMLHTTPResponseHandlerConfigurationConstants - Enum in org.fax4j.spi.http

This class holds the configuration constants.

A B C D E F G H I J L M N O P R S T U V W X

Skip navigation links

• Overview
• Package
• Class
• Use
• Tree
• Deprecated
• Index
• Help

• Prev
• Next

• Frames
• No Frames

• All Classes

Copyright © 2009–2020 fax4j. All rights reserved.