public class TemplateFaxJob2HTTPRequestConverter extends AbstractFaxJob2HTTPRequestConverter
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 |
Name | Description | Preconfigured Value | Default Value | Mandatory |
org.fax4j.spi.http.template.encoding | The template encoding, if encoding is not defined, the default system encoding is used. | none | The default system encoding | false |
org.fax4j.spi.http.submit.template.url | The URL pointing to the submit fax job template. | none | none | false |
org.fax4j.spi.http.suspend.template.url | The URL pointing to the suspend fax job template. | none | none | false |
org.fax4j.spi.http.resume.template.url | The URL pointing to the resume fax job template. | none | none | false |
org.fax4j.spi.http.cancel.template.url | The URL pointing to the cancel fax job template. | none | none | false |
org.fax4j.spi.http.get.status.template.url | The URL pointing to the get fax job status template. | none | none | false |
Modifier and Type | Class and Description |
---|---|
static class |
TemplateFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants
This class holds the configuration constants.
|
Constructor and Description |
---|
TemplateFaxJob2HTTPRequestConverter()
This is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected HTTPRequest |
createHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
Enum<?> templateNameEnum,
FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
HTTPRequest |
createHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected String |
formatHTTPResource(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
This function formats the HTTP resource.
|
protected String |
formatHTTPURLParameters(HTTPFaxClientSpi faxClientSpi,
FaxJob faxJob)
This function formats the HTTP URL parameters.
|
protected String |
formatTemplate(String template,
FaxJob faxJob)
This function formats the provided template.
|
protected void |
initializeImpl()
This function initializes the component.
|
getConfiguration, getConfigurationValue, getConfigurationValue, getLogger, getPropertyPart, getProvider, initialize, setPropertyPart
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setPropertyPart
getProvider
initialize
getConfiguration, getConfigurationValue, getConfigurationValue, getPropertyPart
public TemplateFaxJob2HTTPRequestConverter()
protected void initializeImpl()
initializeImpl
in class AbstractService
public HTTPRequest createHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob)
faxClientSpi
- The HTTP fax client SPIfaxActionType
- The fax action typefaxJob
- The fax job objectprotected String formatTemplate(String template, FaxJob faxJob)
template
- The templatefaxJob
- The fax job objectprotected String formatHTTPResource(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob)
faxClientSpi
- The HTTP fax client SPIfaxActionType
- The fax action typefaxJob
- The fax job objectprotected String formatHTTPURLParameters(HTTPFaxClientSpi faxClientSpi, FaxJob faxJob)
faxClientSpi
- The HTTP fax client SPIfaxJob
- The fax job objectprotected HTTPRequest createHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, Enum<?> templateNameEnum, FaxJob faxJob)
faxClientSpi
- The HTTP fax client SPIfaxActionType
- The fax action typetemplateNameEnum
- The template namefaxJob
- The fax job objectCopyright © 2009–2020 fax4j. All rights reserved.