public class MultiPartFaxJob2HTTPRequestConverter extends AbstractFaxJob2HTTPRequestConverter
Name | Description | Preconfigured Value | Default Value | Mandatory |
org.fax4j.spi.http.multi.part.submit.file.content.parameter | The submit fax action, file content parameter name. | file | file | false |
org.fax4j.spi.http.multi.part.submit.file.name.parameter | The submit fax action, file name parameter name. | filename | filename | false |
org.fax4j.spi.http.multi.part.submit.target.address.parameter | The submit fax action, target address parameter name. | targetaddress | targetaddress | false |
org.fax4j.spi.http.multi.part.submit.target.name.parameter | The submit fax action, target name parameter name. | targetname | targetname | false |
org.fax4j.spi.http.multi.part.submit.sender.name.parameter | The submit fax action, sender name parameter name. | sendername | sendername | false |
org.fax4j.spi.http.multi.part.submit.sender.fax.number.parameter | The submit fax action, sender fax number parameter name. | senderfaxnumber | senderfaxnumber | false |
org.fax4j.spi.http.multi.part.submit.sender.email.parameter | The submit fax action, sender email parameter name. | senderemail | senderemail | false |
org.fax4j.spi.http.multi.part.suspend.fax.job.id.parameter | The suspend fax action, fax job ID parameter name. | faxjobid | faxjobid | false |
org.fax4j.spi.http.multi.part.resume.fax.job.id.parameter | The resume fax action, fax job ID parameter name. | faxjobid | faxjobid | false |
org.fax4j.spi.http.multi.part.cancel.fax.job.id.parameter | The cancel fax action, fax job ID parameter name. | faxjobid | faxjobid | false |
org.fax4j.spi.http.multi.part.get.status.fax.job.id.parameter | The get fax job status fax action, fax job ID parameter name. | faxjobid | faxjobid | false |
org.fax4j.spi.http.multi.part.parameter.key.X | The additional parameter to submit where X is the parameter key and the property value is the parameter
value, For example org.fax4j.spi.http.multi.part.parameter.key.my.property=my_value This converter will also send parameter my.property with value my_value |
none | none | false |
org.fax4j.spi.http.multi.part.add.file.name.as.part | The add the file name as a separate part property key. | true | true | false |
Modifier and Type | Class and Description |
---|---|
static class |
MultiPartFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants
This class holds the configuration constants.
|
Modifier and Type | Field and Description |
---|---|
protected boolean |
addFileNamePart
True to add the file name as an additional part
|
protected Map<String,String> |
additionalParameters
Additional parameters
|
protected String |
cancelFaxJobIDParameter
The cancel fax action, fax job ID parameter name
|
protected String |
getStatusFaxJobIDParameter
The get fax job status fax action, fax job ID parameter name
|
protected String |
resumeFaxJobIDParameter
The resume fax action, fax job ID parameter name
|
protected String |
submitFileContentParameter
The submit fax action, file content parameter name
|
protected String |
submitFileNameParameter
The submit fax action, file name parameter name
|
protected String |
submitSenderEMailParameter
The submit fax action, sender email parameter name
|
protected String |
submitSenderFaxNumberParameter
The submit fax action, sender fax number parameter name
|
protected String |
submitSenderNameParameter
The submit fax action, sender name parameter name
|
protected String |
submitTargetAddressParameter
The submit fax action, target address parameter name
|
protected String |
submitTargetNameParameter
The submit fax action, target name parameter name
|
protected String |
suspendFaxJobIDParameter
The suspend fax action, fax job ID parameter name
|
Constructor and Description |
---|
MultiPartFaxJob2HTTPRequestConverter()
This is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addAdditionalContentParts(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob,
List<HTTPRequest.ContentPart<?>> contentList)
This function enables extending classes to add additional content parts.
|
protected void |
addAdditionalParameters(List<HTTPRequest.ContentPart<?>> contentList)
This function adds the additional parameters.
|
protected void |
addContentPart(List<HTTPRequest.ContentPart<?>> contentList,
String key,
String value)
This function adds a string content part
|
protected HTTPRequest |
createCommonHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType)
Creates a HTTP request with the common data.
|
HTTPRequest |
createHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected Map<String,String> |
initializeAdditionalParameters()
This function builds and returns the additional parameters map.
|
protected void |
initializeImpl()
This function initializes the component.
|
protected boolean |
shouldAddContentPart(String key)
This function enables to filter out parameters from the HTTP request.
Default implementation uses the default IGNORE_PARAMETER_KEY enum value. |
protected boolean |
shouldAddFileNamePart()
This function returns true if the converter should add a file name content part.
|
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
protected String submitFileContentParameter
protected String submitFileNameParameter
protected String submitTargetAddressParameter
protected String submitTargetNameParameter
protected String submitSenderNameParameter
protected String submitSenderFaxNumberParameter
protected String submitSenderEMailParameter
protected String suspendFaxJobIDParameter
protected String resumeFaxJobIDParameter
protected String cancelFaxJobIDParameter
protected String getStatusFaxJobIDParameter
protected boolean addFileNamePart
public MultiPartFaxJob2HTTPRequestConverter()
protected void initializeImpl()
initializeImpl
in class AbstractService
protected Map<String,String> initializeAdditionalParameters()
public HTTPRequest createHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob)
faxClientSpi
- The HTTP fax client SPIfaxActionType
- The fax action typefaxJob
- The fax job objectprotected boolean shouldAddFileNamePart()
protected HTTPRequest createCommonHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType)
faxClientSpi
- The HTTP fax client SPIfaxActionType
- The fax action typeprotected final void addContentPart(List<HTTPRequest.ContentPart<?>> contentList, String key, String value)
contentList
- The content list with all the created partskey
- The parameter keyvalue
- The parameter valueprotected boolean shouldAddContentPart(String key)
key
- The parameter keyprotected final void addAdditionalParameters(List<HTTPRequest.ContentPart<?>> contentList)
contentList
- The content list with all the created partsprotected void addAdditionalContentParts(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob, List<HTTPRequest.ContentPart<?>> contentList)
faxClientSpi
- The HTTP fax client SPIfaxActionType
- The fax action typefaxJob
- The fax job objectcontentList
- The content list with all the created partsCopyright © 2009–2020 fax4j. All rights reserved.