|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CryptoManagerCfgClient
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 |
---|
ManagedObjectDefinition<? extends CryptoManagerCfgClient,? extends CryptoManagerCfg> definition()
definition
in interface ConfigurationClient
int getCipherKeyLength()
Specifies the key length in bits for the preferred cipher.
void setCipherKeyLength(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the key length in bits for the preferred cipher.
value
- The value of the "cipher-key-length" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getCipherTransformation()
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.
void setCipherTransformation(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "cipher-transformation" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getDigestAlgorithm()
Specifies the preferred message digest algorithm for the Directory Server.
void setDigestAlgorithm(java.lang.String value) throws IllegalPropertyValueException
Specifies the preferred message digest algorithm for the Directory Server.
value
- The value of the "digest-algorithm" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getKeyWrappingTransformation()
The preferred key wrapping transformation for the Directory Server. This value must be the same for all server instances in a replication topology.
void setKeyWrappingTransformation(java.lang.String value) throws IllegalPropertyValueException
The preferred key wrapping transformation for the Directory Server. This value must be the same for all server instances in a replication topology.
value
- The value of the "key-wrapping-transformation" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getMacAlgorithm()
Specifies the preferred MAC algorithm for the Directory Server.
void setMacAlgorithm(java.lang.String value) throws IllegalPropertyValueException
Specifies the preferred MAC algorithm for the Directory Server.
value
- The value of the "mac-algorithm" property.
IllegalPropertyValueException
- If the new value is invalid.int getMacKeyLength()
Specifies the key length in bits for the preferred MAC algorithm.
void setMacKeyLength(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the key length in bits for the preferred MAC algorithm.
value
- The value of the "mac-key-length" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getSSLCertNickname()
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.
void setSSLCertNickname(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "ssl-cert-nickname" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.String> getSSLCipherSuite()
Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.
void setSSLCipherSuite(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.
values
- The values of the "ssl-cipher-suite" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.boolean isSSLEncryption()
Specifies whether SSL/TLS is used to provide encrypted communication between two OpenDS server components.
void setSSLEncryption(java.lang.Boolean value) throws IllegalPropertyValueException
Specifies whether SSL/TLS is used to provide encrypted communication between two OpenDS server components.
value
- The value of the "ssl-encryption" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.String> getSSLProtocol()
Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.
void setSSLProtocol(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.
values
- The values of the "ssl-protocol" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |