Package | Description |
---|---|
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 |
Provides the API classes for the email2fax bridge.
|
org.fax4j.bridge.http |
Provides the API classes for a HTTP based web2fax bridge.
|
org.fax4j.bridge.process |
Provides the API classes for a standalone process based cli2fax bridge.
|
org.fax4j.common |
Contains common internal classes used by the fax4j library.
|
org.fax4j.spi.http |
Provides the HTTP based fax client SPI implementation.
|
Modifier and Type | Interface and Description |
---|---|
interface |
RequestParser<T>
This interface defines the fax bridge request parser used to extract the fax job and file info from the input data.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractRequestParser<T>
This class provides partial implementation of the fax bridge request parser used to extract the fax job and file info
from the input data.
|
Modifier and Type | Interface and Description |
---|---|
interface |
MailMessageParser
This interface defines the mail message parser used to extract the fax job and file info from the email data.
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultMailMessageParser
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 |
Modifier and Type | Interface and Description |
---|---|
interface |
HTTPRequestParser
This interface defines the HTTP parser used to extract the fax job and file info from the HTTP request.
|
Modifier and Type | Class and Description |
---|---|
class |
MultiPartHTTPRequestParser
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.
|
class |
SimpleHTTPRequestParser
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. |
Modifier and Type | Interface and Description |
---|---|
interface |
CommandLineArgumentsParser
This interface defines the command line parser used to extract the fax job and file info from the command line
arguments.
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultCommandLineArgumentsParser
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] |
Modifier and Type | Interface and Description |
---|---|
interface |
Service
Common interface for services.
Services have common initialization and setup process. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractService
This class provides partial implementation of the service interface.
|
Modifier and Type | Interface and Description |
---|---|
interface |
FaxJob2HTTPRequestConverter
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.
|
interface |
HTTPResponseHandler
This interface defines the HTTP response handler which is used to update the fax job based on the HTTP response data.
|
Modifier and Type | Class and Description | ||
---|---|---|---|
class |
AbstractFaxJob2HTTPRequestConverter
This class provides partial implementation of the fax job to HTTP request converter interface.
|
||
class |
AbstractHTTPResponseHandler
This class provides partial implementation of the HTTP response handler interface.
|
||
class |
AbstractMappingHTTPResponseHandler<T>
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. |
||
class |
EmptyHTTPResponseHandler
This class provides empty implementation of the HTTP response handler interface.
|
||
class |
JSONHTTPResponseHandler
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. |
||
class |
MultiPartFaxJob2HTTPRequestConverter
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. |
||
class |
TemplateFaxJob2HTTPRequestConverter
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:
Copyright © 2009–2020 fax4j. All rights reserved. |