org.opends.server.admin.std.client
Interface KeyManagerProviderCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
FileBasedKeyManagerProviderCfgClient, PKCS11KeyManagerProviderCfgClient

public interface KeyManagerProviderCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Key Manager Provider settings.

Key Manager Providers are responsible for managing the key material that is used to authenticate an SSL connection to its peer.


Method Summary
 ManagedObjectDefinition<? extends KeyManagerProviderCfgClient,? extends KeyManagerProviderCfg> definition()
          Get the configuration definition associated with this Key Manager Provider.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends KeyManagerProviderCfgClient,? extends KeyManagerProviderCfg> definition()
Get the configuration definition associated with this Key Manager Provider.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Key Manager Provider.

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Key Manager Provider is enabled for use.

Returns:
Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the Key Manager Provider is enabled for use.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

The fully-qualified name of the Java class that provides the Key Manager Provider implementation.

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

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

The fully-qualified name of the Java class that provides the Key Manager Provider implementation.

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.