Package org.apache.commons.httpclient.methods.multipart

Class Part

java.lang.Object

org.apache.commons.httpclient.methods.multipart.Part

Direct Known Subclasses:

PartBase

@Deprecated
public abstract class Part
extends Object

Deprecated.

Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

Abstract class for one Part of a multipart post object.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
Part()	Deprecated.

Method Summary

Modifier and Type	Method	Description
static String	getBoundary()	Deprecated. uses a constant string.
abstract String	getCharSet()	Deprecated. Return the character encoding of this part.
abstract String	getContentType()	Deprecated. Returns the content type of this part.
static long	getLengthOfParts(Part[] parts)	Deprecated. Return the total sum of all parts and that of the last boundary
static long	getLengthOfParts(Part[] parts, byte[] partBoundary)	Deprecated. Gets the length of the multipart message including the given parts.
abstract String	getName()	Deprecated. Return the name of this part.
abstract String	getTransferEncoding()	Deprecated. Return the transfer encoding of this part.
boolean	isRepeatable()	Deprecated. Tests if this part can be sent more than once.
long	length()	Deprecated. Return the full length of all the data.
void	send(OutputStream out)	Deprecated. Write all the data to the output stream.
static void	sendParts(OutputStream out, Part[] parts)	Deprecated. Write all parts and the last boundary to the specified output stream.
static void	sendParts(OutputStream out, Part[] parts, byte[] partBoundary)	Deprecated. Write all parts and the last boundary to the specified output stream.
String	toString()	Deprecated. Return a string representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Part

public Part()

Deprecated.

Method Detail

getBoundary

public static String getBoundary()

Deprecated.

uses a constant string. Rather use getPartBoundary()

Return the boundary string.

Returns:

the boundary string

getName

public abstract String getName()

Deprecated.

Return the name of this part.

Returns:

The name.

getContentType

public abstract String getContentType()

Deprecated.

Returns the content type of this part.

Returns:

the content type, or null to exclude the content type header

getCharSet

public abstract String getCharSet()

Deprecated.

Return the character encoding of this part.

Returns:

the character encoding, or null to exclude the character encoding header

getTransferEncoding

public abstract String getTransferEncoding()

Deprecated.

Return the transfer encoding of this part.

Returns:

the transfer encoding, or null to exclude the transfer encoding header

isRepeatable

public boolean isRepeatable()

Deprecated.

Tests if this part can be sent more than once.

Returns:

true if sendData(OutputStream) can be successfully called more than once.

Since:

3.0

send

public void send(OutputStream out)
          throws IOException

Deprecated.

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

Throws:

IOException - If an IO problem occurs.

length

public long length()
            throws IOException

Deprecated.

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.

Throws:

IOException - If an IO problem occurs

toString

public String toString()

Deprecated.

Return a string representation of this object.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

sendParts

public static void sendParts(OutputStream out,
                             Part[] parts)
                      throws IOException

Deprecated.

Write all parts and the last boundary to the specified output stream.

Parameters:

out - The stream to write to.

parts - The parts to write.

Throws:

IOException - If an I/O error occurs while writing the parts.

sendParts

public static void sendParts(OutputStream out,
                             Part[] parts,
                             byte[] partBoundary)
                      throws IOException

Deprecated.

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.

Throws:

IOException - If an I/O error occurs while writing the parts.

Since:

3.0

getLengthOfParts

public static long getLengthOfParts(Part[] parts)
                             throws IOException

Deprecated.

Return the total sum of all parts and that of the last boundary

Parameters:

parts - The parts.

Returns:

The total length

Throws:

IOException - If an I/O error occurs while writing the parts.

getLengthOfParts

public static long getLengthOfParts(Part[] parts,
                                    byte[] partBoundary)
                             throws IOException

Deprecated.

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

Throws:

IOException - If an I/O error occurs while writing the parts.

Since:

3.0