001/*
002 * Copyright 2020-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2020-2022 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-2022 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.Attribute;
043import com.unboundid.ldap.sdk.ExtendedResult;
044import com.unboundid.ldap.sdk.LDAPConnection;
045import com.unboundid.ldap.sdk.LDAPException;
046import com.unboundid.ldap.sdk.LDAPResult;
047import com.unboundid.ldap.sdk.LDAPRuntimeException;
048import com.unboundid.ldap.sdk.ResultCode;
049import com.unboundid.ldap.sdk.SearchResultEntry;
050import com.unboundid.ldap.sdk.SearchResultReference;
051import com.unboundid.util.Debug;
052import com.unboundid.util.NotNull;
053import com.unboundid.util.StaticUtils;
054import com.unboundid.util.ThreadSafety;
055import com.unboundid.util.ThreadSafetyLevel;
056
057import static com.unboundid.ldap.sdk.unboundidds.tools.ToolMessages.*;
058
059
060
061/**
062 * This class provides an {@link LDAPResultWriter} instance that simply prints
063 * the values of all attributes in the entries that are returned, with each
064 * value on a line by itself.  Entry DNs will not be included, and there will
065 * not be any blank lines between entries.
066 * <BR>
067 * <BLOCKQUOTE>
068 *   <B>NOTE:</B>  This class, and other classes within the
069 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
070 *   supported for use against Ping Identity, UnboundID, and
071 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
072 *   for proprietary functionality or for external specifications that are not
073 *   considered stable or mature enough to be guaranteed to work in an
074 *   interoperable way with other types of LDAP servers.
075 * </BLOCKQUOTE>
076 */
077@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
078public final class ValuesOnlyLDAPResultWriter
079       extends LDAPResultWriter
080{
081  /**
082   * Creates a new instance of this LDAP result writer.
083   *
084   * @param  outputStream  The output stream to which the output will be
085   *                       written.
086   */
087  public ValuesOnlyLDAPResultWriter(@NotNull final OutputStream outputStream)
088  {
089    super(outputStream);
090  }
091
092
093
094  /**
095   * {@inheritDoc}
096   */
097  @Override()
098  public void writeComment(@NotNull final String comment)
099  {
100    // Comments will not be written in this format.
101  }
102
103
104
105  /**
106   * {@inheritDoc}
107   */
108  @Override()
109  public void writeHeader()
110  {
111    // No header is required for this format.
112  }
113
114
115
116  /**
117   * {@inheritDoc}
118   */
119  @Override()
120  public void writeSearchResultEntry(@NotNull final SearchResultEntry entry)
121  {
122    try
123    {
124      for (final Attribute a : entry.getAttributes())
125      {
126        for (final byte[] value : a.getValueByteArrays())
127        {
128          getPrintStream().write(value);
129          getPrintStream().write(StaticUtils.EOL_BYTES);
130        }
131      }
132    }
133    catch (final Exception e)
134    {
135      Debug.debugException(e);
136      throw new LDAPRuntimeException(new LDAPException(ResultCode.OTHER,
137           ERR_VALUES_ONLY_OUTPUT_FORMAT_WRITE_ERROR.get(
138                StaticUtils.getExceptionMessage(e)),
139           e));
140    }
141  }
142
143
144
145  /**
146   * {@inheritDoc}
147   */
148  @Override()
149  public void writeSearchResultReference(
150                   @NotNull final SearchResultReference ref)
151  {
152    // No output is needed for search result reference messages.
153  }
154
155
156
157  /**
158   * {@inheritDoc}
159   */
160  @Override()
161  public void writeResult(@NotNull final LDAPResult result)
162  {
163    getPrintStream().flush();
164  }
165
166
167
168  /**
169   * {@inheritDoc}
170   */
171  @Override()
172  public void writeUnsolicitedNotification(
173                   @NotNull final LDAPConnection connection,
174                   @NotNull final ExtendedResult notification)
175  {
176    getPrintStream().flush();
177  }
178}