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.json;
037
038
039
040import java.util.List;
041import java.util.Set;
042
043import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
044import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
045import com.unboundid.ldap.sdk.unboundidds.logs.v2.
046            SearchReferenceAccessLogMessage;
047import com.unboundid.util.NotMutable;
048import com.unboundid.util.NotNull;
049import com.unboundid.util.ThreadSafety;
050import com.unboundid.util.ThreadSafetyLevel;
051import com.unboundid.util.json.JSONObject;
052
053
054
055/**
056 * This class provides a data structure that holds information about a
057 * JSON-formatted search reference access log message.
058 * <BR>
059 * <BLOCKQUOTE>
060 *   <B>NOTE:</B>  This class, and other classes within the
061 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
062 *   supported for use against Ping Identity, UnboundID, and
063 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
064 *   for proprietary functionality or for external specifications that are not
065 *   considered stable or mature enough to be guaranteed to work in an
066 *   interoperable way with other types of LDAP servers.
067 * </BLOCKQUOTE>
068 */
069@NotMutable()
070@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
071public final class JSONSearchReferenceAccessLogMessage
072       extends JSONSearchRequestAccessLogMessage
073       implements SearchReferenceAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = 198085732170528719L;
079
080
081
082  // The list of referral URLs for this log message.
083  @NotNull private final List<String> referralURLs;
084
085  // The set of response control OIDs for this log message.
086  @NotNull private final Set<String> responseControlOIDs;
087
088
089
090  /**
091   * Creates a new JSON search result access log message from the provided JSON
092   * object.
093   *
094   * @param  jsonObject  The JSON object that contains an encoded representation
095   *                     of this log message.  It must not be {@code null}.
096   *
097   * @throws  LogException  If the provided JSON object cannot be parsed as a
098   *                        valid log message.
099   */
100  public JSONSearchReferenceAccessLogMessage(
101              @NotNull final JSONObject jsonObject)
102         throws LogException
103  {
104    super(jsonObject);
105
106    referralURLs = getStringList(JSONFormattedAccessLogFields.REFERRAL_URLS);
107    responseControlOIDs =
108         getStringSet(JSONFormattedAccessLogFields.RESPONSE_CONTROL_OIDS);
109  }
110
111
112
113  /**
114   * {@inheritDoc}
115   */
116  @Override()
117  @NotNull()
118  public AccessLogMessageType getMessageType()
119  {
120    return AccessLogMessageType.REFERENCE;
121  }
122
123
124
125  /**
126   * {@inheritDoc}
127   */
128  @Override()
129  @NotNull()
130  public List<String> getReferralURLs()
131  {
132    return referralURLs;
133  }
134
135
136
137  /**
138   * {@inheritDoc}
139   */
140  @Override()
141  @NotNull()
142  public Set<String> getResponseControlOIDs()
143  {
144    return responseControlOIDs;
145  }
146}