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 java.util.Collections;
041import java.util.LinkedList;
042import java.util.List;
043import java.util.StringTokenizer;
044
045import com.unboundid.util.NotMutable;
046import com.unboundid.util.NotNull;
047import com.unboundid.util.ThreadSafety;
048import com.unboundid.util.ThreadSafetyLevel;
049
050
051
052/**
053 * This class provides a data structure that holds information about a log
054 * message that may appear in the Directory Server access log about a search
055 * result reference returned to a client.
056 * <BR>
057 * <BLOCKQUOTE>
058 *   <B>NOTE:</B>  This class, and other classes within the
059 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
060 *   supported for use against Ping Identity, UnboundID, and
061 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
062 *   for proprietary functionality or for external specifications that are not
063 *   considered stable or mature enough to be guaranteed to work in an
064 *   interoperable way with other types of LDAP servers.
065 * </BLOCKQUOTE>
066 */
067@NotMutable()
068@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
069public final class SearchReferenceAccessLogMessage
070       extends SearchRequestAccessLogMessage
071{
072  /**
073   * The serial version UID for this serializable class.
074   */
075  private static final long serialVersionUID = 4413555391780641502L;
076
077
078
079  // The list of response control OIDs for the operation.
080  @NotNull private final List<String> responseControlOIDs;
081
082  // The set of referral URLs returned.
083  @NotNull private final List<String> referralURLs;
084
085
086
087  /**
088   * Creates a new search result reference access log message from the provided
089   * message string.
090   *
091   * @param  s  The string to be parsed as a search result reference access log
092   *            message.
093   *
094   * @throws  LogException  If the provided string cannot be parsed as a valid
095   *                        log message.
096   */
097  public SearchReferenceAccessLogMessage(@NotNull final String s)
098         throws LogException
099  {
100    this(new LogMessage(s));
101  }
102
103
104
105  /**
106   * Creates a new search result reference access log message from the provided
107   * log message.
108   *
109   * @param  m  The log message to be parsed as a search reference access log
110   *            message.
111   */
112  public SearchReferenceAccessLogMessage(@NotNull final LogMessage m)
113  {
114    super(m);
115
116    final String refStr = getNamedValue("referralURLs");
117    if ((refStr == null) || refStr.isEmpty())
118    {
119      referralURLs = Collections.emptyList();
120    }
121    else
122    {
123      final LinkedList<String> refs = new LinkedList<>();
124      int startPos = 0;
125      while (true)
126      {
127        final int commaPos = refStr.indexOf(",ldap", startPos);
128        if (commaPos < 0)
129        {
130          refs.add(refStr.substring(startPos));
131          break;
132        }
133        else
134        {
135          refs.add(refStr.substring(startPos, commaPos));
136          startPos = commaPos+1;
137        }
138      }
139      referralURLs = Collections.unmodifiableList(refs);
140    }
141
142    final String controlStr = getNamedValue("responseControls");
143    if (controlStr == null)
144    {
145      responseControlOIDs = Collections.emptyList();
146    }
147    else
148    {
149      final LinkedList<String> controlList = new LinkedList<>();
150      final StringTokenizer t = new StringTokenizer(controlStr, ",");
151      while (t.hasMoreTokens())
152      {
153        controlList.add(t.nextToken());
154      }
155      responseControlOIDs = Collections.unmodifiableList(controlList);
156    }
157  }
158
159
160
161  /**
162   * Retrieves the list of referral URLs returned to the client.
163   *
164   * @return  The list of referral URLs returned to the client, or an empty list
165   *          if it is not included in the log message.
166   */
167  @NotNull()
168  public List<String> getReferralURLs()
169  {
170    return referralURLs;
171  }
172
173
174
175  /**
176   * Retrieves the OIDs of any response controls contained in the log message.
177   *
178   * @return  The OIDs of any response controls contained in the log message, or
179   *          an empty list if it is not included in the log message.
180   */
181  @NotNull()
182  public List<String> getResponseControlOIDs()
183  {
184    return responseControlOIDs;
185  }
186
187
188
189  /**
190   * {@inheritDoc}
191   */
192  @Override()
193  @NotNull()
194  public AccessLogMessageType getMessageType()
195  {
196    return AccessLogMessageType.REFERENCE;
197  }
198}