001/*
002 * Copyright 2020-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2020-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) 2020-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.tools;
037
038
039
040import java.io.OutputStream;
041
042import com.unboundid.ldap.sdk.ExtendedResult;
043import com.unboundid.ldap.sdk.LDAPConnection;
044import com.unboundid.ldap.sdk.LDAPResult;
045import com.unboundid.ldap.sdk.SearchResultEntry;
046import com.unboundid.ldap.sdk.SearchResultReference;
047import com.unboundid.util.NotNull;
048import com.unboundid.util.ThreadSafety;
049import com.unboundid.util.ThreadSafetyLevel;
050
051
052
053/**
054 * This class provides an {@link LDAPResultWriter} instance that simply prints
055 * the DNs of the entries that are returned, with a separate DN per line.  There
056 * will not be any blank lines between DNs, and there will not be any prefix
057 * (for example, "dn:") before each DN.
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@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
070public final class DNsOnlyLDAPResultWriter
071       extends LDAPResultWriter
072{
073  /**
074   * Creates a new instance of this LDAP result writer.
075   *
076   * @param  outputStream  The output stream to which output will be written.
077   */
078  public DNsOnlyLDAPResultWriter(@NotNull final OutputStream outputStream)
079  {
080    super(outputStream);
081  }
082
083
084
085  /**
086   * {@inheritDoc}
087   */
088  @Override()
089  public void writeComment(@NotNull final String comment)
090  {
091    // Comments will not be written in this format.
092  }
093
094
095
096  /**
097   * {@inheritDoc}
098   */
099  @Override()
100  public void writeHeader()
101  {
102    // No header is required for this format.
103  }
104
105
106
107  /**
108   * {@inheritDoc}
109   */
110  @Override()
111  public void writeSearchResultEntry(@NotNull final SearchResultEntry entry)
112  {
113    println(entry.getDN());
114  }
115
116
117
118  /**
119   * {@inheritDoc}
120   */
121  @Override()
122  public void writeSearchResultReference(
123                   @NotNull final SearchResultReference ref)
124  {
125    // No output is needed for search result reference messages.
126  }
127
128
129
130  /**
131   * {@inheritDoc}
132   */
133  @Override()
134  public void writeResult(@NotNull final LDAPResult result)
135  {
136    getPrintStream().flush();
137  }
138
139
140
141  /**
142   * {@inheritDoc}
143   */
144  @Override()
145  public void writeUnsolicitedNotification(
146                   @NotNull final LDAPConnection connection,
147                   @NotNull final ExtendedResult notification)
148  {
149    getPrintStream().flush();
150  }
151}