public interface StaticServiceDiscoveryMechanismCfgClient extends ServiceDiscoveryMechanismCfgClient
A Static Service Discovery Mechanism returns a fixed list of LDAP directory servers.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends StaticServiceDiscoveryMechanismCfgClient,? extends StaticServiceDiscoveryMechanismCfg> |
definition()
Get the configuration definition associated with this Static Service Discovery Mechanism.
|
ValueOrExpression<Long> |
getDiscoveryInterval()
Gets the "discovery-interval" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getKeyManagerProvider()
Gets the "key-manager-provider" property.
|
SortedSet<ValueOrExpression<String>> |
getPrimaryServer()
Gets the "primary-server" property.
|
SortedSet<ValueOrExpression<String>> |
getSecondaryServer()
Gets the "secondary-server" property.
|
SortedSet<ValueOrExpression<String>> |
getSslCertNickname()
Gets the "ssl-cert-nickname" property.
|
ValueOrExpression<String> |
getTrustManagerProvider()
Gets the "trust-manager-provider" property.
|
ValueOrExpression<Boolean> |
isUseSsl()
Gets the "use-ssl" property.
|
ValueOrExpression<Boolean> |
isUseStartTls()
Gets the "use-start-tls" property.
|
void |
setDiscoveryInterval(ValueOrExpression<Long> value)
Sets the "discovery-interval" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setKeyManagerProvider(ValueOrExpression<String> value)
Sets the "key-manager-provider" property.
|
void |
setPrimaryServer(Collection<ValueOrExpression<String>> values)
Sets the "primary-server" property.
|
void |
setSecondaryServer(Collection<ValueOrExpression<String>> values)
Sets the "secondary-server" property.
|
void |
setSslCertNickname(Collection<ValueOrExpression<String>> values)
Sets the "ssl-cert-nickname" property.
|
void |
setTrustManagerProvider(ValueOrExpression<String> value)
Sets the "trust-manager-provider" property.
|
void |
setUseSsl(ValueOrExpression<Boolean> value)
Sets the "use-ssl" property.
|
void |
setUseStartTls(ValueOrExpression<Boolean> value)
Sets the "use-start-tls" property.
|
commit, properties
ManagedObjectDefinition<? extends StaticServiceDiscoveryMechanismCfgClient,? extends StaticServiceDiscoveryMechanismCfg> definition()
definition
in interface ConfigurationClient
definition
in interface ServiceDiscoveryMechanismCfgClient
ValueOrExpression<Long> getDiscoveryInterval()
Interval between two server configuration discovery executions.
Specifies how frequently to read the configuration of the servers in order to discover their new information.
void setDiscoveryInterval(ValueOrExpression<Long> value) throws PropertyException
Interval between two server configuration discovery executions.
Specifies how frequently to read the configuration of the servers in order to discover their new information.
value
- The value of the "discovery-interval" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Static Service Discovery Mechanism implementation.
getJavaClass
in interface ServiceDiscoveryMechanismCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the Static Service Discovery Mechanism implementation.
setJavaClass
in interface ServiceDiscoveryMechanismCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getKeyManagerProvider()
Specifies the name of the key manager that should be used with this Static Service Discovery Mechanism.
void setKeyManagerProvider(ValueOrExpression<String> value) throws PropertyException
Specifies the name of the key manager that should be used with this Static Service Discovery Mechanism.
value
- The value of the "key-manager-provider" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getPrimaryServer()
Specifies a list of servers that will be used in preference to secondary servers when available.
void setPrimaryServer(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies a list of servers that will be used in preference to secondary servers when available.
values
- The values of the "primary-server" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getSecondaryServer()
Specifies a list of servers that will be used in place of primary servers when all primary servers are unavailable.
void setSecondaryServer(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies a list of servers that will be used in place of primary servers when all primary servers are unavailable.
values
- The values of the "secondary-server" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getSslCertNickname()
Specifies the nicknames (also called the aliases) of the keys or key pairs that the Static Service Discovery Mechanism should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.
This is only applicable when the Static Service Discovery Mechanism is configured to use SSL.
void setSslCertNickname(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies the nicknames (also called the aliases) of the keys or key pairs that the Static Service Discovery Mechanism should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.
This is only applicable when the Static Service Discovery Mechanism is configured to use SSL.
values
- The values of the "ssl-cert-nickname" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getTrustManagerProvider()
Specifies the name of the trust manager that should be used with the Static Service Discovery Mechanism.
void setTrustManagerProvider(ValueOrExpression<String> value) throws PropertyException
Specifies the name of the trust manager that should be used with the Static Service Discovery Mechanism.
value
- The value of the "trust-manager-provider" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isUseSsl()
Indicates whether the Static Service Discovery Mechanism should use SSL.
If enabled, the Static Service Discovery Mechanism will use SSL to encrypt communication with the clients.
void setUseSsl(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the Static Service Discovery Mechanism should use SSL.
If enabled, the Static Service Discovery Mechanism will use SSL to encrypt communication with the clients.
value
- The value of the "use-ssl" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isUseStartTls()
Indicates whether the Static Service Discovery Mechanism should use Start TLS.
If enabled, the Static Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.
void setUseStartTls(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the Static Service Discovery Mechanism should use Start TLS.
If enabled, the Static Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.
value
- The value of the "use-start-tls" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.