org.ldaptive.beans.spring.parser.SaslBindSearchAuthenticatorBeanDefinitionParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldaptive-beans Show documentation
Provides a mapping, persistence, and code generation API for reading and writing POJOs to an LDAP directory
There is a newer version: 2.4.0
/* See LICENSE for licensing and NOTICE for copyright. */
package org.ldaptive.beans.spring.parser;

import org.ldaptive.sasl.Mechanism;
import org.ldaptive.sasl.SaslConfig;
import org.springframework.beans.factory.BeanDefinitionStoreException;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

/**
 * Parser for sasl-bind-search-authenticator elements.
 *
 * @author Middleware Services
 */
public class SaslBindSearchAuthenticatorBeanDefinitionParser extends AbstractSearchAuthenticatorBeanDefinitionParser
{


  @Override
  protected String resolveId(
    final Element element,
    // CheckStyle:IllegalTypeCheck OFF
    final AbstractBeanDefinition definition,
    // CheckStyle:IllegalTypeCheck ON
    final ParserContext parserContext) throws BeanDefinitionStoreException
  {
    final String idAttrValue = element.getAttribute("id");
    return StringUtils.hasText(idAttrValue) ? idAttrValue : "sasl-bind-search-authenticator";
  }


  /**
   * Creates a bind connection initializer.
   *
   * @param  builder  bean definition builder to set properties on, may be null
   * @param  element  containing configuration
   *
   * @return  bind connection initializer bean definition
   */
  @Override
  protected BeanDefinitionBuilder parseConnectionInitializer(final BeanDefinitionBuilder builder, final Element element)
  {
    final BeanDefinitionBuilder initializer = super.parseConnectionInitializer(builder, element);
    initializer.addPropertyValue("bindSaslConfig", parseSaslConfig(element).getBeanDefinition());
    return initializer;
  }


  /**
   * Creates a sasl config.
   *
   * @param  element  containing configuration
   *
   * @return  sasl config bean definition builder
   */
  protected BeanDefinitionBuilder parseSaslConfig(final Element element)
  {
    final BeanDefinitionBuilder saslConfig =  BeanDefinitionBuilder.rootBeanDefinition(
      SaslBindSearchAuthenticatorBeanDefinitionParser.class,
      "parseSaslConfig");
    saslConfig.addConstructorArgValue(element.getAttribute("mechanism"));
    setIfPresent(element, "realm", saslConfig);
    setIfPresent(element, "authorizationId", saslConfig);
    setIfPresent(element, "mutualAuthentication", saslConfig);
    setIfPresent(element, "qualityOfProtection", saslConfig);
    setIfPresent(element, "securityStrength", saslConfig);
    return saslConfig;
  }


  /**
   * Returns a {@link SaslConfig} for the supplied value.
   *
   * @param  value  to parse
   *
   * @return  mechanism
   */
  protected static SaslConfig parseSaslConfig(final String value)
  {
    final SaslConfig saslConfig;
    switch (value) {

    case "DIGEST_MD5":
      saslConfig = new SaslConfig();
      saslConfig.setMechanism(Mechanism.DIGEST_MD5);
      break;

    case "CRAM_MD5":
      saslConfig = new SaslConfig();
      saslConfig.setMechanism(Mechanism.CRAM_MD5);
      break;

    case "EXTERNAL":
      saslConfig = new SaslConfig();
      saslConfig.setMechanism(Mechanism.EXTERNAL);
      break;

    case "GSSAPI":
      saslConfig = new SaslConfig();
      saslConfig.setMechanism(Mechanism.GSSAPI);
      break;

    case "SCRAM_SHA_1":
      saslConfig = new SaslConfig();
      saslConfig.setMechanism(Mechanism.SCRAM_SHA_1);
      break;

    case "SCRAM_SHA_256":
      saslConfig = new SaslConfig();
      saslConfig.setMechanism(Mechanism.SCRAM_SHA_256);
      break;

    case "SCRAM_SHA_512":
      saslConfig = new SaslConfig();
      saslConfig.setMechanism(Mechanism.SCRAM_SHA_512);
      break;

    default:
      throw new IllegalArgumentException("Unknown SASL mechanism " + value);
    }
    return saslConfig;
  }
}