Package org.forgerock.opendj.server.config.client

Interface StartTlsExtendedOperationHandlerCfgClient

All Superinterfaces:

ConfigurationClient, ExtendedOperationHandlerCfgClient

public interface StartTlsExtendedOperationHandlerCfgClient
extends ExtendedOperationHandlerCfgClient

A client-side interface for reading and modifying StartTLS Extended Operation Handler settings.

The StartTLS Extended Operation Handler provides the ability clients to use the StartTLS extended operation to initiate a secure communication channel over an otherwise clear-text LDAP connection.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends StartTlsExtendedOperationHandlerCfgClient,? extends StartTlsExtendedOperationHandlerCfg>	definition()	Get the configuration definition associated with this StartTLS Extended Operation Handler.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.ExtendedOperationHandlerCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends StartTlsExtendedOperationHandlerCfgClient,? extends StartTlsExtendedOperationHandlerCfg> definition()

Get the configuration definition associated with this StartTLS Extended Operation Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ExtendedOperationHandlerCfgClient

Returns:

Returns the configuration definition associated with this StartTLS Extended Operation Handler.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the StartTLS Extended Operation Handler implementation.

Default value: org.opends.server.extensions.StartTLSExtendedOperation

Specified by:

getJavaClass in interface ExtendedOperationHandlerCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the StartTLS Extended Operation Handler implementation.

Specified by:

setJavaClass in interface ExtendedOperationHandlerCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.