CoyoteInputStream (Tomcat API Documentation)
Keywords: org.apache.catalina.connector.CoyoteInputStream class

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.catalina.connector
Class CoyoteInputStream

    java.lang.Object
      java.io.InputStream
          javax.servlet.ServletInputStream
              org.apache.catalina.connector.CoyoteInputStream

All Implemented Interfaces:
  java.io.Closeable

    public class CoyoteInputStream

extends javax.servlet.ServletInputStream

This class handles reading bytes.

Author:
  Remy Maucherat, Jean-Francois Arcand

Field Summary
`protected InputBuffer` | `ib`

Constructor Summary
`protected` | `CoyoteInputStream(InputBuffer ib)`

Method Summary
`int` | `available()`
`protected java.lang.Object` | `clone()` Prevent cloning the facade.
`void` | `close()` Close the stream Since we re-cycle, we can't allow the call to super.close() which would permantely disable us.
`int` | `read()`
`int` | `read(byte[] b)`
`int` | `read(byte[] b, int off, int len)`
`int` | `readLine(byte[] b, int off, int len)` Reads the input stream, one line at a time.

Methods inherited from class java.io.InputStream
`mark, markSupported, reset, skip`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### ib

    protected InputBuffer ib

Constructor Detail

### CoyoteInputStream

    protected CoyoteInputStream(InputBuffer ib)

Method Detail

### clone

    protected java.lang.Object clone()
                              throws java.lang.CloneNotSupportedException

  Prevent cloning the facade.

  Overrides:
    `clone` in class `java.lang.Object`
  Throws:
    `java.lang.CloneNotSupportedException`

### read

    public int read()
             throws java.io.IOException

  Specified by:
    `read` in class `java.io.InputStream`
  Throws:
    `java.io.IOException`

### available

    public int available()
                  throws java.io.IOException

  Overrides:
    `available` in class `java.io.InputStream`
  Throws:
    `java.io.IOException`

### read

    public int read(byte[] b)
             throws java.io.IOException

  Overrides:
    `read` in class `java.io.InputStream`
  Throws:
    `java.io.IOException`

### read

    public int read(byte[] b,
                    int off,
                    int len)
             throws java.io.IOException

  Overrides:
    `read` in class `java.io.InputStream`
  Throws:
    `java.io.IOException`

### readLine

    public int readLine(byte[] b,
                        int off,
                        int len)
                 throws java.io.IOException

  Description copied from class: `javax.servlet.ServletInputStream`
  Reads the input stream, one line at a time. Starting at an offset, reads bytes into an array, until it reads a certain number of bytes or reaches a newline character, which it reads into the array as well.

  This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.

  Overrides:
    `readLine` in class `javax.servlet.ServletInputStream`
  Parameters:
    `b` - an array of bytes into which data is read
    `off` - an integer specifying the character at which this method begins reading
    `len` - an integer specifying the maximum number of bytes to read
  Returns:
    an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
  Throws:
    `java.io.IOException` - if an input or output exception has occurred

### close

    public void close()
               throws java.io.IOException

  Close the stream Since we re-cycle, we can't allow the call to super.close() which would permantely disable us.

  Specified by:
    `close` in interface `java.io.Closeable`
  Overrides:
    `close` in class `java.io.InputStream`
  Throws:
    `java.io.IOException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.