class |
AdapterFaxClientSpi
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
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.comm
Modifier and Type |
Class and Description |
class |
CommFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.efax
Modifier and Type |
Class and Description |
class |
EFaxMailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.email
Modifier and Type |
Class and Description |
class |
AbstractMailFaxClientSpi
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.
|
class |
MailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.extremefax
Modifier and Type |
Class and Description |
class |
ExtremeFaxMailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.faxage
Modifier and Type |
Class and Description |
class |
FaxAgeMailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.hoiio
Modifier and Type |
Class and Description |
class |
HoiioFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.http
Modifier and Type |
Class and Description |
class |
AbstractMultiPart2JSONHTTPFaxClientSpi
This class provides common base for HTTP based SPIs which submit multi part HTTP request and expect a JSON output.
|
class |
HTTPFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.hylafax
Modifier and Type |
Class and Description |
class |
HylaFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.interfax
Modifier and Type |
Class and Description |
class |
InterfaxMailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.java4less
Modifier and Type |
Class and Description |
class |
RFaxFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.linux
Modifier and Type |
Class and Description |
class |
LinuxFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.mac
Modifier and Type |
Class and Description |
class |
MacFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.metrofax
Modifier and Type |
Class and Description |
class |
MetroFaxMailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.nextivafax
Modifier and Type |
Class and Description |
class |
NextivafaxMailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.phaxio
Modifier and Type |
Class and Description |
class |
PhaxioFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.process
Modifier and Type |
Class and Description |
class |
ProcessFaxClientSpi
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
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.send2fax
Modifier and Type |
Class and Description |
class |
Send2FaxMailFaxClientSpi
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.
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.vbs
Modifier and Type |
Class and Description |
class |
VBSFaxClientSpi
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.
|
Subclasses of AbstractFax4JClientSpi in org.fax4j.spi.windows
Modifier and Type |
Class and Description |
class |
WindowsFaxClientSpi
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).
class |
WindowsJNIFaxClientSpi
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).
class |
WindowsProcessFaxClientSpi
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).
Copyright © 2009–2020 fax4j. All rights reserved.
| | | | | | | | | | | | | | | | | | | | |