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