public static interface Payload.Outbound
| Modifier and Type | Method and Description |
|---|---|
void |
addPart(int index,
String contentType,
String name,
Properties props,
InputStream content)
Adds a part of the specified content type, name, and content at a
specified position in the parts of the payload.
|
void |
addPart(String contentType,
String name,
Properties props,
InputStream content)
Adds a part of the specified content type, name, and content to
the payload.
|
void |
addPart(String contentType,
String name,
Properties props,
String content)
Adds a part of the specified content type, name, and String content
to the payload.
|
void |
attachFile(String contentType,
URI fileURI,
String dataRequestName,
File file)
Adds a part to the payload of the given content type from the
specified file.
|
void |
attachFile(String contentType,
URI fileURI,
String dataRequestName,
File file,
boolean isRecursive)
Adds a part to the payload of the given content type from the
specified file.
|
void |
attachFile(String contentType,
URI fileURI,
String dataRequestName,
Properties props,
File file)
Adds a part to the payload of the given content type from the
specified file.
|
void |
attachFile(String contentType,
URI fileURI,
String dataRequestName,
Properties props,
File file,
boolean isRecursive)
Adds a part to the payload of the given content type from the
specified file.
|
String |
getContentType()
Returns the content type of the payload, determined by whether there
are multiple parts and, if not, if the content type of the single
part is of type "text."
|
String |
getHeaderName()
Returns the name of the header that should be set in the outgoing and
incoming http request or response.
|
boolean |
isDirty()
Indicates whether Payload was modified since dirty flag was reset.
|
Iterator<Payload.Part> |
parts()
Returns the parts from the outbound payload.
|
void |
requestFileRemoval(URI fileURI,
String dataRequestName,
Properties props)
Adds a part to the payload that represents a request to remove the
specified file, presumably previously transferred in a payload
during an earlier request.
|
void |
requestFileRemoval(URI fileURI,
String dataRequestName,
Properties props,
boolean isRecursive)
Adds a part to the payload that represents a request to remove the
specified file, presumably previously transferred in a payload
during an earlier request.
|
void |
requestFileReplacement(String contentType,
URI fileURI,
String dataRequestName,
Properties props,
File file,
boolean isRecursive)
Adds a part to the payload to request that the specified file be
replaced.
|
void |
resetDirty()
Resets Payload dirty flag, indicating whether Payload was modified.
|
int |
size()
Count of attached parts
|
void |
writeTo(OutputStream os)
Writes the parts already added to the payload to the specified
OutputStream.
|
int size()
void addPart(String contentType, String name, Properties props, String content) throws IOException
contentType - content type of the partname - name to be assigned to the partprops - Properties to be included with the partcontent - String containing the content for the partIOExceptionvoid addPart(String contentType, String name, Properties props, InputStream content) throws IOException
contentType - content type of the partname - name to be assigned to the partprops - Properties to be included with the partcontent - InputStream furnishing the content for this partIOExceptionvoid addPart(int index,
String contentType,
String name,
Properties props,
InputStream content)
throws IOException
index - position (zero-based) where the part should be addedcontentType - content type of the partname - name to be assigned to thepartprops - Properties to be included with the partcontent - InputStream furnishing the content for this partIOExceptionvoid attachFile(String contentType, URI fileURI, String dataRequestName, File file) throws IOException
If the file argument specifies a directory, only the
directory - not its contents - are attached to the payload. To
include the directory and its contents use attachFile(java.lang.String, java.net.URI, java.lang.String, java.io.File, boolean)
and specify the recursive argument as true.
contentType - content type of the partfileURI - URI relative to which the part's name should be computeddataRequestName - name identifying which part of a request this file answersfile - File containing the content for the partIOExceptionvoid attachFile(String contentType, URI fileURI, String dataRequestName, File file, boolean isRecursive) throws IOException
contentType - content type of the partfileURI - URI relative to which the part's name should be computeddataRequestName - name identifying which part of a request this file answersfile - File containing the content for the partisRecursive - if file is a directory, whether to add its contents as wellIOExceptionvoid attachFile(String contentType, URI fileURI, String dataRequestName, Properties props, File file) throws IOException
contentType - content type of the partfileURI - URI relative to which the part's name should be computeddataRequestName - name identifying which part of a request this file answersprops - Properties to be included with the partfile - File containing the content for the partIOExceptionvoid attachFile(String contentType, URI fileURI, String dataRequestName, Properties props, File file, boolean isRecursive) throws IOException
contentType - content type of the partfileURI - URI relative to which the part's name should be computeddataRequestName - name identifying which part of a request this file answersprops - Properties to be included with the partfile - File containing the content for the partisRecursive - if file is a directory, whether to add its contents as wellIOExceptionvoid requestFileRemoval(URI fileURI, String dataRequestName, Properties props) throws IOException
fileURI - relative URI of the file for deletiondataRequestName - name identifying which part of a request triggered the file removalprops - Properties to be included with the partIOExceptionvoid requestFileRemoval(URI fileURI, String dataRequestName, Properties props, boolean isRecursive) throws IOException
fileURI - relative URI of the file for deletiondataRequestName - name identifying which part of a request triggered the file removalprops - Properties to be included with the partisRecursive - if fileURI is a directory, whether to remove its contents as wellIOExceptionvoid requestFileReplacement(String contentType, URI fileURI, String dataRequestName, Properties props, File file, boolean isRecursive) throws IOException
If the fileURI translates to a non-directory file on the receiving
system then calling this method will replace the file's contents
on the target with the contents of the file argument.
If the fileURI is for a directory, then if isRecursive is also specified the payload will contain one Part to replace the directory (which will have the result of removing the directory and its contents and then recreating the directory) plus a Part for each file, including subdirectories, below the directory. The intent is to replace the entire directory with new contents.
fileURI - dataRequestName - props - isRecursive - IOExceptionvoid writeTo(OutputStream os) throws IOException
os - OutputStream to receive the formatted payloadIOExceptionString getContentType()
String getHeaderName()
Iterator<Payload.Part> parts()
void resetDirty()
boolean isDirty()
true if Payload was modified.Copyright © 2017–2020 Eclipse Foundation. All rights reserved.