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