com.onegini.sdk.accountlink.ErrorCodes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of idp-sdk Show documentation
Java SDK to connect to the Onegini platform
There is a newer version: 5.92.0
/*
 * Copyright 2013-2020 Onegini b.v.
 *
 * 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 com.onegini.sdk.accountlink;

/**
 * Error codes for {@link com.onegini.sdk.model.error.ErrorResponse}
 *
 * @since {@literal 4.03}
 *
 * This class is used inside thymeleaf templates, changing or moving it may introduce backward incompatibility issues
 *
 * TODO: THINK TWICE BEFORE MODIFYING THIS CLASS
 */
@Deprecated
public final class ErrorCodes {

  private ErrorCodes() {
  }

  /**
   * The "catch all" error code. Try to avoid because Onegini cannot give a hint to the end user what to do.
   */
  public static final int UNKNOWN_ERROR = 0;

  /**
   * Your backend system is not available or no new accounts are accepted at all
   */
  public static final int ACCOUNT_LINK_TEMPORARILY_NOT_AVAILABLE = 1_000;

  /**
   * Based on the incoming {@link com.onegini.sdk.model.Profile} no existing account can be found and no new accounts
   * can be created.
   */
  public static final int NO_MATCHING_ACCOUNT = 2_000;

  /**
   * Only use this if the attribute contract between Onegini and your organisation is not met. E.g. no email address is
   * present in the {@link com.onegini.sdk.model.Profile} but according to the contract an email address is required.
   * 
   * Use {@link #MISSING_MIGRATION_CODE_FOR_ACCOUNT_LINK} for a missing migration code
   */
  public static final int MISSING_PROFILE_DATA_FOR_ACCOUNT_LINK = 2_010;

  /**
   * No migration code was present in the {@link com.onegini.sdk.model.Profile} but it is required to create an account
   * link.
   */
  public static final int MISSING_MIGRATION_CODE_FOR_ACCOUNT_LINK = 2_020;

  /**
   * The migration code in the {@link com.onegini.sdk.model.Profile} is unknown or no longer valid.
   * 

   * If this happens you may want to notify your own support desk or send the user a new message with a valid migration
   * code.
   */
  public static final int INVALID_MIGRATION_CODE_FOR_ACCOUNT_LINK = 2_021;

  /**
   * Account link is not allowed for the data in this {@link com.onegini.sdk.model.Profile} because only email addresses
   * from a certain domain are allowed, only addresses in a specific country are allowed, the user has been blacklisted,
   * etc, etc.
   */
  public static final int PROFILE_NOT_ALLOWED_FOR_ACCOUNT_LINK = 2_030;

  /**
   * Some unique constraint is violated in your data store by adding data from this {@link com.onegini.sdk.model.Profile}.
   * 
   * If this happens you may want to notify your own support desk or the existing user how to fix this.
   */
  public static final int ACCOUNT_ALREADY_EXISTS = 3_000;

}