Package com.isode.dsapi.util

Class SaslConfiguration

java.lang.Object
com.isode.dsapi.util.SaslConfiguration
public class SaslConfiguration extends Object
SASL Configuration.
Since:
15.0
Author:
mst

  • Field Details

    • DEFAULT_RULE

      public static final SaslConfiguration.Rules DEFAULT_RULE

    • DEFAULT_DOMAIN_MATCH_ATTR

      public static final AttributeType DEFAULT_DOMAIN_MATCH_ATTR

    • DEFAULT_NAMING_ATTR

      public static final AttributeType DEFAULT_NAMING_ATTR

    • DEFAULT_USER_MATCH_ATTR

      public static final AttributeType DEFAULT_USER_MATCH_ATTR

    • DEFAULT_FULL_MATCH_ATTR

      public static final AttributeType DEFAULT_FULL_MATCH_ATTR

  • Constructor Details

    • SaslConfiguration

      public SaslConfiguration(Entry entry) throws SaslConfigurationException
      Creates a new instance of SaslConfiguration.
      Parameters:
      entry - DSA configuration entry with SASL configuration attributes (not null)
      Throws:
      SaslConfigurationException - on bad SASL configuration attributes values

  • Method Details

    • getGenericRule

      public SaslConfiguration.Rules getGenericRule()
      Returns current SASL mapping rule.
      Returns:
      mapping rule (not null)

    • getGenericBaseDN

      public DN getGenericBaseDN()
      Returns current SASL configuration isodeSASLGenericBase attribute value.
      Returns:
      DN, null when not specified

    • getGenericUsersDN

      public DN getGenericUsersDN()
      Returns current SASL configuration isodeSASLGenericUsers attribute value.
      Returns:
      partial DN, null when not specified

    • getGenericUserMatchAttrType

      public AttributeType getGenericUserMatchAttrType(boolean useDefault)
      Returns current SASL configuration isodeSASLGenericUserMatchAttr attribute value. If attribute is not set or has no values it can use associated default value on request otherwise returns null.
      Parameters:
      useDefault - return default value for not set attribute value
      Returns:
      attribute type or null if not specified and not use default

    • getGenericFullMatchAttrType

      public AttributeType getGenericFullMatchAttrType(boolean useDefault)
      Returns current SASL configuration isodeSASLGenericFullMatchAttr attribute value. If attribute is not set or has no values it can use associated default value on request otherwise returns null.
      Parameters:
      useDefault - return default value for not set attribute value
      Returns:
      attribute type or null if not specified and not use default

    • getGenericDomain

      public String getGenericDomain()
      Return current SASL configuration isodeSASLGenericDomain attribute value
      Returns:
      domain string or null if not specified

    • getGenericDomainMatchAttrType

      public AttributeType getGenericDomainMatchAttrType(boolean useDefault)
      Returns current SASL configuration isodeSASLGenericDomainMatchAttr attribute value. If attribute is not set or has no values it can use associated default value on request otherwise returns null.
      Parameters:
      useDefault - return default value for not set attribute value
      Returns:
      attribute type or null if not specified and not use default

    • getGenericNamingAttrType

      public AttributeType getGenericNamingAttrType(boolean useDefault)
      Returns current SASL configuration isodeSASLGenericNamingAttr attribute value. If attribute is not set or has no values it can use associated default value on request otherwise returns null.
      Parameters:
      useDefault - return default value for not set attribute value
      Returns:
      attribute type or null if not specified and not use default

    • setUserFilter

      public void setUserFilter(String userFilter)
      Sets SASL LDAP DB user search filter.
      Parameters:
      userFilter - (null allowed)
      Since:
      16.0

    • getUserFilter

      public String getUserFilter()
      Returns SASL LDAP DB user search filter.
      Returns:
      SASL LDAP DB user search filter (null possible)
      Since:
      16.0

    • setDomainFilter

      public void setDomainFilter(String domainFilter)
      Sets SASL LDAP DB domain search filter.
      Parameters:
      domainFilter - (null allowed)
      Since:
      16.0

    • getDomainFilter

      public String getDomainFilter()
      Returns SASL LDAP DB domain search filter.
      Returns:
      SASL LDAP DB domain search filter (null possible)
      Since:
      16.0