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.ArrayList; 041import java.util.Collections; 042import java.util.LinkedList; 043import java.util.List; 044import java.util.StringTokenizer; 045 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 log 056 * message that may appear in the Directory Server access log about a search 057 * result entry returned to a client. 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 SearchEntryAccessLogMessage 072 extends SearchRequestAccessLogMessage 073{ 074 /** 075 * The serial version UID for this serializable class. 076 */ 077 private static final long serialVersionUID = 6423635071693560277L; 078 079 080 081 // The names of the attributes included in the entry that was returned. 082 @Nullable private final List<String> attributesReturned; 083 084 // The list of response control OIDs for the operation. 085 @NotNull private final List<String> responseControlOIDs; 086 087 // The DN of the entry returned. 088 @Nullable private final String dn; 089 090 091 092 /** 093 * Creates a new search result entry access log message from the provided 094 * message string. 095 * 096 * @param s The string to be parsed as a search result entry access log 097 * message. 098 * 099 * @throws LogException If the provided string cannot be parsed as a valid 100 * log message. 101 */ 102 public SearchEntryAccessLogMessage(@NotNull final String s) 103 throws LogException 104 { 105 this(new LogMessage(s)); 106 } 107 108 109 110 /** 111 * Creates a new search result entry access log message from the provided log 112 * message. 113 * 114 * @param m The log message to be parsed as a search entry access log 115 * message. 116 */ 117 public SearchEntryAccessLogMessage(@NotNull final LogMessage m) 118 { 119 super(m); 120 121 dn = getNamedValue("dn"); 122 123 final String controlStr = getNamedValue("responseControls"); 124 if (controlStr == null) 125 { 126 responseControlOIDs = Collections.emptyList(); 127 } 128 else 129 { 130 final LinkedList<String> controlList = new LinkedList<>(); 131 final StringTokenizer t = new StringTokenizer(controlStr, ","); 132 while (t.hasMoreTokens()) 133 { 134 controlList.add(t.nextToken()); 135 } 136 responseControlOIDs = Collections.unmodifiableList(controlList); 137 } 138 139 final String attrs = getNamedValue("attrsReturned"); 140 if (attrs == null) 141 { 142 attributesReturned = null; 143 } 144 else 145 { 146 final ArrayList<String> l = new ArrayList<>(10); 147 final StringTokenizer tokenizer = new StringTokenizer(attrs, ","); 148 while (tokenizer.hasMoreTokens()) 149 { 150 l.add(tokenizer.nextToken()); 151 } 152 153 attributesReturned = Collections.unmodifiableList(l); 154 } 155 } 156 157 158 159 /** 160 * Retrieves the DN of the entry returned to the client. 161 * 162 * @return The DN of the entry returned to the client, or {@code null} if it 163 * is not included in the log message. 164 */ 165 @Nullable() 166 public String getDN() 167 { 168 return dn; 169 } 170 171 172 173 /** 174 * Retrieves the names of the attributes included in the entry that was 175 * returned. 176 * 177 * @return The names of the attributes included in the entry that was 178 * returned, or {@code null} if it is not included in the log 179 * message. 180 */ 181 @Nullable() 182 public List<String> getAttributesReturned() 183 { 184 return attributesReturned; 185 } 186 187 188 189 /** 190 * Retrieves the OIDs of any response controls contained in the log message. 191 * 192 * @return The OIDs of any response controls contained in the log message, or 193 * an empty list if it is not included in the log message. 194 */ 195 @NotNull() 196 public List<String> getResponseControlOIDs() 197 { 198 return responseControlOIDs; 199 } 200 201 202 203 /** 204 * {@inheritDoc} 205 */ 206 @Override() 207 @NotNull() 208 public AccessLogMessageType getMessageType() 209 { 210 return AccessLogMessageType.ENTRY; 211 } 212}