Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.javax.net.ssl.provider

Class Record

public class Record
extends Object
A SSL/TLS record structure. An SSL record is defined to be: 
struct
{
ContentType     type;
ProtocolVersion version;
uint16          length;
opaque          fragment[TLSPlaintext.length];
} TLSPlaintext;

Constructor Summary

Record(ByteBuffer buffer)

Method Summary

ContentType
contentType()
Gets the content type field.
ByteBuffer
fragment()
Returns the fragment field as a ByteBuffer.
int
fragment(ByteBuffer sink)
Get the fragment content, storing it into sink.
ContentType
getContentType()
int
length()
Gets the fragment length.
void
setContentType(ContentType type)
Sets the content type field.
void
setLength(int length)
Sets the fragment length.
void
setVersion(ProtocolVersion version)
Sets the protocol version field.
String
toString()
Convert this Object to a human-readable String.
ProtocolVersion
version()
Gets the protocol version field.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Record

public Record(ByteBuffer buffer)

Method Details

contentType

public ContentType contentType()
Gets the content type field.
Returns:
The content type field.

fragment

public ByteBuffer fragment()
Returns the fragment field as a ByteBuffer. The returned buffer is shared with this object's underlying buffer, so it will share its attributes. For example, if the underlying buffer is read-only, the returned buffer will be read-only.
Returns:
The fragment buffer.

fragment

public int fragment(ByteBuffer sink)
Get the fragment content, storing it into sink.
Parameters:
sink - The sink for the fragment bytes.
Returns:
The number of bytes put into sink

getContentType

public ContentType getContentType()

length

public int length()
Gets the fragment length.
Returns:
The fragment length.

setContentType

public void setContentType(ContentType type)
Sets the content type field.
Parameters:
type - The content type.
Throws:
ReadOnlyBufferException - If the underlying buffer is not writeable.
NullPointerException - If type is null.

setLength

public void setLength(int length)
Sets the fragment length.
Parameters:
length - The fragment length.
Throws:
ReadOnlyBufferException - If the underlying buffer is not writeable.
IllegalArgumentException - If the length is not between 0 and 16384, inclusive.

setVersion

public void setVersion(ProtocolVersion version)
Sets the protocol version field.
Parameters:
version - The protocol version.
Throws:
ReadOnlyBufferException - If the underlying buffer is not writeable.
NullPointerException - If version is null.

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface Object
Returns:
the String representing this Object, which may be null
See Also:
getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

version

public ProtocolVersion version()
Gets the protocol version field.
Returns:
The protocol version field.
Record.java -- A single SSL Record. Copyright (C) 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About