gnu.javax.net.ssl.provider

Class Handshake

Implemented Interfaces:
Constructed

public final class Handshake
extends Object
implements Constructed

An SSL handshake message. SSL handshake messages have the following form:
struct
{
HandshakeType msg_type;
uint24        length;
select (msg_type)
{
case hello_request:       HelloRequest;
case client_hello:        ClientHello;
case server_hello:        ServerHello;
case certificate:         Certificate;
case server_key_exchange: ServerKeyExchange;
case certificate_request: CertificateRequest;
case server_hello_done:   ServerHelloDone;
case certificate_verify:  CertificateVerify;
case client_key_exchange: ClientKeyExchange;
case finished:            Finished;
} body;
};

Nested Class Summary

static interface
Handshake.Body
static class
Handshake.Type

Constructor Summary

Handshake(ByteBuffer buffer)
Handshake(ByteBuffer buffer, CipherSuite suite, ProtocolVersion version)

Method Summary

Handshake.Body
body()
Returns the handshake message body.
ByteBuffer
bodyBuffer()
Returns a subsequence of the underlying buffer, containing only the bytes that compose the handshake body.
int
length()
Returns the message length.
void
setLength(int length)
Sets the length of the handshake body.
void
setType(Handshake.Type type)
Sets the handshake body type.
String
toString()
Convert this Object to a human-readable String.
String
toString(String prefix)
Returns a printable representation of this structure, with the given prefix prepended to each line.
Handshake.Type
type()
Returns the handshake type.

Methods inherited from class java.lang.Object

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

Constructor Details

Handshake

public Handshake(ByteBuffer buffer)

Handshake

public Handshake(ByteBuffer buffer,
                 CipherSuite suite,
                 ProtocolVersion version)

Method Details

body

public Handshake.Body body()
Returns the handshake message body. Depending on the handshake type, some implementation of the Body interface is returned.
Returns:
The handshake body.

bodyBuffer

public ByteBuffer bodyBuffer()
Returns a subsequence of the underlying buffer, containing only the bytes that compose the handshake body.
Returns:
The body's byte buffer.

length

public int length()
Returns the message length.
Specified by:
length in interface Constructed
Returns:
The message length.

setLength

public void setLength(int length)
Sets the length of the handshake body.
Parameters:
length - The handshake body length.
Throws:
ReadOnlyBufferException - If the underlying buffer is not writable.
IllegalArgumentException - of length is not between 0 and 16777215, inclusive.

setType

public void setType(Handshake.Type type)
Sets the handshake body type.
Parameters:
type - The handshake type.

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

toString

public String toString(String prefix)
Returns a printable representation of this structure, with the given prefix prepended to each line.
Specified by:
toString in interface Constructed
Parameters:
prefix - The prefix to prepend to each line of the output. This value may be null.
Returns:
A printable representation of this structure.

type

public Handshake.Type type()
Returns the handshake type.
Returns:
The handshake type.

Handshake.java -- SSL Handshake message. 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.