001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2006-2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.core; 028 029 030 031 /** 032 * This class defines a number of constant values that are used in core 033 * Directory Server processing. 034 */ 035 public class CoreConstants 036 { 037 /** 038 * The name of the log element that will be used to hold the authentication 039 * type for a bind operation. 040 */ 041 public static final String LOG_ELEMENT_AUTH_TYPE = "authType"; 042 043 044 045 /** 046 * The name of the log element that will be used to hold the base DN for a 047 * search operation. 048 */ 049 public static final String LOG_ELEMENT_BASE_DN = "baseDN"; 050 051 052 053 /** 054 * The name of the log element that will be used to hold the bind DN. 055 */ 056 public static final String LOG_ELEMENT_BIND_DN = "bindDN"; 057 058 059 060 /** 061 * The name of the log element that will be used to hold the name of the 062 * attribute to compare. 063 */ 064 public static final String LOG_ELEMENT_COMPARE_ATTR = "compareAttribute"; 065 066 067 068 /** 069 * The name of the log element that will be used to connection ID for the 070 * client connection that requested the operation. 071 */ 072 public static final String LOG_ELEMENT_CONNECTION_ID = "connID"; 073 074 075 076 /** 077 * The name of the log element that will be used to indicate whether the old 078 * RDN attribute value should be removed from an entry. 079 */ 080 public static final String LOG_ELEMENT_DELETE_OLD_RDN = "deleteOldRDN"; 081 082 083 084 /** 085 * The name of the log element that will be used to hold the number of entries 086 * returned to the client for a search operation. 087 */ 088 public static final String LOG_ELEMENT_ENTRIES_SENT = "entriesSent"; 089 090 091 092 /** 093 * The name of the log element that will be used to hold the DN of an entry 094 * targeted by an operation. 095 */ 096 public static final String LOG_ELEMENT_ENTRY_DN = "entryDN"; 097 098 099 100 /** 101 * The name of the log element that will be used to hold the error message for 102 * an operation. 103 */ 104 public static final String LOG_ELEMENT_ERROR_MESSAGE = "errorMessage"; 105 106 107 108 /** 109 * The name of the log element that will be used to hold the request OID for 110 * an extended operation. 111 */ 112 public static final String LOG_ELEMENT_EXTENDED_REQUEST_OID = "requestOID"; 113 114 115 116 /** 117 * The name of the log element that will be used to hold the response OID for 118 * an extended operation. 119 */ 120 public static final String LOG_ELEMENT_EXTENDED_RESPONSE_OID = "responseOID"; 121 122 123 124 /** 125 * The name of the log element that will be used to hold the filter for a 126 * search operation. 127 */ 128 public static final String LOG_ELEMENT_FILTER = "filter"; 129 130 131 132 /** 133 * The name of the log element that will be used to hold the message ID of an 134 * operation to abandon. 135 */ 136 public static final String LOG_ELEMENT_ID_TO_ABANDON = "idToAbandon"; 137 138 139 140 /** 141 * The name of the log element that will be used to hold the matched DN for 142 * an operation. 143 */ 144 public static final String LOG_ELEMENT_MATCHED_DN = "matchedDN"; 145 146 147 148 /** 149 * The name of the log element that will be used to message ID for an 150 * operation. 151 */ 152 public static final String LOG_ELEMENT_MESSAGE_ID = "messageID"; 153 154 155 156 /** 157 * The name of the log element that will be used to hold the new RDN for a 158 * modify DN operation. 159 */ 160 public static final String LOG_ELEMENT_NEW_RDN = "newRDN"; 161 162 163 164 /** 165 * The name of the log element that will be used to hold the new superior DN 166 * for a modify DN operation. 167 */ 168 public static final String LOG_ELEMENT_NEW_SUPERIOR = "newSuperior"; 169 170 171 172 /** 173 * The name of the log element that will be used to operation ID for an 174 * operation. 175 */ 176 public static final String LOG_ELEMENT_OPERATION_ID = "opID"; 177 178 179 180 /** 181 * The name of the log element that will be used to hold the length of time 182 * spent processing an operation. 183 */ 184 public static final String LOG_ELEMENT_PROCESSING_TIME = "processingTime"; 185 186 187 188 /** 189 * The name of the log element that will be used to hold the number of search 190 * references returned to the client for a search operation. 191 */ 192 public static final String LOG_ELEMENT_REFERENCES_SENT = "referencesSent"; 193 194 195 196 /** 197 * The name of the log element that will be used to hold the referral URLs for 198 * an operation. 199 */ 200 public static final String LOG_ELEMENT_REFERRAL_URLS = "referralURLs"; 201 202 203 204 /** 205 * The name of the log element that will be used to hold the requested 206 * attributes for a search operation. 207 */ 208 public static final String LOG_ELEMENT_REQUESTED_ATTRIBUTES = "attributes"; 209 210 211 212 /** 213 * The name of the log element that will be used to hold the result code for 214 * an operation. 215 */ 216 public static final String LOG_ELEMENT_RESULT_CODE = "resultCode"; 217 218 219 220 /** 221 * The name of the log element that will be used to hold the SASL mechanism 222 * for a bind operation. 223 */ 224 public static final String LOG_ELEMENT_SASL_MECHANISM = "saslMechanism"; 225 226 227 228 /** 229 * The name of the log element that will be used to hold the scope for a 230 * search operation. 231 */ 232 public static final String LOG_ELEMENT_SCOPE = "scope"; 233 234 235 236 /** 237 * The name of the log element that will be used to hold the size limit for a 238 * search operation. 239 */ 240 public static final String LOG_ELEMENT_SIZE_LIMIT = "sizeLimit"; 241 242 243 244 /** 245 * The name of the log element that will be used to hold the time limit for a 246 * search operation. 247 */ 248 public static final String LOG_ELEMENT_TIME_LIMIT = "timeLimit"; 249 } 250