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

All Superinterfaces:
ConfigurationClient

public interface CryptoManagerCfgClient
extends ConfigurationClient

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

The Crypto Manager provides a common interface for performing compression, decompression, hashing, encryption and other kinds of cryptographic operations.


Method Summary
 ManagedObjectDefinition<? extends CryptoManagerCfgClient,? extends CryptoManagerCfg> definition()
          Get the configuration definition associated with this Crypto Manager.
 int getCipherKeyLength()
          Gets the "cipher-key-length" property.
 java.lang.String getCipherTransformation()
          Gets the "cipher-transformation" property.
 java.lang.String getDigestAlgorithm()
          Gets the "digest-algorithm" property.
 java.lang.String getKeyWrappingTransformation()
          Gets the "key-wrapping-transformation" property.
 java.lang.String getMacAlgorithm()
          Gets the "mac-algorithm" property.
 int getMacKeyLength()
          Gets the "mac-key-length" property.
 java.lang.String getSSLCertNickname()
          Gets the "ssl-cert-nickname" property.
 java.util.SortedSet<java.lang.String> getSSLCipherSuite()
          Gets the "ssl-cipher-suite" property.
 java.util.SortedSet<java.lang.String> getSSLProtocol()
          Gets the "ssl-protocol" property.
 boolean isSSLEncryption()
          Gets the "ssl-encryption" property.
 void setCipherKeyLength(java.lang.Integer value)
          Sets the "cipher-key-length" property.
 void setCipherTransformation(java.lang.String value)
          Sets the "cipher-transformation" property.
 void setDigestAlgorithm(java.lang.String value)
          Sets the "digest-algorithm" property.
 void setKeyWrappingTransformation(java.lang.String value)
          Sets the "key-wrapping-transformation" property.
 void setMacAlgorithm(java.lang.String value)
          Sets the "mac-algorithm" property.
 void setMacKeyLength(java.lang.Integer value)
          Sets the "mac-key-length" property.
 void setSSLCertNickname(java.lang.String value)
          Sets the "ssl-cert-nickname" property.
 void setSSLCipherSuite(java.util.Collection<java.lang.String> values)
          Sets the "ssl-cipher-suite" property.
 void setSSLEncryption(java.lang.Boolean value)
          Sets the "ssl-encryption" property.
 void setSSLProtocol(java.util.Collection<java.lang.String> values)
          Sets the "ssl-protocol" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends CryptoManagerCfgClient,? extends CryptoManagerCfg> definition()
Get the configuration definition associated with this Crypto Manager.

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

getCipherKeyLength

int getCipherKeyLength()
Gets the "cipher-key-length" property.

Specifies the key length in bits for the preferred cipher.

Returns:
Returns the value of the "cipher-key-length" property.

setCipherKeyLength

void setCipherKeyLength(java.lang.Integer value)
                        throws IllegalPropertyValueException
Sets the "cipher-key-length" property.

Specifies the key length in bits for the preferred cipher.

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

getCipherTransformation

java.lang.String getCipherTransformation()
Gets the "cipher-transformation" property.

Specifies the cipher for the Directory Server using the syntax algorithm/mode/padding.

The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.

Returns:
Returns the value of the "cipher-transformation" property.

setCipherTransformation

void setCipherTransformation(java.lang.String value)
                             throws IllegalPropertyValueException
Sets the "cipher-transformation" property.

Specifies the cipher for the Directory Server using the syntax algorithm/mode/padding.

The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.

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

getDigestAlgorithm

java.lang.String getDigestAlgorithm()
Gets the "digest-algorithm" property.

Specifies the preferred message digest algorithm for the Directory Server.

Returns:
Returns the value of the "digest-algorithm" property.

setDigestAlgorithm

void setDigestAlgorithm(java.lang.String value)
                        throws IllegalPropertyValueException
Sets the "digest-algorithm" property.

Specifies the preferred message digest algorithm for the Directory Server.

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

getKeyWrappingTransformation

java.lang.String getKeyWrappingTransformation()
Gets the "key-wrapping-transformation" property.

The preferred key wrapping transformation for the Directory Server. This value must be the same for all server instances in a replication topology.

Returns:
Returns the value of the "key-wrapping-transformation" property.

setKeyWrappingTransformation

void setKeyWrappingTransformation(java.lang.String value)
                                  throws IllegalPropertyValueException
Sets the "key-wrapping-transformation" property.

The preferred key wrapping transformation for the Directory Server. This value must be the same for all server instances in a replication topology.

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

getMacAlgorithm

java.lang.String getMacAlgorithm()
Gets the "mac-algorithm" property.

Specifies the preferred MAC algorithm for the Directory Server.

Returns:
Returns the value of the "mac-algorithm" property.

setMacAlgorithm

void setMacAlgorithm(java.lang.String value)
                     throws IllegalPropertyValueException
Sets the "mac-algorithm" property.

Specifies the preferred MAC algorithm for the Directory Server.

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

getMacKeyLength

int getMacKeyLength()
Gets the "mac-key-length" property.

Specifies the key length in bits for the preferred MAC algorithm.

Returns:
Returns the value of the "mac-key-length" property.

setMacKeyLength

void setMacKeyLength(java.lang.Integer value)
                     throws IllegalPropertyValueException
Sets the "mac-key-length" property.

Specifies the key length in bits for the preferred MAC algorithm.

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

getSSLCertNickname

java.lang.String getSSLCertNickname()
Gets the "ssl-cert-nickname" property.

Specifies the nickname (also called the alias) of the certificate that the Crypto Manager should use when performing SSL communication.

This is only applicable when the Crypto Manager is configured to use SSL.

Returns:
Returns the value of the "ssl-cert-nickname" property.

setSSLCertNickname

void setSSLCertNickname(java.lang.String value)
                        throws IllegalPropertyValueException
Sets the "ssl-cert-nickname" property.

Specifies the nickname (also called the alias) of the certificate that the Crypto Manager should use when performing SSL communication.

This is only applicable when the Crypto Manager is configured to use SSL.

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

getSSLCipherSuite

java.util.SortedSet<java.lang.String> getSSLCipherSuite()
Gets the "ssl-cipher-suite" property.

Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

Returns:
Returns the values of the "ssl-cipher-suite" property.

setSSLCipherSuite

void setSSLCipherSuite(java.util.Collection<java.lang.String> values)
                       throws IllegalPropertyValueException
Sets the "ssl-cipher-suite" property.

Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

Parameters:
values - The values of the "ssl-cipher-suite" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

isSSLEncryption

boolean isSSLEncryption()
Gets the "ssl-encryption" property.

Specifies whether SSL/TLS is used to provide encrypted communication between two OpenDS server components.

Returns:
Returns the value of the "ssl-encryption" property.

setSSLEncryption

void setSSLEncryption(java.lang.Boolean value)
                      throws IllegalPropertyValueException
Sets the "ssl-encryption" property.

Specifies whether SSL/TLS is used to provide encrypted communication between two OpenDS server components.

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

getSSLProtocol

java.util.SortedSet<java.lang.String> getSSLProtocol()
Gets the "ssl-protocol" property.

Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

Returns:
Returns the values of the "ssl-protocol" property.

setSSLProtocol

void setSSLProtocol(java.util.Collection<java.lang.String> values)
                    throws IllegalPropertyValueException
Sets the "ssl-protocol" property.

Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

Parameters:
values - The values of the "ssl-protocol" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.