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

javax.net.ssl

Class SSLEngineResult

public class SSLEngineResult
extends Object
A result from an SSLEngine wrap or unwrap operation. This class conveys a possibly intermediate result, and may ask for more input data or request that output data be sent over a connection.

Nested Class Summary

static class
SSLEngineResult.HandshakeStatus
An enumeration of possible handshake status states.
static class
SSLEngineResult.Status
An enumeration of possible general states.

Constructor Summary

SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced)
Creates a new SSL engine result.

Method Summary

int
bytesConsumed()
Returns the number of bytes consumed by the previous operation.
int
bytesProduced()
Returns the number of bytes produced by the previous operation.
SSLEngineResult.HandshakeStatus
getHandshakeStatus()
Returns the handshake status.
SSLEngineResult.Status
getStatus()
Returns the connection status.
String
toString()
Convert this Object to a human-readable String.

Methods inherited from class java.lang.Object

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

Constructor Details

SSLEngineResult

public SSLEngineResult(SSLEngineResult.Status status,
                       SSLEngineResult.HandshakeStatus handshakeStatus,
                       int bytesConsumed,
                       int bytesProduced)
Creates a new SSL engine result.
Parameters:
status - The status of the SSL connection.
handshakeStatus - The status of the SSL handshake.
bytesConsumed - The number of bytes consumed by the previous operation.
bytesProduced - The number of bytes produced by the previous operation.
Throws:
IllegalArgumentException - If either enum value is null, or if either integer is negative.

Method Details

bytesConsumed

public int bytesConsumed()
Returns the number of bytes consumed by the previous operation.
Returns:
The number of bytes consumed.

bytesProduced

public int bytesProduced()
Returns the number of bytes produced by the previous operation.
Returns:
The number of bytes produced.

getHandshakeStatus

public SSLEngineResult.HandshakeStatus getHandshakeStatus()
Returns the handshake status.
Returns:
The handshake status.

getStatus

public SSLEngineResult.Status getStatus()
Returns the connection status.
Returns:
The connection status.

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)
SSLEngineResult.java -- Copyright (C) 2006 Free Software Foundation, Inc. This file is 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, 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; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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