Apache Struts API Documentation: Class BufferedMultipartInputStream

Apache Struts API

previous page next page
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

org.apache.struts.upload Class BufferedMultipartInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--org.apache.struts.upload.BufferedMultipartInputStream
Deprecated. Use the Commons FileUpload based multipart handler instead. This class will be removed after Struts 1.2.

public class BufferedMultipartInputStream
extends java.io.InputStream

This class implements buffering for an InputStream as well as a readLine method. The purpose of this is to provide a reliable readLine() method.

Field Summary
protected  byte[] buffer
          Deprecated. The byte array used to hold buffered data
protected  int bufferLength
          Deprecated. The number of bytes read from the underlying InputStream that are in the buffer
protected  int bufferOffset
          Deprecated. The current offset we're at in the buffer's byte array
protected  int bufferSize
          Deprecated. The size of the byte array buffer
protected  long contentLength
          Deprecated. The content length of the multipart data
protected  boolean contentLengthMet
          Deprecated. Whether or not bytes up to the Content-Length have been read
protected  java.io.InputStream inputStream
          Deprecated. The underlying InputStream used by this class
protected  boolean maxLengthMet
          Deprecated. Whether or not bytes up to the maximum length have been read
protected  long maxSize
          Deprecated. The maximum allowed size for the multipart data, or -1 for an unlimited maximum file length
protected  int totalLength
          Deprecated. The total number of bytes read so far
 
Fields inherited from class java.io.InputStream
SKIP_BUFFER_SIZE, skipBuffer
 
Constructor Summary
BufferedMultipartInputStream(java.io.InputStream inputStream, int bufferSize, long contentLength, long maxSize)
          Deprecated. Public constructor for this class, just wraps the InputStream given
 
Method Summary
 int available()
          Deprecated. This method returns the number of available bytes left to read in the buffer before it has to be refilled
 void close()
          Deprecated. This method attempts to close the underlying InputStream
 boolean contentLengthMet()
          Deprecated.  
protected  void fill()
          Deprecated. Fills the buffer with data from the underlying inputStream.
 void mark(int position)
          Deprecated. This method calls on the mark() method of the underlying InputStream
 boolean markSupported()
          Deprecated. This method calls on the markSupported() method of the underlying InputStream
 boolean maxLengthMet()
          Deprecated.  
 int read()
          Deprecated. This method returns the next byte in the buffer, and refills it if necessary.
 int read(byte[] b)
          Deprecated. This method populates the byte array b with data up to b.length bytes
 int read(byte[] b, int offset, int length)
          Deprecated. This method populates the byte array b with data up to length starting at b[offset]
 byte[] readLine()
          Deprecated. This method reads a line, regardless of length.
 int readLine(byte[] b, int offset, int length)
          Deprecated. This method reads into the byte array b until a newline ('\n') character is encountered or the number of bytes specified by length have been read
 void reset()
          Deprecated. This method makes a call to the reset() method of the underlying InputStream
 
Methods inherited from class java.io.InputStream
skip
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

inputStream

protected java.io.InputStream inputStream
Deprecated. 
The underlying InputStream used by this class

buffer

protected byte[] buffer
Deprecated. 
The byte array used to hold buffered data

bufferOffset

protected int bufferOffset
Deprecated. 
The current offset we're at in the buffer's byte array

bufferSize

protected int bufferSize
Deprecated. 
The size of the byte array buffer

bufferLength

protected int bufferLength
Deprecated. 
The number of bytes read from the underlying InputStream that are in the buffer

totalLength

protected int totalLength
Deprecated. 
The total number of bytes read so far

contentLength

protected long contentLength
Deprecated. 
The content length of the multipart data

maxSize

protected long maxSize
Deprecated. 
The maximum allowed size for the multipart data, or -1 for an unlimited maximum file length

contentLengthMet

protected boolean contentLengthMet
Deprecated. 
Whether or not bytes up to the Content-Length have been read

maxLengthMet

protected boolean maxLengthMet
Deprecated. 
Whether or not bytes up to the maximum length have been read
Constructor Detail

BufferedMultipartInputStream

public BufferedMultipartInputStream(java.io.InputStream inputStream,
                                    int bufferSize,
                                    long contentLength,
                                    long maxSize)
                             throws java.io.IOException
Deprecated. 
Public constructor for this class, just wraps the InputStream given
Parameters:
inputStream - The underlying stream to read from
bufferSize - The size in bytes of the internal buffer
contentLength - The content length for this request
maxSize - The maximum size in bytes that this multipart request can be, or -1 for an unlimited length
Method Detail

available

public int available()
Deprecated. 
This method returns the number of available bytes left to read in the buffer before it has to be refilled
Overrides:
available in class java.io.InputStream

close

public void close()
           throws java.io.IOException
Deprecated. 
This method attempts to close the underlying InputStream
Overrides:
close in class java.io.InputStream

mark

public void mark(int position)
Deprecated. 
This method calls on the mark() method of the underlying InputStream
Overrides:
mark in class java.io.InputStream

markSupported

public boolean markSupported()
Deprecated. 
This method calls on the markSupported() method of the underlying InputStream
Overrides:
markSupported in class java.io.InputStream
Returns:
Whether or not the underlying InputStream supports marking

maxLengthMet

public boolean maxLengthMet()
Deprecated. 
Returns:
true if the maximum length has been reached, false otherwise

contentLengthMet

public boolean contentLengthMet()
Deprecated. 
Returns:
true if the content length has been reached, false otherwise

read

public int read()
         throws java.io.IOException
Deprecated. 
This method returns the next byte in the buffer, and refills it if necessary.
Overrides:
read in class java.io.InputStream
Returns:
The next byte read in the buffer, or -1 if the end of the stream has been reached

read

public int read(byte[] b)
         throws java.io.IOException
Deprecated. 
This method populates the byte array b with data up to b.length bytes
Overrides:
read in class java.io.InputStream

read

public int read(byte[] b,
                int offset,
                int length)
         throws java.io.IOException
Deprecated. 
This method populates the byte array b with data up to length starting at b[offset]
Overrides:
read in class java.io.InputStream

readLine

public int readLine(byte[] b,
                    int offset,
                    int length)
             throws java.io.IOException
Deprecated. 
This method reads into the byte array b until a newline ('\n') character is encountered or the number of bytes specified by length have been read

readLine

public byte[] readLine()
                throws java.io.IOException
Deprecated. 
This method reads a line, regardless of length.
Returns:
A byte array representing the line.

reset

public void reset()
           throws java.io.IOException
Deprecated. 
This method makes a call to the reset() method of the underlying InputStream
Overrides:
reset in class java.io.InputStream

fill

protected void fill()
             throws java.io.IOException
Deprecated. 
Fills the buffer with data from the underlying inputStream. If it can't fill the entire buffer in one read, it will read as many times as necessary to fill the buffer
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2000-2005 - The Apache Software Foundation

previous page start next page