Package org.forgerock.opendj.server.config.client

Interface GSSAPISASLMechanismHandlerCfgClient

All Superinterfaces:

ConfigurationClient, SASLMechanismHandlerCfgClient

public interface GSSAPISASLMechanismHandlerCfgClient
extends SASLMechanismHandlerCfgClient

A client-side interface for reading and modifying GSSAPI SASL Mechanism Handler settings.

The GSSAPI SASL mechanism performs all processing related to SASL GSSAPI authentication using Kerberos V5.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends GSSAPISASLMechanismHandlerCfgClient,? extends GSSAPISASLMechanismHandlerCfg>	definition()	Get the configuration definition associated with this GSSAPI SASL Mechanism Handler.
String	getIdentityMapper()	Gets the "identity-mapper" property.
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	setIdentityMapper(String value)	Sets the "identity-mapper" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setKdcAddress(String value)	Sets the "kdc-address" property.
void	setKeytab(String value)	Sets the "keytab" property.
void	setPrincipalName(String value)	Sets the "principal-name" property.
void	setQualityOfProtection(GSSAPISASLMechanismHandlerCfgDefn.QualityOfProtection value)	Sets the "quality-of-protection" property.
void	setRealm(String value)	Sets the "realm" property.
void	setServerFqdn(String value)	Sets the "server-fqdn" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.SASLMechanismHandlerCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends GSSAPISASLMechanismHandlerCfgClient,? extends GSSAPISASLMechanismHandlerCfg> definition()

Get the configuration definition associated with this GSSAPI SASL Mechanism Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface SASLMechanismHandlerCfgClient

Returns:

Returns the configuration definition associated with this GSSAPI SASL Mechanism Handler.

getIdentityMapper

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.

setIdentityMapper

void setIdentityMapper(String value)
                throws PropertyException

Sets 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.

Parameters:

value - The value of the "identity-mapper" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

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 SASLMechanismHandlerCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface SASLMechanismHandlerCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

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.

setKdcAddress

void setKdcAddress(String value)
            throws PropertyException

Sets 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.

Parameters:

value - The value of the "kdc-address" property.

Throws:

PropertyException - If the new value is invalid.

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.

setKeytab

void setKeytab(String value)
        throws PropertyException

Sets 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.

Parameters:

value - The value of the "keytab" property.

Throws:

PropertyException - If the new value is invalid.

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.

setPrincipalName

void setPrincipalName(String value)
               throws PropertyException

Sets 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/".

Parameters:

value - The value of the "principal-name" property.

Throws:

PropertyException - If the new value is invalid.

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.

Returns:

Returns the value of the "quality-of-protection" property.

setQualityOfProtection

void setQualityOfProtection(GSSAPISASLMechanismHandlerCfgDefn.QualityOfProtection value)
                     throws PropertyException

Sets the "quality-of-protection" property.

The name of a property that specifies the quality of protection the server will support.

Parameters:

value - The value of the "quality-of-protection" property.

Throws:

PropertyException - If the new value is invalid.

getRealm

String getRealm()

Gets the "realm" property.

Specifies the realm to be used for GSSAPI authentication.

Returns:

Returns the value of the "realm" property.

setRealm

void setRealm(String value)
       throws PropertyException

Sets the "realm" property.

Specifies the realm to be used for GSSAPI authentication.

Parameters:

value - The value of the "realm" property.

Throws:

PropertyException - If the new value is invalid.

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.

setServerFqdn

void setServerFqdn(String value)
            throws PropertyException

Sets the "server-fqdn" property.

Specifies the DNS-resolvable fully-qualified domain name for the system.

Parameters:

value - The value of the "server-fqdn" property.

Throws:

PropertyException - If the new value is invalid.