001/*
002 * Copyright 2009-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2024 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) 2009-2024 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.NotMutable;
041import com.unboundid.util.NotNull;
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 unbind
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@NotMutable()
063@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
064public final class UnbindRequestAccessLogMessage
065       extends OperationRequestAccessLogMessage
066{
067  /**
068   * The serial version UID for this serializable class.
069   */
070  private static final long serialVersionUID = 837856533259958468L;
071
072
073
074  /**
075   * Creates a new unbind request access log message from the provided message
076   * string.
077   *
078   * @param  s  The string to be parsed as an unbind request access log
079   *            message.
080   *
081   * @throws  LogException  If the provided string cannot be parsed as a valid
082   *                        log message.
083   */
084  public UnbindRequestAccessLogMessage(@NotNull final String s)
085         throws LogException
086  {
087    this(new LogMessage(s));
088  }
089
090
091
092  /**
093   * Creates a new unbind request access log message from the provided log
094   * message.
095   *
096   * @param  m  The log message to be parsed as an unbind request access log
097   *            message.
098   */
099  public UnbindRequestAccessLogMessage(@NotNull final LogMessage m)
100  {
101    super(m);
102  }
103
104
105
106  /**
107   * {@inheritDoc}
108   */
109  @Override()
110  @NotNull()
111  public AccessLogOperationType getOperationType()
112  {
113    return AccessLogOperationType.UNBIND;
114  }
115}