Top Description Inners Fields Methods
org.glassfish.grizzly.ssl

public Interface SSLSupport

Known Direct Implementers
org.glassfish.grizzly.ssl.SSLSupportImpl
Imports
java.io.IOException, java.security.cert.Certificate

SSLSupport Interface for SSL-specific functions
Author
EKR

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
SSLSupport.CipherData

Simple data class that represents the cipher being used, along with the corresponding effective key size.

Field Summary

Modifier and TypeField and Description
public static final String
CERTIFICATE_KEY

The Request attribute key for the client certificate chain.

public static final String
CIPHER_SUITE_KEY

The Request attribute key for the cipher suite.

public static final String
KEY_SIZE_KEY

The Request attribute key for the key size.

public static final String
SESSION_ID_KEY

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

Method Summary

Modifier and TypeMethod and Description
public String
getCipherSuite()

The cipher suite being used on this connection.

public Integer
getKeySize()

Get the keysize.

public default Object[]
getPeerCertificateChain()
Deprecated for removal. use getPeerCertificates() instead.

Returns: The client certificate chain (if any).

public default Object[]
getPeerCertificateChain(boolean
If true, then re-negotiate the connection if necessary.
force
)
Deprecated for removal. use getPeerCertificates(boolean) instead.

Returns: The client certificate chain (if any).

public Certificate[]
getPeerCertificates()

Returns: The client certificate chain (if any).

public Certificate[]
getPeerCertificates(boolean
If true, then re-negotiate the connection if necessary.
force
)

Returns: The client certificate chain (if any).

public String
getSessionId()

The current session Id.

Field Detail

CERTIFICATE_KEYback to summary
public static final String CERTIFICATE_KEY

The Request attribute key for the client certificate chain.

CIPHER_SUITE_KEYback to summary
public static final String CIPHER_SUITE_KEY

The Request attribute key for the cipher suite.

KEY_SIZE_KEYback to summary
public static final String KEY_SIZE_KEY

The Request attribute key for the key size.

SESSION_ID_KEYback to summary
public static final String SESSION_ID_KEY

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

Method Detail

getCipherSuiteback to summary
public String getCipherSuite() throws IOException

The cipher suite being used on this connection.

getKeySizeback to summary
public 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.

getPeerCertificateChainback to summary
public default Object[] getPeerCertificateChain() throws IOException

Deprecated

for removal.

use getPeerCertificates() instead.

Returns:Object[]

The client certificate chain (if any).

Annotations
@Deprecated
forRemoval:true
getPeerCertificateChainback to summary
public default Object[] getPeerCertificateChain(boolean force) throws IOException

Deprecated

for removal.

use getPeerCertificates(boolean) instead.

Parameters
force:boolean

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

Returns:Object[]

The client certificate chain (if any).

Annotations
@Deprecated
forRemoval:true
getPeerCertificatesback to summary
public Certificate[] getPeerCertificates() throws IOException
Returns:Certificate[]

The client certificate chain (if any).

getPeerCertificatesback to summary
public Certificate[] getPeerCertificates(boolean force) throws IOException
Parameters
force:boolean

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

Returns:Certificate[]

The client certificate chain (if any).

getSessionIdback to summary
public String getSessionId() throws IOException

The current session Id.

org.glassfish.grizzly.ssl back to summary

public final Class SSLSupport.CipherData

extends Object
Class Inheritance

Simple data class that represents the cipher being used, along with the corresponding effective key size. The specified phrase must appear in the name of the cipher suite to be recognized.

Field Summary

Modifier and TypeField and Description
public int
public String

Constructor Summary

AccessConstructor and Description
public
CipherData(String phrase, int keySize)

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

keySizeback to summary
public int keySize
phraseback to summary
public String phrase

Constructor Detail

CipherDataback to summary
public CipherData(String phrase, int keySize)