001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017:
018: /**
019: * @author Alexander Y. Kleymenov
020: * @version $Revision$
021: */package org.apache.harmony.xnet.provider.jsse;
022:
023: import java.io.IOException;
024: import java.io.InputStream;
025:
026: /**
027: * This class is a base for all input stream classes used
028: * in protocol implementation. It extends an InputStream with
029: * some additional read methods allowing to read TLS specific
030: * data types such as uint8, uint32 etc (see TLS v 1 specification
031: * at http://www.ietf.org/rfc/rfc2246.txt).
032: */
033: public abstract class SSLInputStream extends InputStream {
034:
035: /**
036: * @see java.io.InputStream#available()
037: */
038: public abstract int available() throws IOException;
039:
040: /**
041: * Reads the following byte value. Note that in the case of
042: * reaching of the end of the data this methods throws the
043: * exception, not return -1. The type of exception depends
044: * on implementation. It was done for simplifying and speeding
045: * up of processing of such cases.
046: * @see org.apache.harmony.xnet.provider.jsse.SSLStreamedInput#read()
047: * @see org.apache.harmony.xnet.provider.jsse.SSLBufferedInput#read()
048: * @see org.apache.harmony.xnet.provider.jsse.HandshakeIODataStream#read()
049: */
050: public abstract int read() throws IOException;
051:
052: /**
053: * @see java.io.InputStream#skip()
054: */
055: public long skip(long n) throws IOException {
056: long skept = n;
057: while (n > 0) {
058: read();
059: n--;
060: }
061: return skept;
062: }
063:
064: /**
065: * Reads and returns uint8 value.
066: */
067: public int readUint8() throws IOException {
068: return read() & 0x00FF;
069: }
070:
071: /**
072: * Reads and returns uint16 value.
073: */
074: public int readUint16() throws IOException {
075: return (read() << 8) | (read() & 0x00FF);
076: }
077:
078: /**
079: * Reads and returns uint24 value.
080: */
081: public int readUint24() throws IOException {
082: return (read() << 16) | (read() << 8) | (read() & 0x00FF);
083: }
084:
085: /**
086: * Reads and returns uint32 value.
087: */
088: public long readUint32() throws IOException {
089: return (read() << 24) | (read() << 16) | (read() << 8)
090: | (read() & 0x00FF);
091: }
092:
093: /**
094: * Reads and returns uint64 value.
095: */
096: public long readUint64() throws IOException {
097: return (read() << 56) | (read() << 48) | (read() << 40)
098: | (read() << 32) | (read() << 24) | (read() << 16)
099: | (read() << 8) | (read() & 0x00FF);
100: }
101:
102: /**
103: * Returns the vector of opaque values of specified length;
104: * @param length - the length of the vector to be read.
105: * @return the read data
106: * @throws IOException if read operation could not be finished.
107: */
108: public byte[] read(int length) throws IOException {
109: byte[] res = new byte[length];
110: for (int i = 0; i < length; i++) {
111: res[i] = (byte) read();
112: }
113: return res;
114: }
115:
116: /**
117: * @see java.io.InputStream#read(byte[],int,int)
118: */
119: public int read(byte[] b, int off, int len) throws IOException {
120: int read_b;
121: int i = 0;
122: do {
123: if ((read_b = read()) == -1) {
124: return (i == 0) ? -1 : i;
125: }
126: b[off + i] = (byte) read_b;
127: i++;
128: } while ((available() != 0) && (i < len));
129: return i;
130: }
131: }
|