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.
SortedSet<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(Collection<ValueOrExpression<String>> values)	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.

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

@MandatoryProperty
SortedSet<ValueOrExpression<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 the values of the "identity-mapper" property.

setIdentityMapper

@MandatoryProperty
void setIdentityMapper(Collection<ValueOrExpression<String>> values)
                throws PropertyException

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

Parameters:

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

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<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 interface SaslMechanismHandlerCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<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

ValueOrExpression<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(ValueOrExpression<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

ValueOrExpression<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(ValueOrExpression<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

ValueOrExpression<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(ValueOrExpression<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

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

setQualityOfProtection

void setQualityOfProtection(ValueOrExpression<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

ValueOrExpression<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(ValueOrExpression<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

ValueOrExpression<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(ValueOrExpression<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.