UserAccountControlValueTranscoder.java

/*
 * Copyright 2019-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.bremersee.data.ldaptive.transcoder;

import java.util.Optional;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
import org.ldaptive.transcode.AbstractStringValueTranscoder;
import org.springframework.util.StringUtils;

/**
 * The user account control value transcoder.
 *
 * @author Christian Bremer
 */
@ToString
@Slf4j
public class UserAccountControlValueTranscoder extends AbstractStringValueTranscoder<Integer> {

  /**
   * The attribute name in an active directory controller.
   */
  public static final String ATTRIBUTE_NAME = "userAccountControl";

  /**
   * The bit map value of a disabled account.
   */
  public static final int ACCOUNT_DISABLED = 1 << 1;

  /**
   * The bit map value of a normal account.
   */
  public static final int NORMAL_ACCOUNT = 1 << 9;

  /**
   * The bit map value a password that doesn't expire.
   */
  public static final int DONT_EXPIRE_PASSWORD = 1 << 16;

  /**
   * Gets user account control value.
   *
   * @param enabled the enabled
   * @param existingValue the existing value
   * @return the user account control value
   */
  public static int getUserAccountControlValue(Boolean enabled, Integer existingValue) {
    int value = Optional.ofNullable(existingValue).orElse(0);
    if ((value & NORMAL_ACCOUNT) != NORMAL_ACCOUNT) {
      value = value + NORMAL_ACCOUNT;
    }
    if ((value & DONT_EXPIRE_PASSWORD) != DONT_EXPIRE_PASSWORD) {
      value = value + DONT_EXPIRE_PASSWORD;
    }
    if (Boolean.FALSE.equals(enabled)) {
      if ((value & ACCOUNT_DISABLED) != ACCOUNT_DISABLED) {
        value = value + ACCOUNT_DISABLED;
      }
    } else {
      if ((value & ACCOUNT_DISABLED) == ACCOUNT_DISABLED) {
        value = value - ACCOUNT_DISABLED;
      }
    }
    return value;
  }

  /**
   * Determines whether an account is enabled or not. If the user account control value is {@code null}, {@code true}
   * will be returned (account is enabled).
   *
   * @param userAccountControlValue the user account control value (can be {@code null})
   * @return the boolean
   */
  public static boolean isUserAccountEnabled(Integer userAccountControlValue) {
    return isUserAccountEnabled(userAccountControlValue, true);
  }

  /**
   * Determines whether an account is enabled or not.
   *
   * @param userAccountControlValue the user account control value (can be {@code null})
   * @param defaultValue the default value (will be returned, if user account control value is {@code null})
   * @return the boolean
   */
  public static boolean isUserAccountEnabled(Integer userAccountControlValue, boolean defaultValue) {
    return userAccountControlValue == null
        ? defaultValue
        : ((userAccountControlValue & ACCOUNT_DISABLED) != ACCOUNT_DISABLED);
  }

  @Override
  public Integer decodeStringValue(String value) {
    return StringUtils.hasText(value)
        ? Integer.parseInt(value)
        : getUserAccountControlValue(true, 0);
  }

  @Override
  public String encodeStringValue(Integer value) {
    return Optional.ofNullable(value)
        .map(String::valueOf)
        .orElseGet(() -> String.valueOf(getUserAccountControlValue(true, 0)));
  }

  @Override
  public Class<Integer> getType() {
    return Integer.class;
  }
}