Package org.ldaptive.sasl

Class SaslConfig

java.lang.Object
org.ldaptive.AbstractFreezable
org.ldaptive.AbstractConfig
org.ldaptive.sasl.SaslConfig
All Implemented Interfaces:
Freezable
public final class SaslConfig extends AbstractConfig
Contains basic configuration data for SASL authentication.

  • Field Details

    • properties

      private final Map<String,Object> properties
      sasl properties.

    • mechanism

      private Mechanism mechanism
      sasl mechanism.

    • authorizationId

      private String authorizationId
      sasl authorization id.

    • mutualAuthentication

      private Boolean mutualAuthentication
      perform mutual authentication.

    • qualityOfProtection

      private QualityOfProtection[] qualityOfProtection
      sasl quality of protection.

    • securityStrength

      private SecurityStrength[] securityStrength
      sasl security strength.

    • saslRealm

      private String saslRealm
      sasl realm.

  • Constructor Details

    • SaslConfig

      public SaslConfig()

  • Method Details

    • getMechanism

      public Mechanism getMechanism()
      Returns the sasl mechanism.
      Returns:
      mechanism

    • setMechanism

      public void setMechanism(Mechanism m)
      Sets the sasl mechanism.
      Parameters:
      m - mechanism

    • getAuthorizationId

      public String getAuthorizationId()
      Returns the sasl authorization id.
      Returns:
      authorization id

    • setAuthorizationId

      public void setAuthorizationId(String id)
      Sets the sasl authorization id.
      Parameters:
      id - authorization id

    • getMutualAuthentication

      public Boolean getMutualAuthentication()
      Returns whether mutual authentication should occur.
      Returns:
      whether mutual authentication should occur

    • setMutualAuthentication

      public void setMutualAuthentication(Boolean b)
      Sets whether mutual authentication should occur.
      Parameters:
      b - whether mutual authentication should occur

    • getQualityOfProtection

      public QualityOfProtection[] getQualityOfProtection()
      Returns the sasl quality of protection.
      Returns:
      quality of protection

    • setQualityOfProtection

      public void setQualityOfProtection(QualityOfProtection... qop)
      Sets the sasl quality of protection.
      Parameters:
      qop - quality of protection

    • getSecurityStrength

      public SecurityStrength[] getSecurityStrength()
      Returns the sasl security strength.
      Returns:
      security strength

    • setSecurityStrength

      public void setSecurityStrength(SecurityStrength... ss)
      Sets the sasl security strength.
      Parameters:
      ss - security strength

    • getRealm

      public String getRealm()
      Returns the sasl realm.
      Returns:
      realm

    • setRealm

      public void setRealm(String realm)
      Sets the sasl realm.
      Parameters:
      realm - to set

    • getProperties

      public Map<String,?> getProperties()
      Returns sasl properties.
      Returns:
      properties

    • setProperties

      public void setProperties(Map<String,?> props)
      Sets sasl properties.
      Parameters:
      props - to set

    • getProperty

      public Object getProperty(String name)
      Returns a sasl property.
      Parameters:
      name - of the property
      Returns:
      property

    • setProperty

      public void setProperty(String name, Object value)
      Sets a sasl property.
      Parameters:
      name - of the property
      value - of the property

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • copy

      public static SaslConfig copy(SaslConfig config)
      Returns a sasl config initialized with the supplied config.
      Parameters:
      config - sasl config to read properties from
      Returns:
      sasl config

    • builder

      public static SaslConfig.Builder builder()
      Creates a builder for this class.
      Returns:
      new builder