001/* 002 * Copyright 2008-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2008-2020 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) 2015-2020 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.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This class defines a failed dependency action, which controls how a task 048 * should behave if any of its dependencies fails. 049 * <BR> 050 * <BLOCKQUOTE> 051 * <B>NOTE:</B> This class, and other classes within the 052 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 053 * supported for use against Ping Identity, UnboundID, and 054 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 055 * for proprietary functionality or for external specifications that are not 056 * considered stable or mature enough to be guaranteed to work in an 057 * interoperable way with other types of LDAP servers. 058 * </BLOCKQUOTE> 059 */ 060@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 061public enum FailedDependencyAction 062{ 063 /** 064 * The failed dependency action that indicates the dependent task should go 065 * ahead and continue processing as if none of its dependencies had failed. 066 */ 067 PROCESS("process"), 068 069 070 071 /** 072 * The failed dependency action that indicates the dependent task should be 073 * canceled if any of its dependencies had failed. 074 */ 075 CANCEL("cancel"), 076 077 078 079 /** 080 * The failed dependency action that indicates the dependent task should be 081 * disabled if any of its dependencies had failed. 082 */ 083 DISABLE("disable"); 084 085 086 087 // The name of this failed dependency action. 088 private final String name; 089 090 091 092 /** 093 * Creates a new failed dependency action with the specified name. 094 * 095 * @param name The name of the failed dependency action to create. 096 */ 097 FailedDependencyAction(final String name) 098 { 099 this.name = name; 100 } 101 102 103 104 /** 105 * Retrieves the name of this failed dependency action. 106 * 107 * @return The name of this failed dependency action. 108 */ 109 public String getName() 110 { 111 return name; 112 } 113 114 115 116 /** 117 * Retrieves the failed dependency action with the specified name. 118 * 119 * @param name The name of the failed dependency action to retrieve. It 120 * must not be {@code null}. 121 * 122 * @return The requested failed dependency action, or {@code null} if there 123 * is no action with the given name. 124 */ 125 public static FailedDependencyAction forName(final String name) 126 { 127 switch (StaticUtils.toLowerCase(name)) 128 { 129 case "process": 130 return PROCESS; 131 case "cancel": 132 return CANCEL; 133 case "disable": 134 return DISABLE; 135 default: 136 return null; 137 } 138 } 139 140 141 142 /** 143 * Retrieves a string representation of this failed dependency action. 144 * 145 * @return A string representation of this failed dependency action. 146 */ 147 @Override() 148 public String toString() 149 { 150 return name; 151 } 152}