OpenJDK 27 · javax.net.ssl.SSLSession · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public int	Returns: the current maximum expected application packet size getApplicationBufferSize() Gets the current size of the largest application data that is expected when using this session.
public String	Returns: the name of the session's cipher suite getCipherSuite() Returns the name of the SSL cipher suite which is used for all connections in the session.
public long	Returns: the time this Session was created getCreationTime() Returns the time at which this Session representation was created, in milliseconds since midnight, January 1, 1970 UTC.
public byte[]	Returns: the Session identifier getId() Returns the identifier assigned to this Session.
public long	Returns: the last time this Session was accessed getLastAccessedTime() Returns the last time this Session representation was accessed by the session level infrastructure, in milliseconds since midnight, January 1, 1970 UTC.
public Certificate[]	Returns: an ordered array of certificates, with the local certificate first followed by any certificate authorities. If no certificates were sent, then null is returned. getLocalCertificates() Returns the certificate(s) that were sent to the peer during handshaking.
public Principal	Returns: the principal sent to the peer. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. If no principal was sent, then null is returned. getLocalPrincipal() Returns the principal that was sent to the peer during handshaking.
public int	Returns: the current maximum expected network packet size getPacketBufferSize() Gets the current size of the largest SSL/TLS/DTLS packet that is expected when using this session.
public default X509Certificate[]	Returns: an ordered array of peer X.509 certificates, with the peer's own certificate first followed by any certificate authorities. (The certificates are in the original JSSE certificate `javax.security.cert.X509Certificate` format.) getPeerCertificateChain() Deprecated for removal since 9. The `getPeerCertificates()` method that returns an array of `java.security.cert.Certificate` should be used instead. Returns the identity of the peer which was identified as part of defining the session.
public Certificate[]	Returns: an ordered array of peer certificates, with the peer's own certificate first followed by any certificate authorities. getPeerCertificates() Returns the identity of the peer which was established as part of defining the session.
public String	Returns: the host name of the peer host, or null if no information is available. getPeerHost() Returns the host name of the peer in this session.
public int	Returns: the port number of the peer host, or -1 if no information is available. getPeerPort() Returns the port number of the peer in this session.
public Principal	Returns: the peer's principal. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. getPeerPrincipal() Returns the identity of the peer which was established as part of defining the session.
public String	Returns: the standard name of the protocol used for all connections in the session. getProtocol() Returns the standard name of the protocol used for all connections in the session.
public SSLSessionContext	Returns: the session context used for this session, or null if the context is unavailable. getSessionContext() Returns the context in which this session is bound.
public Object	Returns: the value bound to that name, or null if the binding does not exist. getValue(String the name of the binding to find. name) Returns the object bound to the given name in the session's application layer data.
public String[]	Returns: a non-null (possibly empty) array of names of the objects bound to this Session. getValueNames() Returns an array of the names of all the application layer data objects bound into the Session.
public void	invalidate() Invalidates the session.
public boolean	Returns: true if this session may be rejoined. isValid() Returns whether this session is valid and available for resuming or joining.
public void	putValue(String the name to which the data object will be bound. This may not be null. name, Object the data object to be bound. This may not be null. value) Binds the specified `value` object into the session's application layer data with the given `name`.
public void	removeValue(String the name of the object to remove name) Removes the object bound to the given name in the session's application layer data.

Method Detail

getApplicationBufferSize back to summary

getApplicationBufferSize	back to summary
public int getApplicationBufferSize() Gets the current size of the largest application data that is expected when using this session. `SSLEngine` application data buffers must be large enough to hold the application data from any inbound network application data packet received. Typically, outbound application data buffers can be of any size. Returns:int the current maximum expected application packet size Since 1.5 See Also `SSLEngine#wrap(ByteBuffer, ByteBuffer)`, `SSLEngine#unwrap(ByteBuffer, ByteBuffer)`

public int getApplicationBufferSize()

Gets the current size of the largest application data that is expected when using this session.

SSLEngine application data buffers must be large enough to hold the application data from any inbound network application data packet received. Typically, outbound application data buffers can be of any size.

Returns:int: the current maximum expected application packet size
Since: 1.5
See Also: SSLEngine#wrap(ByteBuffer, ByteBuffer), SSLEngine#unwrap(ByteBuffer, ByteBuffer)

getCipherSuite	back to summary
public String getCipherSuite() Returns the name of the SSL cipher suite which is used for all connections in the session. This defines the level of protection provided to the data sent on the connection, including the kind of encryption used and most aspects of how authentication is done. Returns:String the name of the session's cipher suite

getCipherSuite

back to summary

public String getCipherSuite()

Returns the name of the SSL cipher suite which is used for all connections in the session.

This defines the level of protection provided to the data sent on the connection, including the kind of encryption used and most aspects of how authentication is done.

Returns:String: the name of the session's cipher suite

getCreationTime	back to summary
public long getCreationTime() Returns the time at which this Session representation was created, in milliseconds since midnight, January 1, 1970 UTC. Returns:long the time this Session was created

getCreationTime

back to summary

public long getCreationTime()

Returns the time at which this Session representation was created, in milliseconds since midnight, January 1, 1970 UTC.

Returns:long: the time this Session was created

getId	back to summary
public byte[] getId() Returns the identifier assigned to this Session. Returns:byte[] the Session identifier

getId

back to summary

public byte[] getId()

Returns the identifier assigned to this Session.

Returns:byte[]: the Session identifier

getLastAccessedTime	back to summary
public long getLastAccessedTime() Returns the last time this Session representation was accessed by the session level infrastructure, in milliseconds since midnight, January 1, 1970 UTC. Access indicates a new connection being established using session data. Application level operations, such as getting or setting a value associated with the session, are not reflected in this access time. This information is particularly useful in session management policies. For example, a session manager thread could leave all sessions in a given context which haven't been used in a long time; or, the sessions might be sorted according to age to optimize some task. Returns:long the last time this Session was accessed

getLastAccessedTime

back to summary

public long getLastAccessedTime()

Returns the last time this Session representation was accessed by the session level infrastructure, in milliseconds since midnight, January 1, 1970 UTC.

Access indicates a new connection being established using session data. Application level operations, such as getting or setting a value associated with the session, are not reflected in this access time.

This information is particularly useful in session management policies. For example, a session manager thread could leave all sessions in a given context which haven't been used in a long time; or, the sessions might be sorted according to age to optimize some task.

Returns:long: the last time this Session was accessed

getLocalCertificates back to summary

getLocalCertificates	back to summary
public Certificate[] getLocalCertificates() Returns the certificate(s) that were sent to the peer during handshaking. Note This method is useful only when using certificate-based cipher suites. When multiple certificates are available for use in a handshake, the implementation chooses what it considers the "best" certificate chain available, and transmits that to the other side. This method allows the caller to know which certificate chain was actually used. Returns:Certificate[] an ordered array of certificates, with the local certificate first followed by any certificate authorities. If no certificates were sent, then null is returned. See Also `getLocalPrincipal()`

public Certificate[] getLocalCertificates()

Returns the certificate(s) that were sent to the peer during handshaking.

Note

This method is useful only when using certificate-based cipher suites.

When multiple certificates are available for use in a handshake, the implementation chooses what it considers the "best" certificate chain available, and transmits that to the other side. This method allows the caller to know which certificate chain was actually used.

Returns:Certificate[]: an ordered array of certificates, with the local certificate first followed by any certificate authorities. If no certificates were sent, then null is returned.
See Also: getLocalPrincipal()

getLocalPrincipal back to summary

getLocalPrincipal	back to summary
public Principal getLocalPrincipal() Returns the principal that was sent to the peer during handshaking. Returns:Principal the principal sent to the peer. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. If no principal was sent, then null is returned. Since 1.5 See Also `getLocalCertificates()`, `getPeerPrincipal()`

public Principal getLocalPrincipal()

Returns the principal that was sent to the peer during handshaking.

Returns:Principal: the principal sent to the peer. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. If no principal was sent, then null is returned.
Since: 1.5
See Also: getLocalCertificates(), getPeerPrincipal()

getPacketBufferSize back to summary

getPacketBufferSize	back to summary
public int getPacketBufferSize() Gets the current size of the largest SSL/TLS/DTLS packet that is expected when using this session. An `SSLEngine` using this session may generate SSL/TLS/DTLS packets of any size up to and including the value returned by this method. All `SSLEngine` network buffers should be sized at least this large to avoid insufficient space problems when performing `wrap` and `unwrap` calls. Returns:int the current maximum expected network packet size Since 1.5 See Also `SSLEngine#wrap(ByteBuffer, ByteBuffer)`, `SSLEngine#unwrap(ByteBuffer, ByteBuffer)`

public int getPacketBufferSize()

Gets the current size of the largest SSL/TLS/DTLS packet that is expected when using this session.

An SSLEngine using this session may generate SSL/TLS/DTLS packets of any size up to and including the value returned by this method. All SSLEngine network buffers should be sized at least this large to avoid insufficient space problems when performing wrap and unwrap calls.

Returns:int: the current maximum expected network packet size
Since: 1.5
See Also: SSLEngine#wrap(ByteBuffer, ByteBuffer), SSLEngine#unwrap(ByteBuffer, ByteBuffer)

getPeerCertificateChain back to summary

getPeerCertificateChain	back to summary
public default X509Certificate[] getPeerCertificateChain() throws SSLPeerUnverifiedException Deprecated for removal since 9. The `getPeerCertificates()` method that returns an array of `java.security.cert.Certificate` should be used instead. Returns the identity of the peer which was identified as part of defining the session. 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. Note The returned value may not be a valid certificate chain and should not be relied on for trust decisions. Note this method exists for compatibility with previous releases. New applications should use `getPeerCertificates` instead. Implementation Specification This default implementation throws UnsupportedOperationException. Returns:X509Certificate[] an ordered array of peer X.509 certificates, with the peer's own certificate first followed by any certificate authorities. (The certificates are in the original JSSE certificate `javax.security.cert.X509Certificate` format.) Annotations @SuppressWarnings:removal @Deprecated since:9 forRemoval:true Exceptions SSLPeerUnverifiedException: if the peer's identity has not been verified. UnsupportedOperationException: if the underlying provider does not implement the operation. See Also `getPeerPrincipal()`

public default X509Certificate[] getPeerCertificateChain() throws SSLPeerUnverifiedException

Deprecated

for removal since 9.

The getPeerCertificates() method that returns an array of java.security.cert.Certificate should be used instead.

Returns the identity of the peer which was identified as part of defining the session.

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.

Note

The returned value may not be a valid certificate chain and should not be relied on for trust decisions.

Note

this method exists for compatibility with previous releases. New applications should use getPeerCertificates instead.

Implementation Specification

This default implementation throws UnsupportedOperationException.

Returns:X509Certificate[]

an ordered array of peer X.509 certificates, with the peer's own certificate first followed by any certificate authorities. (The certificates are in the original JSSE certificate javax.security.cert.X509Certificate format.)

Annotations

@SuppressWarnings:removal
@Deprecated
since:9
forRemoval:true

Exceptions

SSLPeerUnverifiedException:: if the peer's identity has not been verified.
UnsupportedOperationException:: if the underlying provider does not implement the operation.

See Also

getPeerPrincipal()

getPeerCertificates back to summary

getPeerCertificates	back to summary
public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException Returns the identity of the peer which was established as part of defining the session. 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. Note The returned value may not be a valid certificate chain and should not be relied on for trust decisions. Returns:Certificate[] an ordered array of peer certificates, with the peer's own certificate first followed by any certificate authorities. Exceptions SSLPeerUnverifiedException: if the peer's identity has not been verified See Also `getPeerPrincipal()`

public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException

Returns the identity of the peer which was established as part of defining the session.

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.

Note

The returned value may not be a valid certificate chain and should not be relied on for trust decisions.

Returns:Certificate[]

an ordered array of peer certificates, with the peer's own certificate first followed by any certificate authorities.

Exceptions

SSLPeerUnverifiedException:: if the peer's identity has not been verified

See Also

getPeerPrincipal()

getPeerHost back to summary

getPeerHost	back to summary
public String getPeerHost() Returns the host name of the peer in this session. For the server, this is the client's host; and for the client, it is the server's host. The name may not be a fully qualified host name or even a host name at all as it may represent a string encoding of the peer's network address. If such a name is desired, it might be resolved through a name service based on the value returned by this method. This value is not authenticated and should not be relied upon. It is mainly used as a hint for `SSLSession` caching strategies. Returns:String the host name of the peer host, or null if no information is available.

public String getPeerHost()

Returns the host name of the peer in this session.

For the server, this is the client's host; and for the client, it is the server's host. The name may not be a fully qualified host name or even a host name at all as it may represent a string encoding of the peer's network address. If such a name is desired, it might be resolved through a name service based on the value returned by this method.

This value is not authenticated and should not be relied upon. It is mainly used as a hint for SSLSession caching strategies.

Returns:String: the host name of the peer host, or null if no information is available.

getPeerPort back to summary

getPeerPort	back to summary
public int getPeerPort() Returns the port number of the peer in this session. For the server, this is the client's port number; and for the client, it is the server's port number. This value is not authenticated and should not be relied upon. It is mainly used as a hint for `SSLSession` caching strategies. Returns:int the port number of the peer host, or -1 if no information is available. Since 1.5

public int getPeerPort()

Returns the port number of the peer in this session.

For the server, this is the client's port number; and for the client, it is the server's port number.

This value is not authenticated and should not be relied upon. It is mainly used as a hint for SSLSession caching strategies.

Returns:int: the port number of the peer host, or -1 if no information is available.
Since: 1.5

getPeerPrincipal back to summary

getPeerPrincipal	back to summary
public Principal getPeerPrincipal() throws SSLPeerUnverifiedException Returns the identity of the peer which was established as part of defining the session. Returns:Principal the peer's principal. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. Exceptions SSLPeerUnverifiedException: if the peer's identity has not been verified Since 1.5 See Also `getPeerCertificates()`, `getLocalPrincipal()`

public Principal getPeerPrincipal() throws SSLPeerUnverifiedException

Returns the identity of the peer which was established as part of defining the session.

Returns:Principal

the peer's principal. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites.

Exceptions

SSLPeerUnverifiedException:: if the peer's identity has not been verified

Since

1.5

getProtocol	back to summary
public String getProtocol() Returns the standard name of the protocol used for all connections in the session. This defines the protocol used in the connection. Returns:String the standard name of the protocol used for all connections in the session.

getProtocol

back to summary

public String getProtocol()

Returns the standard name of the protocol used for all connections in the session.

This defines the protocol used in the connection.

Returns:String: the standard name of the protocol used for all connections in the session.

getSessionContext	back to summary
public SSLSessionContext getSessionContext() Returns the context in which this session is bound. This context may be unavailable in some environments, in which case this method returns null. Returns:SSLSessionContext the session context used for this session, or null if the context is unavailable.

getSessionContext

back to summary

public SSLSessionContext getSessionContext()

Returns the context in which this session is bound.

This context may be unavailable in some environments, in which case this method returns null.

Returns:SSLSessionContext: the session context used for this session, or null if the context is unavailable.

getValue	back to summary
public Object getValue(String name) Returns the object bound to the given name in the session's application layer data. Returns null if there is no such binding. Parameters name:String the name of the binding to find. Returns:Object the value bound to that name, or null if the binding does not exist. Exceptions IllegalArgumentException: if the argument is null.

getValue

back to summary

public Object getValue(String name)

Returns the object bound to the given name in the session's application layer data. Returns null if there is no such binding.

Parameters

name:String: the name of the binding to find.

Returns:Object

the value bound to that name, or null if the binding does not exist.

Exceptions

IllegalArgumentException:: if the argument is null.

getValueNames	back to summary
public String[] getValueNames() Returns an array of the names of all the application layer data objects bound into the Session. Returns:String[] a non-null (possibly empty) array of names of the objects bound to this Session.

getValueNames

back to summary

public String[] getValueNames()

Returns an array of the names of all the application layer data objects bound into the Session.

Returns:String[]: a non-null (possibly empty) array of names of the objects bound to this Session.

invalidate back to summary

invalidate	back to summary
public void invalidate() Invalidates the session. Future connections will not be able to resume or join this session. However, any existing connection using this session can continue to use the session until the connection is closed. See Also `isValid()`

public void invalidate()

Invalidates the session.

Future connections will not be able to resume or join this session. However, any existing connection using this session can continue to use the session until the connection is closed.

See Also: isValid()

isValid back to summary

isValid	back to summary
public boolean isValid() Returns whether this session is valid and available for resuming or joining. Returns:boolean true if this session may be rejoined. Since 1.5 See Also `invalidate()`

public boolean isValid()

Returns whether this session is valid and available for resuming or joining.

Returns:boolean: true if this session may be rejoined.
Since: 1.5
See Also: invalidate()

putValue back to summary

putValue	back to summary
public void putValue(String name, Object value) Binds the specified `value` object into the session's application layer data with the given `name`. Any existing binding using the same `name` is replaced. If the new (or existing) `value` implements the `SSLSessionBindingListener` interface, the object represented by `value` is notified appropriately. Parameters name:String the name to which the data object will be bound. This may not be null. value:Object the data object to be bound. This may not be null. Exceptions IllegalArgumentException: if either argument is null.

public void putValue(String name, Object value)

Binds the specified value object into the session's application layer data with the given name.

Any existing binding using the same name is replaced. If the new (or existing) value implements the SSLSessionBindingListener interface, the object represented by value is notified appropriately.

Parameters

name:String: the name to which the data object will be bound. This may not be null.
value:Object: the data object to be bound. This may not be null.

Exceptions

IllegalArgumentException:: if either argument is null.

removeValue back to summary

removeValue	back to summary
public void removeValue(String name) Removes the object bound to the given name in the session's application layer data. Does nothing if there is no object bound to the given name. If the bound existing object implements the `SSLSessionBindingListener` interface, it is notified appropriately. Parameters name:String the name of the object to remove Exceptions IllegalArgumentException: if the argument is null.

public void removeValue(String name)

Removes the object bound to the given name in the session's application layer data. Does nothing if there is no object bound to the given name. If the bound existing object implements the SSLSessionBindingListener interface, it is notified appropriately.

Parameters

name:String: the name of the object to remove

Exceptions

IllegalArgumentException:: if the argument is null.

public Interface SSLSession

Method Summary

Method Detail