org.opends.server.admin.std.server
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
 void addGSSAPIChangeListener(ConfigurationChangeListener<GSSAPISASLMechanismHandlerCfg> listener)
          Register to be notified when this GSSAPI SASL Mechanism Handler is changed.
 java.lang.Class<? extends GSSAPISASLMechanismHandlerCfg> configurationClass()
          Gets the configuration class associated with this GSSAPI SASL Mechanism Handler.
 java.lang.String getIdentityMapper()
          Gets the "identity-mapper" property.
 DN getIdentityMapperDN()
          Gets the "identity-mapper" property as a DN.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getKdcAddress()
          Gets the "kdc-address" property.
 java.lang.String getKeytab()
          Gets the "keytab" property.
 java.lang.String getRealm()
          Gets the "realm" property.
 java.lang.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.opends.server.admin.std.server.SASLMechanismHandlerCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends GSSAPISASLMechanismHandlerCfg> configurationClass()
Gets the configuration class associated with this GSSAPI SASL Mechanism Handler.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface SASLMechanismHandlerCfg
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

java.lang.String getIdentityMapper()
Gets the "identity-mapper" property.

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.

Returns:
Returns the value of the "identity-mapper" property.

getIdentityMapperDN

DN getIdentityMapperDN()
Gets the "identity-mapper" property as a DN.

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.

Returns:
Returns the DN value of the "identity-mapper" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.

Specified by:
getJavaClass in interface SASLMechanismHandlerCfg
Returns:
Returns the value of the "java-class" property.

getKdcAddress

java.lang.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

java.lang.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.

getRealm

java.lang.String getRealm()
Gets the "realm" property.

Specifies the realm to be used for GSSAPI authentication.

Returns:
Returns the value of the "realm" property.

getServerFqdn

java.lang.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.