001/*
002 * Copyright 2009-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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.logs;
037
038
039
040import com.unboundid.util.NotExtensible;
041import com.unboundid.util.ThreadSafety;
042import com.unboundid.util.ThreadSafetyLevel;
043
044
045
046/**
047 * This class provides a data structure that holds information about a log
048 * message that may appear in the Directory Server access log about an
049 * operation processed by the server.
050 * <BR>
051 * <BLOCKQUOTE>
052 *   <B>NOTE:</B>  This class, and other classes within the
053 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
054 *   supported for use against Ping Identity, UnboundID, and
055 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
056 *   for proprietary functionality or for external specifications that are not
057 *   considered stable or mature enough to be guaranteed to work in an
058 *   interoperable way with other types of LDAP servers.
059 * </BLOCKQUOTE>
060 */
061@NotExtensible()
062@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
063public abstract class OperationAccessLogMessage
064       extends AccessLogMessage
065{
066  /**
067   * The serial version UID for this serializable class.
068   */
069  private static final long serialVersionUID = 5311424730889643655L;
070
071
072
073  // The message ID for this access log message.
074  private final Integer messageID;
075
076  // The operation ID for this access log message.
077  private final Long operationID;
078
079  // The connection ID for the operation that triggered the associated
080  // operation.
081  private final Long triggeredByConnectionID;
082
083  // The operation ID for the operation that triggered the associated operation.
084  private final Long triggeredByOperationID;
085
086  // The message origin for this access log message.
087  private final String origin;
088
089
090
091  /**
092   * Creates a new operation access log message from the provided log message.
093   *
094   * @param  m  The log message to be parsed as an operation access log message.
095   */
096  protected OperationAccessLogMessage(final LogMessage m)
097  {
098    super(m);
099
100    messageID               = getNamedValueAsInteger("msgID");
101    operationID             = getNamedValueAsLong("op");
102    triggeredByConnectionID = getNamedValueAsLong("triggeredByConn");
103    triggeredByOperationID  = getNamedValueAsLong("triggeredByOp");
104    origin                  = getNamedValue("origin");
105  }
106
107
108
109  /**
110   * Retrieves the operation ID for the associated operation.
111   *
112   * @return  The operation ID for the associated operation, or {@code null} if
113   *          it is not included in the log message.
114   */
115  public final Long getOperationID()
116  {
117    return operationID;
118  }
119
120
121
122  /**
123   * Retrieves the connection ID for the connection that triggered the
124   * associated operation.  This is generally used for internal operations that
125   * are processed as a direct result of an externally-requested operation.
126   *
127   * @return  The connection ID for the connection that triggered the associated
128   *          operation, or {@code null} if it is not included in the log
129   *          message.
130   */
131  public final Long getTriggeredByConnectionID()
132  {
133    return triggeredByConnectionID;
134  }
135
136
137
138  /**
139   * Retrieves the operation ID for the operation that triggered the associated
140   * operation.  This is generally used for internal operations that are
141   * processed as a direct result of an externally-requested operation.
142   *
143   * @return  The operation ID for the operation that triggered the associated
144   *          operation, or {@code null} if it is not included in the log
145   *          message.
146   */
147  public final Long getTriggeredByOperationID()
148  {
149    return triggeredByOperationID;
150  }
151
152
153
154  /**
155   * Retrieves the message ID for the associated operation.
156   *
157   * @return  The message ID for the associated operation, or {@code null} if
158   *          it is not included in the log message.
159   */
160  public final Integer getMessageID()
161  {
162    return messageID;
163  }
164
165
166
167  /**
168   * Retrieves the origin of the associated operation.  If present, it may be
169   * "synchronization" if the operation is replicated, or "internal" if it is an
170   * internal operation.
171   *
172   * @return  The origin for the associated operation, or {@code null} if it is
173   *          not included in the log message.
174   */
175  public final String getOrigin()
176  {
177    return origin;
178  }
179
180
181
182  /**
183   * Retrieves the operation type for the associated operation.
184   *
185   * @return  The operation type for this access log message.
186   */
187  public abstract AccessLogOperationType getOperationType();
188}