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