Interface GssapiSaslMechanismHandlerCfg
-
- All Superinterfaces:
Configuration
,SaslMechanismHandlerCfg
public interface GssapiSaslMechanismHandlerCfg extends SaslMechanismHandlerCfg
A server-side interface for querying GSSAPI SASL Mechanism Handler settings.The GSSAPI SASL mechanism performs all processing related to SASL GSSAPI authentication using Kerberos V5.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addGssapiChangeListener(ConfigurationChangeListener<GssapiSaslMechanismHandlerCfg> listener)
Register to be notified when this GSSAPI SASL Mechanism Handler is changed.Class<? extends GssapiSaslMechanismHandlerCfg>
configurationClass()
Gets the configuration class associated with this GSSAPI SASL Mechanism Handler.SortedSet<String>
getIdentityMapper()
Gets the "identity-mapper" property.SortedSet<Dn>
getIdentityMapperDns()
Gets the "identity-mapper" property as a set of DNs.String
getJavaClass()
Gets the "java-class" property.String
getKdcAddress()
Gets the "kdc-address" property.String
getKeytab()
Gets the "keytab" property.String
getPrincipalName()
Gets the "principal-name" property.GssapiSaslMechanismHandlerCfgDefn.QualityOfProtection
getQualityOfProtection()
Gets the "quality-of-protection" property.String
getRealm()
Gets the "realm" property.String
getServerFqdn()
Gets the "server-fqdn" property.void
removeGssapiChangeListener(ConfigurationChangeListener<GssapiSaslMechanismHandlerCfg> listener)
Deregister an existing GSSAPI SASL Mechanism Handler configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.SaslMechanismHandlerCfg
addChangeListener, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends GssapiSaslMechanismHandlerCfg> configurationClass()
Gets the configuration class associated with this GSSAPI SASL Mechanism Handler.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceSaslMechanismHandlerCfg
- Returns:
- Returns the configuration class associated with this GSSAPI SASL Mechanism Handler.
-
addGssapiChangeListener
void addGssapiChangeListener(ConfigurationChangeListener<GssapiSaslMechanismHandlerCfg> listener)
Register to be notified when this GSSAPI SASL Mechanism Handler is changed.- Parameters:
listener
- The GSSAPI SASL Mechanism Handler configuration change listener.
-
removeGssapiChangeListener
void removeGssapiChangeListener(ConfigurationChangeListener<GssapiSaslMechanismHandlerCfg> listener)
Deregister an existing GSSAPI SASL Mechanism Handler configuration change listener.- Parameters:
listener
- The GSSAPI SASL Mechanism Handler configuration change listener.
-
getIdentityMapper
SortedSet<String> getIdentityMapper()
Gets the "identity-mapper" property.Specifies the name(s) of the identity mapper(s) that are 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.
- Returns:
- Returns an unmodifiable set containing the values of the "identity-mapper" property.
-
getIdentityMapperDns
SortedSet<Dn> getIdentityMapperDns()
Gets the "identity-mapper" property as a set of DNs.Specifies the name(s) of the identity mapper(s) that are 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.
- Returns:
- Returns the DN values of the "identity-mapper" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.
Default value:
org.opends.server.extensions.GSSAPISASLMechanismHandler
- Specified by:
getJavaClass
in interfaceSaslMechanismHandlerCfg
- Returns:
- Returns the value of the "java-class" property.
-
getKdcAddress
String getKdcAddress()
Gets the "kdc-address" property.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.
- Returns:
- Returns the value of the "kdc-address" property.
-
getKeytab
String getKeytab()
Gets the "keytab" property.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.
- Returns:
- Returns the value of the "keytab" property.
-
getPrincipalName
String getPrincipalName()
Gets the "principal-name" property.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/".
- Returns:
- Returns the value of the "principal-name" property.
-
getQualityOfProtection
GssapiSaslMechanismHandlerCfgDefn.QualityOfProtection getQualityOfProtection()
Gets the "quality-of-protection" property.The name of a property that specifies the quality of protection the server will support.
Default value:
none
- Returns:
- Returns the value of the "quality-of-protection" property.
-
getRealm
String getRealm()
Gets the "realm" property.Specifies the realm to be used for GSSAPI authentication.
- Returns:
- Returns the value of the "realm" property.
-
getServerFqdn
String getServerFqdn()
Gets the "server-fqdn" property.Specifies the DNS-resolvable fully-qualified domain name for the system.
- Returns:
- Returns the value of the "server-fqdn" property.
-
-