org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends GSSAPISASLMechanismHandlerCfgClient,? extends GSSAPISASLMechanismHandlerCfg> definition()
          Get the configuration definition associated with this GSSAPI SASL Mechanism Handler.
 java.lang.String getIdentityMapper()
          Gets the "identity-mapper" property.
 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 setIdentityMapper(java.lang.String value)
          Sets the "identity-mapper" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setKdcAddress(java.lang.String value)
          Sets the "kdc-address" property.
 void setKeytab(java.lang.String value)
          Sets the "keytab" property.
 void setRealm(java.lang.String value)
          Sets the "realm" property.
 void setServerFqdn(java.lang.String value)
          Sets the "server-fqdn" property.
 
Methods inherited from interface org.opends.server.admin.std.client.SASLMechanismHandlerCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

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

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.

setIdentityMapper

void setIdentityMapper(java.lang.String value)
                       throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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 SASLMechanismHandlerCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setKdcAddress

void setKdcAddress(java.lang.String value)
                   throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setKeytab

void setKeytab(java.lang.String value)
               throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setRealm

void setRealm(java.lang.String value)
              throws IllegalPropertyValueException
Sets the "realm" property.

Specifies the realm to be used for GSSAPI authentication.

Parameters:
value - The value of the "realm" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setServerFqdn

void setServerFqdn(java.lang.String value)
                   throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.