001/*
002 * Copyright 2008-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2008-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2008-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds.tasks;
037
038
039
040import com.unboundid.util.StaticUtils;
041import com.unboundid.util.NotNull;
042import com.unboundid.util.Nullable;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class defines a failed dependency action, which controls how a task
050 * should behave if any of its dependencies fails.
051 * <BR>
052 * <BLOCKQUOTE>
053 *   <B>NOTE:</B>  This class, and other classes within the
054 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
055 *   supported for use against Ping Identity, UnboundID, and
056 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
057 *   for proprietary functionality or for external specifications that are not
058 *   considered stable or mature enough to be guaranteed to work in an
059 *   interoperable way with other types of LDAP servers.
060 * </BLOCKQUOTE>
061 */
062@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
063public enum FailedDependencyAction
064{
065  /**
066   * The failed dependency action that indicates the dependent task should go
067   * ahead and continue processing as if none of its dependencies had failed.
068   */
069  PROCESS("process"),
070
071
072
073  /**
074   * The failed dependency action that indicates the dependent task should be
075   * canceled if any of its dependencies had failed.
076   */
077  CANCEL("cancel"),
078
079
080
081  /**
082   * The failed dependency action that indicates the dependent task should be
083   * disabled if any of its dependencies had failed.
084   */
085  DISABLE("disable");
086
087
088
089  // The name of this failed dependency action.
090  @NotNull private final String name;
091
092
093
094  /**
095   * Creates a new failed dependency action with the specified name.
096   *
097   * @param  name  The name of the failed dependency action to create.
098   */
099  FailedDependencyAction(@NotNull final String name)
100  {
101    this.name = name;
102  }
103
104
105
106  /**
107   * Retrieves the name of this failed dependency action.
108   *
109   * @return  The name of this failed dependency action.
110   */
111  @NotNull()
112  public String getName()
113  {
114    return name;
115  }
116
117
118
119  /**
120   * Retrieves the failed dependency action with the specified name.
121   *
122   * @param  name  The name of the failed dependency action to retrieve.  It
123   *               must not be {@code null}.
124   *
125   * @return  The requested failed dependency action, or {@code null} if there
126   *          is no action with the given name.
127   */
128  @Nullable()
129  public static FailedDependencyAction forName(@NotNull final String name)
130  {
131    switch (StaticUtils.toLowerCase(name))
132    {
133      case "process":
134        return PROCESS;
135      case "cancel":
136        return CANCEL;
137      case "disable":
138        return DISABLE;
139      default:
140        return null;
141    }
142  }
143
144
145
146  /**
147   * Retrieves a string representation of this failed dependency action.
148   *
149   * @return  A string representation of this failed dependency action.
150   */
151  @Override()
152  @NotNull()
153  public String toString()
154  {
155    return name;
156  }
157}