001/*
002 * Copyright 2022-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-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) 2022-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.v2.text;
037
038
039
040import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogOperationType;
041import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
042import com.unboundid.ldap.sdk.unboundidds.logs.v2.UnbindRequestAccessLogMessage;
043import com.unboundid.util.NotMutable;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047
048
049
050/**
051 * This class provides a data structure that holds information about a
052 * text-formatted unbind request access log message.
053 * <BR>
054 * <BLOCKQUOTE>
055 *   <B>NOTE:</B>  This class, and other classes within the
056 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
057 *   supported for use against Ping Identity, UnboundID, and
058 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
059 *   for proprietary functionality or for external specifications that are not
060 *   considered stable or mature enough to be guaranteed to work in an
061 *   interoperable way with other types of LDAP servers.
062 * </BLOCKQUOTE>
063 */
064@NotMutable()
065@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
066public final class TextFormattedUnbindRequestAccessLogMessage
067       extends TextFormattedRequestAccessLogMessage
068       implements UnbindRequestAccessLogMessage
069{
070  /**
071   * The serial version UID for this serializable class.
072   */
073  private static final long serialVersionUID = -2979761002847294026L;
074
075
076
077  /**
078   * Creates a new text-formatted unbind request access log message from the
079   * provided message string.
080   *
081   * @param  logMessageString  The string representation of this log message.
082   *                           It must not be {@code null}.
083   *
084   * @throws  LogException  If the provided string cannot be parsed as a valid
085   *                        log message.
086   */
087  public TextFormattedUnbindRequestAccessLogMessage(
088              @NotNull final String logMessageString)
089         throws LogException
090  {
091    this(new TextFormattedLogMessage(logMessageString));
092  }
093
094
095
096  /**
097   * Creates a new text-formatted unbind request access log message from the
098   * provided message string.
099   *
100   * @param  logMessage  The log message to use to create this unbind request
101   *                     access log message.  It must not be {@code null}.
102   */
103  TextFormattedUnbindRequestAccessLogMessage(
104       @NotNull final TextFormattedLogMessage logMessage)
105  {
106    super(logMessage);
107  }
108
109
110
111  /**
112   * {@inheritDoc}
113   */
114  @Override()
115  @NotNull()
116  public AccessLogOperationType getOperationType()
117  {
118    return AccessLogOperationType.UNBIND;
119  }
120}