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.NotMutable;
042import com.unboundid.util.ThreadSafety;
043import com.unboundid.util.ThreadSafetyLevel;
044
045
046
047/**
048 * This class provides a data structure that holds information about a log
049 * message that may appear in the Directory Server access log about an extended
050 * request received from a client.
051 * <BR>
052 * <BLOCKQUOTE>
053 *   <B>NOTE:</B>  This class, and other classes within the
054 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
055 *   supported for use against Ping Identity, UnboundID, and
056 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
057 *   for proprietary functionality or for external specifications that are not
058 *   considered stable or mature enough to be guaranteed to work in an
059 *   interoperable way with other types of LDAP servers.
060 * </BLOCKQUOTE>
061 */
062@NotExtensible()
063@NotMutable()
064@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
065public class ExtendedRequestAccessLogMessage
066       extends OperationRequestAccessLogMessage
067{
068  /**
069   * The serial version UID for this serializable class.
070   */
071  private static final long serialVersionUID = -4278715896574532061L;
072
073
074
075  // The OID for the extended request.
076  private final String requestOID;
077
078
079
080  /**
081   * Creates a new extended request access log message from the provided message
082   * string.
083   *
084   * @param  s  The string to be parsed as an extended request access log
085   *            message.
086   *
087   * @throws  LogException  If the provided string cannot be parsed as a valid
088   *                        log message.
089   */
090  public ExtendedRequestAccessLogMessage(final String s)
091         throws LogException
092  {
093    this(new LogMessage(s));
094  }
095
096
097
098  /**
099   * Creates a new extended request access log message from the provided log
100   * message.
101   *
102   * @param  m  The log message to be parsed as an extended request access log
103   *            message.
104   */
105  public ExtendedRequestAccessLogMessage(final LogMessage m)
106  {
107    super(m);
108
109    requestOID = getNamedValue("requestOID");
110  }
111
112
113
114  /**
115   * Retrieves the OID of the extended request.
116   *
117   * @return  The OID of the extended request, or {@code null} if it is not
118   *          included in the log message.
119   */
120  public final String getRequestOID()
121  {
122    return requestOID;
123  }
124
125
126
127  /**
128   * {@inheritDoc}
129   */
130  @Override()
131  public final AccessLogOperationType getOperationType()
132  {
133    return AccessLogOperationType.EXTENDED;
134  }
135}