SSLSession

getApplicationBufferSize

public abstract 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.

getCipherSuite

public abstract 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.

getCreationTime

public abstract long getCreationTime ()

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

getId

public abstract byte[] getId ()

Returns the identifier assigned to this Session.

getLastAccessedTime

public abstract 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.

getLocalCertificates

public abstract 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.

getLocalPrincipal

public abstract Principal getLocalPrincipal ()

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

getPacketBufferSize

public abstract int getPacketBufferSize ()

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

A SSLEngine using this session may generate SSL/TLS 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.

getPeerCertificateChain

public abstract X509Certificate[] getPeerCertificateChain ()

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: this method exists for compatibility with previous releases. New applications should use getPeerCertificates() instead.

getPeerCertificates

public abstract Certificate[] getPeerCertificates ()

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.

getPeerHost

public abstract 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.

getPeerPort

public abstract 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.

getPeerPrincipal

public abstract Principal getPeerPrincipal ()

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

getProtocol

public abstract String getProtocol ()

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

This defines the protocol used in the connection.

getSessionContext

public abstract 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.

If the context is available and there is a security manager installed, the caller may require permission to access it or a security exception may be thrown. In a Java environment, the security manager's checkPermission method is called with a SSLPermission("getSSLSessionContext") permission.

getValue

public abstract 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.

For security reasons, the same named values may not be visible across different access control contexts.

getValueNames

public abstract String[] getValueNames ()

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

For security reasons, the same named values may not be visible across different access control contexts.

invalidate

public abstract 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.

isValid

public abstract boolean isValid ()

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

putValue

public abstract 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.

For security reasons, the same named values may not be visible across different access control contexts.

removeValue

public abstract 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 SessionBindingListener interface, it is notified appropriately.

For security reasons, the same named values may not be visible across different access control contexts.