javax.net.ssl

Interface SSLSession

public interface SSLSession

An SSL session is a mechanism through which connections can be established by re-using previously negotiated handshakes.

Method Summary

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.
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.
String
getProtocol()
Returns the protocol this session uses.
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.
void
invalidate()
Invalidates this session, ensuring that it will not be continued by another socket.
void
putValue(String name, Object value)
Binds a value to this session, with the given name.
void
removeValue(String name)
Un-binds a value.

Method Details

getCipherSuite

public String getCipherSuite()
Returns this session's cihper suite.
Returns:
The cipher suite.

getCreationTime

public long getCreationTime()
Returns the time in milliseconds since midnight GMT, 1 January 1970, that this session was created.
Returns:
The creation time.

getId

public byte[] getId()
Returns this session's unique identifier, a arbitrary byte array of up to 32 bytes.
Returns:
The session identifier.

getLastAccessedTime

public long getLastAccessedTime()
Returns the last time this session was accessed.
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.
Returns:
The local certificate chain.

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.
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.
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.
Returns:
The name of the remote host.

getProtocol

public String getProtocol()
Returns the protocol this session uses.
Returns:
The protocol.

getSessionContext

public SSLSessionContext getSessionContext()
Returns this session's session context object.
Returns:
The session context.

getValue

public Object getValue(String name)
Returns the object bound to the given name.
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.
Returns:
The list of bound names.

invalidate

public void invalidate()
Invalidates this session, ensuring that it will not be continued by another socket.

putValue

public void putValue(String name,
                     Object value)
Binds a value to this session, with the given name.
Parameters:
name - The name to bind the object with.
value - The value to bind.

removeValue

public void removeValue(String name)
Un-binds a value.
Parameters:
name - The name of the value to un-bind.