001/*
002 * Copyright 2017-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2017-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) 2017-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;
041import java.util.ArrayList;
042
043import com.unboundid.ldap.sdk.ExtendedResult;
044import com.unboundid.ldap.sdk.LDAPConnection;
045import com.unboundid.ldap.sdk.LDAPResult;
046import com.unboundid.ldap.sdk.SearchResultEntry;
047import com.unboundid.ldap.sdk.SearchResultReference;
048import com.unboundid.util.NotNull;
049import com.unboundid.util.StaticUtils;
050import com.unboundid.util.ThreadSafety;
051import com.unboundid.util.ThreadSafetyLevel;
052
053
054
055/**
056 * This class provides an {@link LDAPResultWriter} instance that formats results
057 * in LDIF.
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 LDIFLDAPResultWriter
071       extends LDAPResultWriter
072{
073  // A list used to hold the lines for a formatted representation of a search
074  // result entry or reference.
075  @NotNull private final ArrayList<String> formattedLines;
076
077  // The maximum width to use for output content.
078  private final int maxWidth;
079
080  // A string builder used to hold the formatted representation of the lines
081  // that comprise a search result entry or reference.
082  @NotNull private final StringBuilder formattedLineBuffer;
083
084
085
086  /**
087   * Creates a new instance of this LDAP result writer.
088   *
089   * @param  outputStream  The output stream to which the output will be
090   *                       written.
091   * @param  maxWidth      The maximum width to use for the output.
092   */
093  public LDIFLDAPResultWriter(@NotNull final OutputStream outputStream,
094                              final int maxWidth)
095  {
096    super(outputStream);
097
098    this.maxWidth = maxWidth;
099
100    formattedLines = new ArrayList<>(20);
101    formattedLineBuffer = new StringBuilder(100);
102  }
103
104
105
106  /**
107   * {@inheritDoc}
108   */
109  @Override()
110  public void writeComment(@NotNull final String comment)
111  {
112    for (final String line : StaticUtils.wrapLine(comment, maxWidth - 2))
113    {
114      print("# ");
115      println(line);
116    }
117  }
118
119
120
121  /**
122   * {@inheritDoc}
123   */
124  @Override()
125  public void writeHeader()
126  {
127    // No header is required for this format.
128  }
129
130
131
132  /**
133   * {@inheritDoc}
134   */
135  @Override()
136  public void writeSearchResultEntry(@NotNull final SearchResultEntry entry)
137  {
138    formattedLines.clear();
139    formattedLineBuffer.setLength(0);
140
141    ResultUtils.formatSearchResultEntry(formattedLines, entry, maxWidth);
142    for (final String s : formattedLines)
143    {
144      formattedLineBuffer.append(s);
145      formattedLineBuffer.append(StaticUtils.EOL);
146    }
147
148    println(formattedLineBuffer.toString());
149  }
150
151
152
153  /**
154   * {@inheritDoc}
155   */
156  @Override()
157  public void writeSearchResultReference(
158                   @NotNull final SearchResultReference ref)
159  {
160    formattedLines.clear();
161    formattedLineBuffer.setLength(0);
162
163    ResultUtils.formatSearchResultReference(formattedLines, ref, maxWidth);
164    for (final String s : formattedLines)
165    {
166      formattedLineBuffer.append(s);
167      formattedLineBuffer.append(StaticUtils.EOL);
168    }
169
170    println(formattedLineBuffer.toString());
171  }
172
173
174
175  /**
176   * {@inheritDoc}
177   */
178  @Override()
179  public void writeResult(@NotNull final LDAPResult result)
180  {
181    formattedLines.clear();
182    formattedLineBuffer.setLength(0);
183
184    ResultUtils.formatResult(formattedLines, result, true, false, 0, maxWidth);
185    for (final String s : formattedLines)
186    {
187      formattedLineBuffer.append(s);
188      formattedLineBuffer.append(StaticUtils.EOL);
189    }
190    println(formattedLineBuffer.toString());
191  }
192
193
194
195  /**
196   * {@inheritDoc}
197   */
198  @Override()
199  public void writeUnsolicitedNotification(
200                   @NotNull final LDAPConnection connection,
201                   @NotNull final ExtendedResult notification)
202  {
203    formattedLines.clear();
204    formattedLineBuffer.setLength(0);
205
206    ResultUtils.formatUnsolicitedNotification(formattedLines, notification,
207         true, 0, maxWidth);
208    for (final String s : formattedLines)
209    {
210      formattedLineBuffer.append(s);
211      formattedLineBuffer.append(StaticUtils.EOL);
212    }
213    println(formattedLineBuffer.toString());
214  }
215}