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.controls; 037 038 039 040import com.unboundid.util.StaticUtils; 041import com.unboundid.util.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This enum contains the set of possible entry-level rights that may be 048 * described in an entry retrieved with the get effective rights control. 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 EntryRight 062{ 063 /** 064 * The entry right that indicates that the user has sufficient permission to 065 * add a subordinate of the target entry. 066 */ 067 ADD("add"), 068 069 070 071 /** 072 * The entry right that indicates that the user has sufficient permission to 073 * delete the target entry. 074 */ 075 DELETE("delete"), 076 077 078 079 /** 080 * The entry right that indicates that the user has sufficient permission to 081 * perform read operations with the entry. 082 */ 083 READ("read"), 084 085 086 087 /** 088 * The entry right that indicates that the user has sufficient permission to 089 * perform write operations with the entry. 090 */ 091 WRITE("write"), 092 093 094 095 /** 096 * The entry right that indicates that the user has sufficient permission to 097 * perform operations involving proxied authorization with the entry. 098 */ 099 PROXY("proxy"); 100 101 102 103 // The name of this entry right. 104 private final String name; 105 106 107 108 /** 109 * Creates a new entry right with the specified name. 110 * 111 * @param name The name for this entry right. 112 */ 113 EntryRight(final String name) 114 { 115 this.name = name; 116 } 117 118 119 120 /** 121 * Retrieves the name of this entry right. 122 * 123 * @return The name of this entry right. 124 */ 125 public String getName() 126 { 127 return name; 128 } 129 130 131 132 /** 133 * Retrieves the entry right for the specified name. 134 * 135 * @param name The name for which to retrieve the corresponding entry right. 136 * 137 * @return The requested entry right, or {@code null} if there is no such 138 * right. 139 */ 140 public static EntryRight forName(final String name) 141 { 142 switch (StaticUtils.toLowerCase(name)) 143 { 144 case "add": 145 return ADD; 146 case "delete": 147 return DELETE; 148 case "read": 149 return READ; 150 case "write": 151 return WRITE; 152 case "proxy": 153 return PROXY; 154 default: 155 return null; 156 } 157 } 158 159 160 161 /** 162 * Retrieves a string representation of this entry right. 163 * 164 * @return A string representation of this entry right. 165 */ 166 @Override() 167 public String toString() 168 { 169 return name; 170 } 171}