|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ning.http.multipart.Part
public abstract class Part
This class is an adaptation of the Apache HttpClient implementation
Field Summary | |
---|---|
protected static String |
BOUNDARY
The boundary |
protected static String |
CHARSET
Content charset |
protected static String |
CONTENT_DISPOSITION
Content dispostion characters |
protected static String |
CONTENT_TRANSFER_ENCODING
Content type header |
protected static String |
CONTENT_TYPE
Content type header |
protected static String |
CRLF
Carriage return/linefeed |
protected static String |
EXTRA
Extra characters |
protected static String |
QUOTE
Content dispostion characters |
Constructor Summary | |
---|---|
Part()
|
Method Summary | |
---|---|
static String |
getBoundary()
Deprecated. uses a constant string. Rather use getPartBoundary() |
abstract String |
getCharSet()
Return the character encoding of this part. |
abstract String |
getContentType()
Returns the content type of this part. |
static long |
getLengthOfParts(Part[] parts)
Return the total sum of all parts and that of the last boundary |
static long |
getLengthOfParts(Part[] parts,
byte[] partBoundary)
Gets the length of the multipart message including the given parts. |
abstract String |
getName()
Return the name of this part. |
protected byte[] |
getPartBoundary()
Gets the part boundary to be used. |
abstract String |
getTransferEncoding()
Return the transfer encoding of this part. |
boolean |
isRepeatable()
Tests if this part can be sent more than once. |
long |
length()
Return the full length of all the data. |
protected abstract long |
lengthOfData()
Return the length of the main content |
void |
send(OutputStream out)
Write all the data to the output stream. |
protected void |
sendContentTypeHeader(OutputStream out)
Write the content type header to the specified output stream |
protected abstract void |
sendData(OutputStream out)
Write the data to the specified output stream |
protected void |
sendDispositionHeader(OutputStream out)
Write the content disposition header to the specified output stream |
protected void |
sendEnd(OutputStream out)
Write the end data to the output stream. |
protected void |
sendEndOfHeader(OutputStream out)
Write the end of the header to the output stream |
static void |
sendMessageEnd(OutputStream out,
byte[] partBoundary)
|
static void |
sendPart(OutputStream out,
Part part,
byte[] partBoundary)
Write all parts and the last boundary to the specified output stream. |
static void |
sendParts(OutputStream out,
Part[] parts)
Write all parts and the last boundary to the specified output stream. |
static void |
sendParts(OutputStream out,
Part[] parts,
byte[] partBoundary)
Write all parts and the last boundary to the specified output stream. |
protected void |
sendStart(OutputStream out)
Write the start to the specified output stream |
protected void |
sendTransferEncodingHeader(OutputStream out)
Write the content transfer encoding header to the specified output stream |
String |
toString()
Return a string representation of this object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final String BOUNDARY
protected static final String CRLF
protected static final String QUOTE
protected static final String EXTRA
protected static final String CONTENT_DISPOSITION
protected static final String CONTENT_TYPE
protected static final String CHARSET
protected static final String CONTENT_TRANSFER_ENCODING
Constructor Detail |
---|
public Part()
Method Detail |
---|
public static String getBoundary()
getPartBoundary()
public abstract String getName()
getName
in interface Part
public abstract String getContentType()
null
to exclude the content type headerpublic abstract String getCharSet()
null
to exclude the character
encoding headerpublic abstract String getTransferEncoding()
null
to exclude the transfer encoding headerprotected byte[] getPartBoundary()
public boolean isRepeatable()
true
if sendData(java.io.OutputStream)
can be successfully called
more than once.protected void sendStart(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.protected void sendDispositionHeader(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.protected void sendContentTypeHeader(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.protected void sendTransferEncodingHeader(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.protected void sendEndOfHeader(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.protected abstract void sendData(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.protected abstract long lengthOfData() throws IOException
IOException
- If an IO problem occursprotected void sendEnd(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.public void send(OutputStream out) throws IOException
out
- The output stream
IOException
- If an IO problem occurs.public long length() throws IOException
IOException
- If an IO problem occurspublic String toString()
toString
in class Object
Object.toString()
public static void sendParts(OutputStream out, Part[] parts) throws IOException
out
- The stream to write to.parts
- The parts to write.
IOException
- If an I/O error occurs while writing the parts.public static void sendParts(OutputStream out, Part[] parts, byte[] partBoundary) throws IOException
out
- The stream to write to.parts
- The parts to write.partBoundary
- The ASCII bytes to use as the part boundary.
IOException
- If an I/O error occurs while writing the parts.public static void sendMessageEnd(OutputStream out, byte[] partBoundary) throws IOException
IOException
public static void sendPart(OutputStream out, Part part, byte[] partBoundary) throws IOException
out
- The stream to write to.part
- The part to write.
IOException
- If an I/O error occurs while writing the parts.public static long getLengthOfParts(Part[] parts) throws IOException
parts
- The parts.
IOException
- If an I/O error occurs while writing the parts.public static long getLengthOfParts(Part[] parts, byte[] partBoundary) throws IOException
parts
- The parts.partBoundary
- The ASCII bytes to use as the part boundary.
IOException
- If an I/O error occurs while writing the parts.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |