Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.httpclient.methods.multipart.Part
public abstract class Part
extends java.lang.Object
Field Summary | |
protected static String |
|
protected static byte[] |
|
protected static String |
|
protected static byte[] |
|
protected static String |
|
protected static byte[] |
|
protected static String |
|
protected static byte[] |
|
protected static String |
|
protected static byte[] |
|
protected static String |
|
protected static byte[] |
|
protected static String |
|
protected static byte[] |
|
protected static String |
|
protected static byte[] |
|
Method Summary | |
static String |
|
abstract String |
|
abstract String |
|
static long |
|
static long |
|
abstract String |
|
protected byte[] |
|
abstract String |
|
boolean |
|
long |
|
protected abstract long |
|
void |
|
protected void |
|
protected abstract void |
|
protected void |
|
protected void |
|
protected void |
|
static void | |
static void | |
protected void |
|
protected void |
|
String |
|
protected static final String BOUNDARY
Deprecated. use
HttpMethodParams.MULTIPART_BOUNDARY
The boundary
protected static final byte[] BOUNDARY_BYTES
Deprecated.
The boundary as a byte array.
protected static final String CHARSET
Content charset
protected static final byte[] CHARSET_BYTES
Content charset as a byte array
protected static final String CONTENT_DISPOSITION
Content dispostion characters
protected static final byte[] CONTENT_DISPOSITION_BYTES
Content dispostion as a byte array
protected static final String CONTENT_TRANSFER_ENCODING
Content type header
protected static final byte[] CONTENT_TRANSFER_ENCODING_BYTES
Content type header as a byte array
protected static final String CONTENT_TYPE
Content type header
protected static final byte[] CONTENT_TYPE_BYTES
Content type header as a byte array
protected static final String CRLF
Carriage return/linefeed
protected static final byte[] CRLF_BYTES
Carriage return/linefeed as a byte array
protected static final String EXTRA
Extra characters
protected static final byte[] EXTRA_BYTES
Extra characters as a byte array
protected static final String QUOTE
Content dispostion characters
protected static final byte[] QUOTE_BYTES
Content dispostion as a byte array
public static String getBoundary()
Deprecated. uses a constant string. Rather use
getPartBoundary()
Return the boundary string.
- Returns:
- the boundary string
public abstract String getCharSet()
Return the character encoding of this part.
- Returns:
- the character encoding, or
null
to exclude the character encoding header
public abstract String getContentType()
Returns the content type of this part.
- Returns:
- the content type, or
null
to exclude the content type header
public static long getLengthOfParts(Part[] parts) throws IOException
Return the total sum of all parts and that of the last boundary
- Parameters:
parts
- The parts.
- Returns:
- The total length
public static long getLengthOfParts(Part[] parts, byte[] partBoundary) throws IOException
Gets the length of the multipart message including the given parts.
- Parameters:
parts
- The parts.partBoundary
- The ASCII bytes to use as the part boundary.
- Returns:
- The total length
- Since:
- 3.0
public abstract String getName()
Return the name of this part.
- Returns:
- The name.
protected byte[] getPartBoundary()
Gets the part boundary to be used.
- Returns:
- the part boundary as an array of bytes.
- Since:
- 3.0
public abstract String getTransferEncoding()
Return the transfer encoding of this part.
- Returns:
- the transfer encoding, or
null
to exclude the transfer encoding header
public boolean isRepeatable()
Tests if this part can be sent more than once.
- Returns:
true
ifsendData(OutputStream)
can be successfully called more than once.
- Since:
- 3.0
public long length() throws IOException
Return the full length of all the data. If you override this method make sure to override #send(OutputStream) as well
- Returns:
- long The length.
protected abstract long lengthOfData() throws IOException
Return the length of the main content
- Returns:
- long The length.
public void send(OutputStream out) throws IOException
Write all the data to the output stream. If you override this method make sure to override #length() as well
- Parameters:
out
- The output stream
protected void sendContentTypeHeader(OutputStream out) throws IOException
Write the content type header to the specified output stream
- Parameters:
out
- The output stream
protected abstract void sendData(OutputStream out) throws IOException
Write the data to the specified output stream
- Parameters:
out
- The output stream
protected void sendDispositionHeader(OutputStream out) throws IOException
Write the content disposition header to the specified output stream
- Parameters:
out
- The output stream
protected void sendEnd(OutputStream out) throws IOException
Write the end data to the output stream.
- Parameters:
out
- The output stream
protected void sendEndOfHeader(OutputStream out) throws IOException
Write the end of the header to the output stream
- Parameters:
out
- The output stream
public static void sendParts(OutputStream out, Part[] parts) throws IOException
Write all parts and the last boundary to the specified output stream.
- Parameters:
out
- The stream to write to.parts
- The parts to write.
public static void sendParts(OutputStream out, Part[] parts, byte[] partBoundary) throws IOException
Write all parts and the last boundary to the specified output stream.
- Parameters:
out
- The stream to write to.parts
- The parts to write.partBoundary
- The ASCII bytes to use as the part boundary.
- Since:
- 3.0
protected void sendStart(OutputStream out) throws IOException
Write the start to the specified output stream
- Parameters:
out
- The output stream
protected void sendTransferEncodingHeader(OutputStream out) throws IOException
Write the content transfer encoding header to the specified output stream
- Parameters:
out
- The output stream
public String toString()
Return a string representation of this object.
- Returns:
- A string representation of this object.
- See Also:
java.lang.Object.toString()