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

Class ByteArrayPartSource

java.lang.Object

org.apache.commons.httpclient.methods.multipart.ByteArrayPartSource

All Implemented Interfaces:

PartSource

@Deprecated
public class ByteArrayPartSource
extends Object
implements PartSource

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.

A PartSource that reads from a byte array. This class should be used when the data to post is already loaded into memory.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
ByteArrayPartSource(String fileName, byte[] bytes)	Deprecated. Constructor for ByteArrayPartSource.

Method Summary

Modifier and Type	Method	Description
InputStream	createInputStream()	Deprecated. Gets a new InputStream for reading this source.
String	getFileName()	Deprecated. Gets the name of the file this source represents.
long	getLength()	Deprecated. Gets the number of bytes contained in this source.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayPartSource

public ByteArrayPartSource(String fileName,
                           byte[] bytes)

Deprecated.

Constructor for ByteArrayPartSource.

Parameters:

fileName - the name of the file these bytes represent

bytes - the content of this part

Method Detail

getLength

public long getLength()

Deprecated.

Description copied from interface: PartSource

Gets the number of bytes contained in this source.

Specified by:

getLength in interface PartSource

Returns:

a value >= 0

See Also:

PartSource.getLength()

getFileName

public String getFileName()

Deprecated.

Description copied from interface: PartSource

Gets the name of the file this source represents.

Specified by:

getFileName in interface PartSource

Returns:

the fileName used for posting a MultiPart file part

See Also:

PartSource.getFileName()

createInputStream

public InputStream createInputStream()
                              throws IOException

Deprecated.

Description copied from interface: PartSource

Gets a new InputStream for reading this source. This method can be called more than once and should therefore return a new stream every time.

Specified by:

createInputStream in interface PartSource

Returns:

a new InputStream

Throws:

IOException - if an error occurs when creating the InputStream

See Also:

PartSource.createInputStream()