Package io.netty.handler.ssl

Class SslContextOption<T>

java.lang.Object

io.netty.util.AbstractConstant<SslContextOption<T>>

io.netty.handler.ssl.SslContextOption<T>

Type Parameters:

T - the type of the value which is valid for the SslContextOption

All Implemented Interfaces:

Constant<SslContextOption<T>>, java.lang.Comparable<SslContextOption<T>>

Direct Known Subclasses:

OpenSslContextOption

public class SslContextOption<T>
extends AbstractConstant<SslContextOption<T>>

A SslContextOption allows to configure a SslContext in a type-safe way. Which SslContextOption is supported depends on the actual implementation of SslContext and may depend on the nature of the SSL implementation it belongs to.

Field Summary

Fields

Modifier and Type	Field	Description
private static ConstantPool<SslContextOption<java.lang.Object>>	pool

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SslContextOption(int id, java.lang.String name)	Creates a new SslContextOption with the specified unique name.
protected	SslContextOption(java.lang.String name)	Should be used by sub-classes.

Method Summary

Modifier and Type	Method	Description
static boolean	exists(java.lang.String name)	Returns true if a SslContextOption exists for the given name.
void	validate(T value)	Validate the value which is set for the SslContextOption.
static <T> SslContextOption<T>	valueOf(java.lang.Class<?> firstNameComponent, java.lang.String secondNameComponent)	Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).
static <T> SslContextOption<T>	valueOf(java.lang.String name)	Returns the SslContextOption of the specified name.

Methods inherited from class io.netty.util.AbstractConstant

compareTo, equals, hashCode, id, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

pool

private static final ConstantPool<SslContextOption<java.lang.Object>> pool

Constructor Detail

SslContextOption

private SslContextOption(int id,
                         java.lang.String name)

Creates a new SslContextOption with the specified unique name.

SslContextOption

protected SslContextOption(java.lang.String name)

Should be used by sub-classes.

Parameters:

name - the name of the option

Method Detail

valueOf

public static <T> SslContextOption<T> valueOf(java.lang.String name)

Returns the SslContextOption of the specified name.

valueOf

public static <T> SslContextOption<T> valueOf(java.lang.Class<?> firstNameComponent,
                                              java.lang.String secondNameComponent)

Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).

exists

public static boolean exists(java.lang.String name)

Returns true if a SslContextOption exists for the given name.

validate

public void validate(T value)

Validate the value which is set for the SslContextOption. Sub-classes may override this for special checks.