com.appslandia.plum.base.InvalidAuthResult Maven / Gradle / Ivy

Go to download
// The MIT License (MIT)
// Copyright © 2015 AppsLandia. All rights reserved.

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package com.appslandia.plum.base;

import java.util.Set;

import com.appslandia.common.utils.Asserts;

import jakarta.security.enterprise.CallerPrincipal;
import jakarta.security.enterprise.identitystore.CredentialValidationResult;

/**
 *
 * @author Loc Ha
 *
 */
public class InvalidAuthResult extends CredentialValidationResult {

  static final CallerPrincipal INVALID_PRINCIPAL = new CallerPrincipal("null");
  static final CredentialValidationResult INVALID_RESULT = CredentialValidationResult.INVALID_RESULT;

  final String code;

  // NOTES: CredentialValidationResult doesn't provide a public constructor for
  // creating an invalid result
  // Use INVALID_RESULT to implement custom invalid result

  private InvalidAuthResult(String code) {
    super((String) null, INVALID_PRINCIPAL, null, null, null);

    this.code = Asserts.notNull(code);
  }

  @Override
  public Status getStatus() {
    return INVALID_RESULT.getStatus();
  }

  @Override
  public String getIdentityStoreId() {
    return INVALID_RESULT.getIdentityStoreId();
  }

  @Override
  public CallerPrincipal getCallerPrincipal() {
    return INVALID_RESULT.getCallerPrincipal();
  }

  @Override
  public String getCallerUniqueId() {
    return INVALID_RESULT.getCallerUniqueId();
  }

  @Override
  public String getCallerDn() {
    return INVALID_RESULT.getCallerDn();
  }

  @Override
  public Set getCallerGroups() {
    return INVALID_RESULT.getCallerGroups();
  }

  public String getCode() {
    return this.code;
  }

  public static final InvalidAuthResult CREDENTIAL_INVALID = new InvalidAuthResult("credential_invalid");

  public static final InvalidAuthResult CREDENTIAL_SUSPENDED = new InvalidAuthResult("credential_suspended");
  public static final InvalidAuthResult CREDENTIAL_NOT_ACTIVATED = new InvalidAuthResult("credential_not_activated");
  public static final InvalidAuthResult CREDENTIAL_NOT_APPROVED = new InvalidAuthResult("credential_not_approved");
  public static final InvalidAuthResult CREDENTIAL_COMPROMISED = new InvalidAuthResult("credential_compromised");

  public static final InvalidAuthResult TOKEN_INVALID = new InvalidAuthResult("token_invalid");
  public static final InvalidAuthResult TOKEN_COMPROMISED = new InvalidAuthResult("token_compromised");
  public static final InvalidAuthResult TOKEN_EXPIRED = new InvalidAuthResult("token_expired");
  public static final InvalidAuthResult TOKEN_MODULE_MISMATCH = new InvalidAuthResult("token_module_mismatch");

  public static final InvalidAuthResult ID_STORE_EXCEPTION = new InvalidAuthResult("id_store_exception");

  public static InvalidAuthResult valueOf(String code) {
    Asserts.notNull(code);

    if (CREDENTIAL_INVALID.getCode().equalsIgnoreCase(code)) {
      return CREDENTIAL_INVALID;
    }
    if (CREDENTIAL_SUSPENDED.getCode().equalsIgnoreCase(code)) {
      return CREDENTIAL_SUSPENDED;
    }
    if (CREDENTIAL_NOT_ACTIVATED.getCode().equalsIgnoreCase(code)) {
      return CREDENTIAL_NOT_ACTIVATED;
    }
    if (CREDENTIAL_NOT_APPROVED.getCode().equalsIgnoreCase(code)) {
      return CREDENTIAL_NOT_APPROVED;
    }
    if (CREDENTIAL_COMPROMISED.getCode().equalsIgnoreCase(code)) {
      return CREDENTIAL_COMPROMISED;
    }
    if (TOKEN_INVALID.getCode().equalsIgnoreCase(code)) {
      return TOKEN_INVALID;
    }
    if (TOKEN_COMPROMISED.getCode().equalsIgnoreCase(code)) {
      return TOKEN_COMPROMISED;
    }
    if (TOKEN_EXPIRED.getCode().equalsIgnoreCase(code)) {
      return TOKEN_EXPIRED;
    }
    if (TOKEN_MODULE_MISMATCH.getCode().equalsIgnoreCase(code)) {
      return TOKEN_MODULE_MISMATCH;
    }
    if (ID_STORE_EXCEPTION.getCode().equalsIgnoreCase(code)) {
      return ID_STORE_EXCEPTION;
    }
    return new InvalidAuthResult(code);
  }
}