gnu.javax.net.ssl

Class Session

java.lang.Object
- gnu.javax.net.ssl.Session

Implemented Interfaces:: Serializable, SSLSession

Known Direct Subclasses:: SessionImpl

public abstract class Session

extends Object

implements SSLSession, Serializable

A concrete implementation of the SSLSession interface. This class is provided to allow pluggable AbstractSessionContext implementations.

See Also:: Serialized Form

Nested Class Summary
`static class`	`Session.ID` An SSL or TLS session ID.

Field Summary
`protected int`	`applicationBufferSize`
`protected SSLSessionContext`	`context`
`protected long`	`creationTime`
`protected long`	`lastAccessedTime`
`protected Certificate[]`	`localCerts`
`protected X509Certificate[]`	`peerCertChain`
`protected Certificate[]`	`peerCerts`
`protected String`	`peerHost`
`protected int`	`peerPort`
`protected boolean`	`peerVerified`
`protected SecureRandom`	`random`
`protected Session.ID`	`sessionId`
`protected boolean`	`truncatedMac`
`protected boolean`	`valid`
`protected HashMap`	`values`

Constructor Summary
`Session()` The basic constructor.

Method Summary
`void`	`access()`
`int`	`getApplicationBufferSize()` Returns the size of the largest application data buffer that can occur in this session.
`String`	`getCipherSuite()` Returns this session's cihper suite.
`long`	`getCreationTime()` Returns the time in milliseconds since midnight GMT, 1 January 1970, that this session was created.
`byte[]`	`getId()` Returns this session's unique identifier, a arbitrary byte array of up to 32 bytes.
`long`	`getLastAccessedTime()` Returns the last time this session was accessed.
`Certificate[]`	`getLocalCertificates()` Returns the chain of certificates that the local side used in the handshake, or null if none were used.
`Principal`	`getLocalPrincipal()` Returns the `Principal` representing the local identity used in this session, or `null` if there is no local identity.
`int`	`getPacketBufferSize()` Returns the size of the largest SSL message that will be generated by this session.
`X509Certificate[]`	`getPeerCertificateChain()` Returns the chain of certificates that the remote side used in the handshake, or null if none were used.
`Certificate[]`	`getPeerCertificates()` Returns the chain of certificates that the remote side used in the handshake, or null if none were used.
`String`	`getPeerHost()` Returns the remote host's name.
`int`	`getPeerPort()` Returns the port number the remote peer is using for this session.
`Principal`	`getPeerPrincipal()` Returns the `Principal` representing the identity of the remote peer, or `null` if the remote peer has no known identity.
`SSLSessionContext`	`getSessionContext()` Returns this session's session context object.
`Object`	`getValue(String name)` Returns the object bound to the given name.
`String[]`	`getValueNames()` Returns the names of all values bound to this session.
`Session.ID`	`id()`
`void`	`invalidate()` Invalidates this session, ensuring that it will not be continued by another socket.
`boolean`	`isTruncatedMac()`
`boolean`	`isValid()` Tells if this session is currently valid, and may be resumed.
`abstract void`	`prepare(char[] password)` Prepare this session for serialization.
`abstract SealedObject`	`privateData()` Get the private data of this session.
`void`	`putValue(String name, Object value)` Binds a value to this session, with the given name.
`void`	`removeValue(String name)` Un-binds a value.
`abstract void`	`repair(char[] password)` Repair this session's private data after deserialization.
`abstract void`	`setPrivateData(SealedObject data)` Set the private data of this session.

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

Session

protected Session()

The basic constructor. Object is special, because it has no superclass, so there is no call to super().

access

public void access()

getApplicationBufferSize

public int getApplicationBufferSize()

Returns the size of the largest application data buffer that can occur in this session.
Buffers passed to handle the incoming data for the unwrap method of SSLEngine must be at least this large.
Specified by:
getApplicationBufferSize in interface SSLSession
Returns:
The size of application buffers.
Since:
1.5

getCipherSuite

public String getCipherSuite()

Returns this session's cihper suite.
Specified by:
getCipherSuite in interface SSLSession
Returns:
The cipher suite.

getCreationTime

public long getCreationTime()

Returns the time in milliseconds since midnight GMT, 1 January 1970, that this session was created.
Specified by:
getCreationTime in interface SSLSession
Returns:
The creation time.

getId

public byte[] getId()

Returns this session's unique identifier, a arbitrary byte array of up to 32 bytes.
Specified by:
getId in interface SSLSession
Returns:
The session identifier.

getLastAccessedTime

public long getLastAccessedTime()

Returns the last time this session was accessed.
Specified by:
getLastAccessedTime in interface SSLSession
Returns:
The lest time this session was accessed.

getLocalCertificates

public Certificate[] getLocalCertificates()

Returns the chain of certificates that the local side used in the handshake, or null if none were used.
Specified by:
getLocalCertificates in interface SSLSession
Returns:
The local certificate chain.

getLocalPrincipal

public Principal getLocalPrincipal()

Returns the Principal representing the local identity used in this session, or null if there is no local identity.
Specified by:
getLocalPrincipal in interface SSLSession
Returns:
The local principal.

getPacketBufferSize

public int getPacketBufferSize()

Returns the size of the largest SSL message that will be generated by this session.
Callers of wrap and unwrap should use this value to determine the size of buffers for data coming into, or going out over, the network.
Specified by:
getPacketBufferSize in interface SSLSession
Since:
1.5

getPeerCertificateChain

public X509Certificate[] getPeerCertificateChain()
            throws SSLPeerUnverifiedException

Returns the chain of certificates that the remote side used in the handshake, or null if none were used.
Specified by:
getPeerCertificateChain in interface SSLSession
Returns:
The peer's certificate chain.
Throws:
SSLPeerUnverifiedException - If the identity of the peer has not been verified.

getPeerCertificates

public Certificate[] getPeerCertificates()
            throws SSLPeerUnverifiedException

Returns the chain of certificates that the remote side used in the handshake, or null if none were used.
Specified by:
getPeerCertificates in interface SSLSession
Returns:
The peer's certificate chain.
Throws:
SSLPeerUnverifiedException - If the identity of the peer has not been verified.

getPeerHost

public String getPeerHost()

Returns the remote host's name.
Specified by:
getPeerHost in interface SSLSession
Returns:
The name of the remote host.

getPeerPort

public int getPeerPort()

Returns the port number the remote peer is using for this session.
Specified by:
getPeerPort in interface SSLSession
Returns:
The peer's port number.
Since:
1.5

getPeerPrincipal

public Principal getPeerPrincipal()
            throws SSLPeerUnverifiedException

Returns the Principal representing the identity of the remote peer, or null if the remote peer has no known identity.
Specified by:
getPeerPrincipal in interface SSLSession
Returns:
The remote peer's principal.
Throws:
SSLPeerUnverifiedException - If the remote peer's identity could not be verified.
Since:
1.5

getSessionContext

public SSLSessionContext getSessionContext()

Returns this session's session context object.
Specified by:
getSessionContext in interface SSLSession
Returns:
The session context.
Throws:
SecurityException - If the caller does not have the SSLPermission "getSessionContext".

getValue

public Object getValue(String name)

Returns the object bound to the given name.
Specified by:
getValue in interface SSLSession
Parameters:
name - The name of the value to get.
Returns:
The object bound by that name, or null.

getValueNames

public String[] getValueNames()

Returns the names of all values bound to this session.
Specified by:
getValueNames in interface SSLSession
Returns:
The list of bound names.

id

public Session.ID id()

invalidate

public void invalidate()

Invalidates this session, ensuring that it will not be continued by another socket.
Specified by:
invalidate in interface SSLSession

isTruncatedMac

public final boolean isTruncatedMac()

isValid

public boolean isValid()

Tells if this session is currently valid, and may be resumed.
Specified by:
isValid in interface SSLSession
Returns:
True if this session is valid.
Since:
1.5
See Also:
SSLSession.invalidate()

prepare

public abstract void prepare(char[] password)
            throws SSLException

Prepare this session for serialization. Private data will be encrypted with the given password, and this object will then be ready to be serialized.
Parameters:
password - The password to protect this session with.
Throws:
SSLException - If encrypting this session's private data fails.

privateData

public abstract SealedObject privateData()
            throws SSLException

Get the private data of this session. This method may only be called after first calling prepare(char[]).
Returns:
The sealed private data.
Throws:
SSLException - If the private data have not been sealed.

putValue

public void putValue(String name,
                     Object value)

Binds a value to this session, with the given name.
Specified by:
putValue in interface SSLSession
Parameters:
name - The name to bind the object with.
value - The value to bind.

removeValue

public void removeValue(String name)

Un-binds a value.
Specified by:
removeValue in interface SSLSession
Parameters:
name - The name of the value to un-bind.

repair

public abstract void repair(char[] password)
            throws SSLException

Repair this session's private data after deserialization. This method will decrypt this session's private data, and prepare the session for use in new SSL connections.
Parameters:
password - The password to decrypt the private data with.
Throws:
SSLException -

setPrivateData

public abstract void setPrivateData(SealedObject data)
            throws SSLException

Set the private data of this session.
Parameters:
data -
Throws:
SSLException -

SessionImpl.java -- concrete definition of SSLSession. 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
Prev Class \| Next Class		Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr

gnu.javax.net.ssl

Class Session

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

applicationBufferSize

context

creationTime

lastAccessedTime

localCerts

peerCertChain

peerCerts

peerHost

peerPort

peerVerified

random

sessionId

truncatedMac

valid

values

Constructor Details