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