Package org.glassfish.grizzly.ssl

Interface SSLSupport

All Known Implementing Classes:

SSLSupportImpl

public interface SSLSupport

SSLSupport Interface for SSL-specific functions

Author:

EKR

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SSLSupport.CipherData	Simple data class that represents the cipher being used, along with the corresponding effective key size.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CERTIFICATE_KEY	The Request attribute key for the client certificate chain.
static String	CIPHER_SUITE_KEY	The Request attribute key for the cipher suite.
static String	KEY_SIZE_KEY	The Request attribute key for the key size.
static String	SESSION_ID_KEY	The Request attribute key for the session id.

Method Summary

Modifier and Type	Method	Description
String	getCipherSuite()	The cipher suite being used on this connection.
Integer	getKeySize()	Get the keysize.
default Object[]	getPeerCertificateChain()	Deprecated, for removal: This API element is subject to removal in a future version. use getPeerCertificates() instead.
default Object[]	getPeerCertificateChain(boolean force)	Deprecated, for removal: This API element is subject to removal in a future version. use getPeerCertificates(boolean) instead.
Certificate[]	getPeerCertificates()
Certificate[]	getPeerCertificates(boolean force)
String	getSessionId()	The current session Id.

Field Detail

CIPHER_SUITE_KEY

static final String CIPHER_SUITE_KEY

The Request attribute key for the cipher suite.

See Also:

Constant Field Values

KEY_SIZE_KEY

static final String KEY_SIZE_KEY

The Request attribute key for the key size.

See Also:

Constant Field Values

CERTIFICATE_KEY

static final String CERTIFICATE_KEY

The Request attribute key for the client certificate chain.

See Also:

Constant Field Values

SESSION_ID_KEY

static final String SESSION_ID_KEY

The Request attribute key for the session id. This one is a Tomcat extension to the Servlet spec.

See Also:

Constant Field Values

Method Detail

getCipherSuite

String getCipherSuite()
               throws IOException

The cipher suite being used on this connection.

Throws:

IOException

getPeerCertificateChain

@Deprecated(forRemoval=true)
default Object[] getPeerCertificateChain()
                                  throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use getPeerCertificates() instead.

Returns:

The client certificate chain (if any).

Throws:

IOException

getPeerCertificates

Certificate[] getPeerCertificates()
                           throws IOException

Returns:

The client certificate chain (if any).

Throws:

IOException

getPeerCertificateChain

@Deprecated(forRemoval=true)
default Object[] getPeerCertificateChain(boolean force)
                                  throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use getPeerCertificates(boolean) instead.

Parameters:

force - If true, then re-negotiate the connection if necessary.

Returns:

The client certificate chain (if any).

Throws:

IOException

getPeerCertificates

Certificate[] getPeerCertificates(boolean force)
                           throws IOException

Parameters:

force - If true, then re-negotiate the connection if necessary.

Returns:

The client certificate chain (if any).

Throws:

IOException

getKeySize

Integer getKeySize()
            throws IOException

Get the keysize. What we're supposed to put here is ill-defined by the Servlet spec (S 4.7 again). There are at least 4 potential values that might go here: (a) The size of the encryption key (b) The size of the MAC key (c) The size of the key-exchange key (d) The size of the signature key used by the server Unfortunately, all of these values are nonsensical.

Throws:

IOException

getSessionId

String getSessionId()
             throws IOException

The current session Id.

Throws:

IOException