com.unboundid.ldap.sdk.unboundidds.tasks.FailedDependencyAction Maven / Gradle / Ivy
/*
* Copyright 2008-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2024 Ping Identity Corporation
*
* 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.
*/
/*
* Copyright (C) 2008-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.tasks;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class defines a failed dependency action, which controls how a task
* should behave if any of its dependencies fails.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*/
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public enum FailedDependencyAction
{
/**
* The failed dependency action that indicates the dependent task should go
* ahead and continue processing as if none of its dependencies had failed.
*/
PROCESS("process"),
/**
* The failed dependency action that indicates the dependent task should be
* canceled if any of its dependencies had failed.
*/
CANCEL("cancel"),
/**
* The failed dependency action that indicates the dependent task should be
* disabled if any of its dependencies had failed.
*/
DISABLE("disable");
// The name of this failed dependency action.
@NotNull private final String name;
/**
* Creates a new failed dependency action with the specified name.
*
* @param name The name of the failed dependency action to create.
*/
FailedDependencyAction(@NotNull final String name)
{
this.name = name;
}
/**
* Retrieves the name of this failed dependency action.
*
* @return The name of this failed dependency action.
*/
@NotNull()
public String getName()
{
return name;
}
/**
* Retrieves the failed dependency action with the specified name.
*
* @param name The name of the failed dependency action to retrieve. It
* must not be {@code null}.
*
* @return The requested failed dependency action, or {@code null} if there
* is no action with the given name.
*/
@Nullable()
public static FailedDependencyAction forName(@NotNull final String name)
{
switch (StaticUtils.toLowerCase(name))
{
case "process":
return PROCESS;
case "cancel":
return CANCEL;
case "disable":
return DISABLE;
default:
return null;
}
}
/**
* Retrieves a string representation of this failed dependency action.
*
* @return A string representation of this failed dependency action.
*/
@Override()
@NotNull()
public String toString()
{
return name;
}
}