public interface GssapiSaslMechanismHandlerCfgClient extends SaslMechanismHandlerCfgClient
The GSSAPI SASL mechanism performs all processing related to SASL GSSAPI authentication using Kerberos V5.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends GssapiSaslMechanismHandlerCfgClient,? extends GssapiSaslMechanismHandlerCfg> |
definition()
Get the configuration definition associated with this GSSAPI SASL Mechanism Handler.
|
ValueOrExpression<String> |
getIdentityMapper()
Gets the "identity-mapper" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getKdcAddress()
Gets the "kdc-address" property.
|
ValueOrExpression<String> |
getKeytab()
Gets the "keytab" property.
|
ValueOrExpression<String> |
getPrincipalName()
Gets the "principal-name" property.
|
ValueOrExpression<GssapiSaslMechanismHandlerCfgDefn.QualityOfProtection> |
getQualityOfProtection()
Gets the "quality-of-protection" property.
|
ValueOrExpression<String> |
getRealm()
Gets the "realm" property.
|
ValueOrExpression<String> |
getServerFqdn()
Gets the "server-fqdn" property.
|
void |
setIdentityMapper(ValueOrExpression<String> value)
Sets the "identity-mapper" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setKdcAddress(ValueOrExpression<String> value)
Sets the "kdc-address" property.
|
void |
setKeytab(ValueOrExpression<String> value)
Sets the "keytab" property.
|
void |
setPrincipalName(ValueOrExpression<String> value)
Sets the "principal-name" property.
|
void |
setQualityOfProtection(ValueOrExpression<GssapiSaslMechanismHandlerCfgDefn.QualityOfProtection> value)
Sets the "quality-of-protection" property.
|
void |
setRealm(ValueOrExpression<String> value)
Sets the "realm" property.
|
void |
setServerFqdn(ValueOrExpression<String> value)
Sets the "server-fqdn" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends GssapiSaslMechanismHandlerCfgClient,? extends GssapiSaslMechanismHandlerCfg> definition()
definition
in interface ConfigurationClient
definition
in interface SaslMechanismHandlerCfgClient
ValueOrExpression<String> getIdentityMapper()
Specifies the name of the identity mapper that is to be used with this SASL mechanism handler to match the Kerberos principal included in the SASL bind request to the corresponding user in the directory.
void setIdentityMapper(ValueOrExpression<String> value) throws PropertyException
Specifies the name of the identity mapper that is to be used with this SASL mechanism handler to match the Kerberos principal included in the SASL bind request to the corresponding user in the directory.
value
- The value of the "identity-mapper" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.
getJavaClass
in interface SaslMechanismHandlerCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.
setJavaClass
in interface SaslMechanismHandlerCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getKdcAddress()
Specifies the address of the KDC that is to be used for Kerberos processing.
If provided, this property must be a fully-qualified DNS-resolvable name. If this property is not provided, then the server attempts to determine it from the system-wide Kerberos configuration.
void setKdcAddress(ValueOrExpression<String> value) throws PropertyException
Specifies the address of the KDC that is to be used for Kerberos processing.
If provided, this property must be a fully-qualified DNS-resolvable name. If this property is not provided, then the server attempts to determine it from the system-wide Kerberos configuration.
value
- The value of the "kdc-address" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getKeytab()
Specifies the path to the keytab file that should be used for Kerberos processing.
If provided, this is either an absolute path or one that is relative to the server instance root.
void setKeytab(ValueOrExpression<String> value) throws PropertyException
Specifies the path to the keytab file that should be used for Kerberos processing.
If provided, this is either an absolute path or one that is relative to the server instance root.
value
- The value of the "keytab" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getPrincipalName()
Specifies the principal name.
It can either be a simple user name or a service name such as host/example.com. If this property is not provided, then the server attempts to build the principal name by appending the fully qualified domain name to the string "ldap/".
void setPrincipalName(ValueOrExpression<String> value) throws PropertyException
Specifies the principal name.
It can either be a simple user name or a service name such as host/example.com. If this property is not provided, then the server attempts to build the principal name by appending the fully qualified domain name to the string "ldap/".
value
- The value of the "principal-name" property.PropertyException
- If the new value is invalid.ValueOrExpression<GssapiSaslMechanismHandlerCfgDefn.QualityOfProtection> getQualityOfProtection()
The name of a property that specifies the quality of protection the server will support.
void setQualityOfProtection(ValueOrExpression<GssapiSaslMechanismHandlerCfgDefn.QualityOfProtection> value) throws PropertyException
The name of a property that specifies the quality of protection the server will support.
value
- The value of the "quality-of-protection" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getRealm()
Specifies the realm to be used for GSSAPI authentication.
void setRealm(ValueOrExpression<String> value) throws PropertyException
Specifies the realm to be used for GSSAPI authentication.
value
- The value of the "realm" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getServerFqdn()
Specifies the DNS-resolvable fully-qualified domain name for the system.
void setServerFqdn(ValueOrExpression<String> value) throws PropertyException
Specifies the DNS-resolvable fully-qualified domain name for the system.
value
- The value of the "server-fqdn" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.