001/*
002 * Copyright 2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022 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 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 java.util.Set;
041
042import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
043import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogOperationType;
044import com.unboundid.ldap.sdk.unboundidds.logs.v2.
045            IntermediateResponseAccessLogMessage;
046import com.unboundid.util.NotMutable;
047import com.unboundid.util.NotNull;
048import com.unboundid.util.Nullable;
049import com.unboundid.util.ThreadSafety;
050import com.unboundid.util.ThreadSafetyLevel;
051
052
053
054/**
055 * This class provides a data structure that holds information about a
056 * text-formatted operation request access log message.
057 * <BR>
058 * <BLOCKQUOTE>
059 *   <B>NOTE:</B>  This class, and other classes within the
060 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
061 *   supported for use against Ping Identity, UnboundID, and
062 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
063 *   for proprietary functionality or for external specifications that are not
064 *   considered stable or mature enough to be guaranteed to work in an
065 *   interoperable way with other types of LDAP servers.
066 * </BLOCKQUOTE>
067 */
068@NotMutable()
069@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
070public final class TextFormattedIntermediateResponseAccessLogMessage
071       extends TextFormattedRequestAccessLogMessage
072       implements IntermediateResponseAccessLogMessage
073{
074  /**
075   * The serial version UID for this serializable class.
076   */
077  private static final long serialVersionUID = -8154114903633681042L;
078
079
080
081  // The operation type for this log message.
082  @NotNull private final AccessLogOperationType operationType;
083
084  // The set of response control OIDs for this log message.
085  @NotNull private final Set<String> responseControlOIDs;
086
087  // The intermediate response name for this log message.
088  @Nullable private final String intermediateResponseName;
089
090  // The intermediate response OID for this log message.
091  @Nullable private final String oid;
092
093  // A string representation of the intermediate response value for this log
094  // message.
095  @Nullable private final String valueString;
096
097
098
099  /**
100   * Creates a new text-formatted intermediate response access log message from
101   * the provided message.
102   *
103   * @param  logMessage     The log message to use to create this intermediate
104   *                        response access log message.  It must not be
105   *                        {@code null}.
106   * @param  operationType  The operation type for this intermediate
107   */
108  TextFormattedIntermediateResponseAccessLogMessage(
109       @NotNull final TextFormattedLogMessage logMessage,
110       @NotNull final AccessLogOperationType operationType)
111  {
112    super(logMessage);
113
114    this.operationType = operationType;
115
116    oid = getString(TextFormattedAccessLogFields.INTERMEDIATE_RESPONSE_OID);
117    intermediateResponseName = getString(
118         TextFormattedAccessLogFields.INTERMEDIATE_RESPONSE_NAME);
119    valueString = getString(
120         TextFormattedAccessLogFields.INTERMEDIATE_RESPONSE_VALUE);
121    responseControlOIDs = getCommaDelimitedStringSet(
122         TextFormattedAccessLogFields.RESPONSE_CONTROL_OIDS);
123  }
124
125
126
127  /**
128   * {@inheritDoc}
129   */
130  @Override()
131  @NotNull()
132  public AccessLogMessageType getMessageType()
133  {
134    return AccessLogMessageType.INTERMEDIATE_RESPONSE;
135  }
136
137
138
139  /**
140   * {@inheritDoc}
141   */
142  @Override()
143  @NotNull()
144  public AccessLogOperationType getOperationType()
145  {
146    return operationType;
147  }
148
149
150
151  /**
152   * {@inheritDoc}
153   */
154  @Override()
155  @Nullable()
156  public String getOID()
157  {
158    return oid;
159  }
160
161
162
163  /**
164   * {@inheritDoc}
165   */
166  @Override()
167  @Nullable()
168  public String getResponseName()
169  {
170    return intermediateResponseName;
171  }
172
173
174
175  /**
176   * {@inheritDoc}
177   */
178  @Override()
179  @Nullable()
180  public String getValueString()
181  {
182    return valueString;
183  }
184
185
186
187  /**
188   * {@inheritDoc}
189   */
190  @Override()
191  @NotNull()
192  public Set<String> getResponseControlOIDs()
193  {
194    return responseControlOIDs;
195  }
196}