SSLSessionImpl (CryptoPro Java TLS)

java.lang.Object
- javax.net.ssl.ExtendedSSLSession
- - ru.CryptoPro.ssl.SSLSessionImpl

All Implemented Interfaces:

javax.net.ssl.SSLSession
```
public final class SSLSessionImpl
extends javax.net.ssl.ExtendedSSLSession
```
Implements the SSL session interface, and exposes the session context which is maintained by SSL servers.
Servers have the ability to manage the sessions associated with their authentication context(s). They can do this by enumerating the IDs of the sessions which are cached, examining those sessions, and then perhaps invalidating a given session so that it can't be used again. If servers do not explicitly manage the cache, sessions will linger until memory is low enough that the runtime environment purges cache entries automatically to reclaim space.
The only reason this class is not package-private is that there's no other public way to get at the server session context which is associated with any given authentication context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Returns true if sessions have same ids, false otherwise.
`int`	`getApplicationBufferSize()` Gets the current size of the largest application data that is expected when using this session.
`java.security.cert.X509Certificate[]`	`getCertificateChain()` Return the cert chain presented by the peer.
`java.lang.String`	`getCipherSuite()` Returns the name of the cipher suite in use on this session
`long`	`getCreationTime()` Returns the time this session was created.
`byte[]`	`getId()` Returns the ID for this session.
`long`	`getLastAccessedTime()` Returns the last time this session was used to initialize a connection.
`java.security.cert.Certificate[]`	`getLocalCertificates()` Return the cert chain presented to the peer in the java.security.cert format.
`java.security.Principal`	`getLocalPrincipal()` Returns the principal that was sent to the peer during handshaking.
`java.lang.String[]`	`getLocalSupportedSignatureAlgorithms()` Gets an array of supported signature algorithms that the local side is willing to verify.
`int`	`getPacketBufferSize()` Gets the current size of the largest SSL/TLS packet that is expected when using this session.
`java.net.InetAddress`	`getPeerAddress()` Returns the network address of the session's peer.
`javax.security.cert.X509Certificate[]`	`getPeerCertificateChain()` Return the cert chain presented by the peer in the javax.security.cert format.
`java.security.cert.Certificate[]`	`getPeerCertificates()` Return the cert chain presented by the peer in the java.security.cert format.
`java.lang.String`	`getPeerHost()`
`int`	`getPeerPort()` Need to provide the port info for caching sessions based on host and port.
`java.security.Principal`	`getPeerPrincipal()` Returns the identity of the peer which was established as part of defining the session.
`java.lang.String[]`	`getPeerSupportedSignatureAlgorithms()` Gets an array of supported signature algorithms that the peer is able to verify.
`java.lang.String`	`getProtocol()` Returns the standard name of the protocol in use on this session
`java.util.List<javax.net.ssl.SNIServerName>`	`getRequestedServerNames()` Obtains a `List` containing all `SNIServerName`s of the requested Server Name Indication (SNI) extension.
`javax.net.ssl.SSLSessionContext`	`getSessionContext()` For server sessions, this returns the set of sessions which are currently valid in this process.
`java.lang.Object`	`getValue(java.lang.String key)` Returns the specified session value.
`java.lang.String[]`	`getValueNames()` Lists the names of the session values.
`int`	`hashCode()` Returns the hashcode for this session
`void`	`invalidate()` Invalidate a session.
`boolean`	`isValid()`
`void`	`putValue(java.lang.String key, java.lang.Object value)` Assigns a session value.
`void`	`removeValue(java.lang.String key)` Removes the specified session value, delivering a session changed event as appropriate.
`java.lang.String`	`toString()` Returns a string representation of this SSL session

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - isValid
```
public boolean isValid()
```
  - getId
```
public byte[] getId()
```
    Returns the ID for this session. The ID is fixed for the duration of the session; neither it, nor its value, changes.
  - getSessionContext
```
public javax.net.ssl.SSLSessionContext getSessionContext()
```
    For server sessions, this returns the set of sessions which are currently valid in this process. For client sessions, this returns null.
  - getCipherSuite
```
public java.lang.String getCipherSuite()
```
    Returns the name of the cipher suite in use on this session
  - getProtocol
```
public java.lang.String getProtocol()
```
    Returns the standard name of the protocol in use on this session
  - hashCode
```
public int hashCode()
```
    Returns the hashcode for this session
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if sessions have same ids, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
  - getPeerCertificates
```
public java.security.cert.Certificate[] getPeerCertificates()
                                                     throws javax.net.ssl.SSLPeerUnverifiedException
```
    Return the cert chain presented by the peer in the java.security.cert format. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.
    
    Returns:
    
    array of peer X.509 certs, with the peer's own cert first in the chain, and with the "root" CA last.
    
    Throws:
    
    javax.net.ssl.SSLPeerUnverifiedException
  - getLocalCertificates
```
public java.security.cert.Certificate[] getLocalCertificates()
```
    Return the cert chain presented to the peer in the java.security.cert format. Note: This method is useful only when using certificate-based cipher suites.
    
    Returns:
    
    array of peer X.509 certs, with the peer's own cert first in the chain, and with the "root" CA last.
  - getPeerCertificateChain
```
public javax.security.cert.X509Certificate[] getPeerCertificateChain()
                                                              throws javax.net.ssl.SSLPeerUnverifiedException
```
    Return the cert chain presented by the peer in the javax.security.cert format. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.
    
    Returns:
    
    array of peer X.509 certs, with the peer's own cert first in the chain, and with the "root" CA last.
    
    Throws:
    
    javax.net.ssl.SSLPeerUnverifiedException
  - getCertificateChain
```
public java.security.cert.X509Certificate[] getCertificateChain()
                                                         throws javax.net.ssl.SSLPeerUnverifiedException
```
    Return the cert chain presented by the peer. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.
    
    Returns:
    
    array of peer X.509 certs, with the peer's own cert first in the chain, and with the "root" CA last.
    
    Throws:
    
    javax.net.ssl.SSLPeerUnverifiedException
  - getPeerPrincipal
```
public java.security.Principal getPeerPrincipal()
                                         throws javax.net.ssl.SSLPeerUnverifiedException
```
    Returns the identity of the peer which was established as part of defining the session.
    
    Returns:
    
    the peer's principal. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and Principal for Kerberos cipher suites.
    
    Throws:
    
    javax.net.ssl.SSLPeerUnverifiedException - if the peer's identity has not been verified
  - getLocalPrincipal
```
public java.security.Principal getLocalPrincipal()
```
    Returns the principal that was sent to the peer during handshaking.
    
    Returns:
    
    the principal sent to the peer. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and Principal for Kerberos cipher suites. If no principal was sent, then null is returned.
  - getCreationTime
```
public long getCreationTime()
```
    Returns the time this session was created.
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    Returns the last time this session was used to initialize a connection.
  - getPeerAddress
```
public java.net.InetAddress getPeerAddress()
```
    Returns the network address of the session's peer. This implementation does not insist that connections between different ports on the same host must necessarily belong to different sessions, though that is of course allowed.
  - getPeerHost
```
public java.lang.String getPeerHost()
```
  - getPeerPort
```
public int getPeerPort()
```
    Need to provide the port info for caching sessions based on host and port. Accessed by SSLSessionContextImpl
  - invalidate
```
public void invalidate()
```
    Invalidate a session. Active connections may still exist, but no connections will be able to rejoin this session.
  - putValue
```
public void putValue(java.lang.String key,
                     java.lang.Object value)
```
    Assigns a session value. Session change events are given if appropriate, to any original value as well as the new value.
  - getValue
```
public java.lang.Object getValue(java.lang.String key)
```
    Returns the specified session value.
  - removeValue
```
public void removeValue(java.lang.String key)
```
    Removes the specified session value, delivering a session changed event as appropriate.
  - getValueNames
```
public java.lang.String[] getValueNames()
```
    Lists the names of the session values.
  - getPacketBufferSize
```
public int getPacketBufferSize()
```
    Gets the current size of the largest SSL/TLS packet that is expected when using this session.
  - getApplicationBufferSize
```
public int getApplicationBufferSize()
```
    Gets the current size of the largest application data that is expected when using this session.
  - getLocalSupportedSignatureAlgorithms
```
public java.lang.String[] getLocalSupportedSignatureAlgorithms()
```
    Gets an array of supported signature algorithms that the local side is willing to verify.
    
    Specified by:
    
    getLocalSupportedSignatureAlgorithms in class javax.net.ssl.ExtendedSSLSession
  - getPeerSupportedSignatureAlgorithms
```
public java.lang.String[] getPeerSupportedSignatureAlgorithms()
```
    Gets an array of supported signature algorithms that the peer is able to verify.
    
    Specified by:
    
    getPeerSupportedSignatureAlgorithms in class javax.net.ssl.ExtendedSSLSession
  - getRequestedServerNames
```
public java.util.List<javax.net.ssl.SNIServerName> getRequestedServerNames()
```
    Obtains a List containing all SNIServerNames of the requested Server Name Indication (SNI) extension.
    
    Overrides:
    
    getRequestedServerNames in class javax.net.ssl.ExtendedSSLSession
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this SSL session
    
    Overrides:
    
    toString in class java.lang.Object

Class SSLSessionImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isValid

getId

getSessionContext

getCipherSuite

getProtocol

hashCode

equals

getPeerCertificates

getLocalCertificates

getPeerCertificateChain

getCertificateChain

getPeerPrincipal

getLocalPrincipal

getCreationTime

getLastAccessedTime

getPeerAddress

getPeerHost

getPeerPort

invalidate

putValue

getValue

removeValue

getValueNames

getPacketBufferSize

getApplicationBufferSize

getLocalSupportedSignatureAlgorithms

getPeerSupportedSignatureAlgorithms

getRequestedServerNames

toString