public final class FaxClientSpiFactory extends Object
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. and type name for example:
org.fax4j.spi.type.map.adapter) which defines the SPI class name for the given SPI type. For example: org.fax4j.spi.type.map.adapter=org.fax4j.spi.adapter.AdapterFaxClientSpi Means that for SPI type adapter, the SPI class to be used is org.fax4j.spi.adapter.AdapterFaxClientSpi |
org.fax4j.spi.type.map.adapter=org.fax4j.spi.adapter.AdapterFaxClientSpi org.fax4j.spi.type.map.windows=org.fax4j.spi.windows.WindowsFaxClientSpi org.fax4j.spi.type.map.vbs=org.fax4j.spi.vbs.VBSFaxClientSpi org.fax4j.spi.type.map.mail=org.fax4j.spi.email.MailFaxClientSpi org.fax4j.spi.type.map.http=org.fax4j.spi.http.HTTPFaxClientSpi org.fax4j.spi.type.map.process=org.fax4j.spi.process.ProcessFaxClientSpi org.fax4j.spi.type.map.linux=org.fax4j.spi.linux.LinuxFaxClientSpi org.fax4j.spi.type.map.mac=org.fax4j.spi.mac.MacFaxClientSpi org.fax4j.spi.type.map.hylafax=org.fax4j.spi.hylafax.HylaFaxClientSpi org.fax4j.spi.type.map.comm=org.fax4j.spi.comm.CommFaxClientSpi org.fax4j.spi.type.map.interfax=org.fax4j.spi.interfax.InterfaxMailFaxClientSpi org.fax4j.spi.type.map.nextivafax=org.fax4j.spi.nextivafax.NextivafaxMailFaxClientSpi org.fax4j.spi.type.map.send2fax=org.fax4j.spi.send2fax.Send2FaxMailFaxClientSpi org.fax4j.spi.type.map.metrofax=org.fax4j.spi.metrofax.MetroFaxMailFaxClientSpi org.fax4j.spi.type.map.faxage=org.fax4j.spi.faxage.FaxAgeMailFaxClientSpi org.fax4j.spi.type.map.extremefax=org.fax4j.spi.extremefax.ExtremeFaxMailFaxClientSpi org.fax4j.spi.type.map.efax=org.fax4j.spi.efax.EFaxMailFaxClientSpi org.fax4j.spi.type.map.phaxio=org.fax4j.spi.phaxio.PhaxioFaxClientSpi org.fax4j.spi.type.map.hoiio=org.fax4j.spi.hoiio.HoiioFaxClientSpi org.fax4j.spi.type.map.rfax=org.fax4j.spi.java4less.RFaxFaxClientSpi |
NA | NA |
org.fax4j.spi.default.type | In case the SPI type was not provided in the createFaxClientSpi method, the type will be taken from this property value. | adapter | none | false |
org.fax4j.logger.class.name | Defines the internal fax4j logger class name. The logger must implement the org.fax4j.common.Logger interface and have an empty constructor. This property can only be set in the internal fax4j.properties and the fax4j.properties on the classpath, providing these values as part of the java.util.Properties input of the createFaxClientSpi will have no affect. |
org.fax4j.common.SimpleLogger | org.fax4j.common.SimpleLogger | false |
org.fax4j.logger.log.level | Defines the internal fax4j logger log level. The possible values are: DEBUG, INFO and ERROR. This property can only be set in the internal fax4j.properties and the fax4j.properties on the classpath, providing these values as part of the java.util.Properties input of the createFaxClientSpi will have no affect. |
ERROR | ERROR | false |
org.fax4j.monitor.class.name | Defines the internal fax job monitor class name. This property can only be set in the internal fax4j.properties and the fax4j.properties on the classpath, providing these values as part of the java.util.Properties input of the createFaxClientSpi will have no affect. |
org.fax4j.spi.FaxJobMonitorImpl | org.fax4j.spi.FaxJobMonitorImpl | false |
org.fax4j.proxy.enabled | True to enable the fax client SPI proxy. | true | true | false |
org.fax4j.proxy.class.name | Defines the fax client SPI proxy class name. | org.fax4j.spi.FaxClientSpiProxyImpl | org.fax4j.spi.FaxClientSpiProxyImpl | false |
org.fax4j.proxy.interceptor.list | A list of interceptor types, separated by a ';' character. Each type must have a matching org.fax4j.proxy.interceptor.type.xxx property. |
log | none | false |
org.fax4j.proxy.interceptor.type.xxx | The interceptor type to class name mapping. | org.fax4j.proxy.interceptor.type.log=org.fax4j.spi.LogFaxClientSpiInterceptor | none | false |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SPI_TYPE_PROPERTY_KEY
The default SPI type property key
|
static String |
FAX_JOB_MONITOR_CLASS_NAME_PROPERTY_KEY
The fax job monitor class name property key
|
static String |
SPI_CLASS_NAME_TYPE_MAP_PROPERTY_KEY_PREFIX
The SPI class name to type mapping property key prefix
|
static String |
SPI_INTERCEPTOR_LIST_PROPERTY_KEY
The SPI interceptor list property key
|
static String |
SPI_INTERCEPTOR_LIST_SEPARATOR
The SPI interceptor list separator ';'
|
static String |
SPI_INTERCEPTOR_TYPE_PROPERTY_KEY_PREFIX
The SPI interceptor type property key prefix
|
static String |
SPI_PROXY_CLASS_NAME_PROPERTY_KEY
The SPI proxy class name property key
|
static String |
SPI_PROXY_ENABLED_PROPERTY_KEY
The SPI proxy enabled property key
|
Modifier and Type | Method and Description |
---|---|
static FaxClientSpi |
createChildFaxClientSpi(String type,
Properties configuration)
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. |
static FaxClientSpi |
createFaxClientSpi(String type,
Properties configuration)
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. |
protected static Map<String,String> |
getConfiguration(Properties configuration)
Returns the configuration to be used by the new SPI instance.
The configuration of the fax client SPI is made up of 3 layers. |
public static final String FAX_JOB_MONITOR_CLASS_NAME_PROPERTY_KEY
public static final String DEFAULT_SPI_TYPE_PROPERTY_KEY
public static final String SPI_CLASS_NAME_TYPE_MAP_PROPERTY_KEY_PREFIX
public static final String SPI_PROXY_ENABLED_PROPERTY_KEY
public static final String SPI_PROXY_CLASS_NAME_PROPERTY_KEY
public static final String SPI_INTERCEPTOR_LIST_PROPERTY_KEY
public static final String SPI_INTERCEPTOR_TYPE_PROPERTY_KEY_PREFIX
public static final String SPI_INTERCEPTOR_LIST_SEPARATOR
public static FaxClientSpi createFaxClientSpi(String type, Properties configuration)
type
- The fax client type (may be null for default type)configuration
- The fax client configuration (may be null)public static FaxClientSpi createChildFaxClientSpi(String type, Properties configuration)
type
- The fax client type (may be null for default type)configuration
- The fax client configuration (may be null)protected static Map<String,String> getConfiguration(Properties configuration)
configuration
- The fax client configuration (may be null)Copyright © 2009–2020 fax4j. All rights reserved.