Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2008-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2008-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.examples;
import java.io.OutputStream;
import java.io.Serializable;
import java.text.ParseException;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import com.unboundid.ldap.sdk.CompareRequest;
import com.unboundid.ldap.sdk.CompareResult;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.DN;
import com.unboundid.ldap.sdk.LDAPConnection;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.ldap.sdk.Version;
import com.unboundid.util.Base64;
import com.unboundid.util.Debug;
import com.unboundid.util.LDAPCommandLineTool;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.args.ArgumentException;
import com.unboundid.util.args.ArgumentParser;
import com.unboundid.util.args.ControlArgument;
/**
* This class provides a simple tool that can be used to perform compare
* operations in an LDAP directory server. All of the necessary information is
* provided using command line arguments. Supported arguments include those
* allowed by the {@link LDAPCommandLineTool} class. In addition, a set of at
* least two unnamed trailing arguments must be given. The first argument
* should be a string containing the name of the target attribute followed by a
* colon and the assertion value to use for that attribute (e.g.,
* "cn:john doe"). Alternately, the attribute name may be followed by two
* colons and the base64-encoded representation of the assertion value
* (e.g., "cn:: am9obiBkb2U="). Any subsequent trailing arguments will be the
* DN(s) of entries in which to perform the compare operation(s).
*
* Some of the APIs demonstrated by this example include:
*
*
Argument Parsing (from the {@code com.unboundid.util.args}
* package)
*
LDAP Command-Line Tool (from the {@code com.unboundid.util}
* package)
*
LDAP Communication (from the {@code com.unboundid.ldap.sdk}
* package)
*
*/
@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
public final class LDAPCompare
extends LDAPCommandLineTool
implements Serializable
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 719069383330181184L;
// The argument parser for this tool.
@Nullable private ArgumentParser parser;
// The argument used to specify any bind controls that should be used.
@Nullable private ControlArgument bindControls;
// The argument used to specify any compare controls that should be used.
@Nullable private ControlArgument compareControls;
/**
* Parse the provided command line arguments and make the appropriate set of
* changes.
*
* @param args The command line arguments provided to this program.
*/
public static void main(@NotNull final String[] args)
{
final ResultCode resultCode = main(args, System.out, System.err);
if (resultCode != ResultCode.SUCCESS)
{
System.exit(resultCode.intValue());
}
}
/**
* Parse the provided command line arguments and make the appropriate set of
* changes.
*
* @param args The command line arguments provided to this program.
* @param outStream The output stream to which standard out should be
* written. It may be {@code null} if output should be
* suppressed.
* @param errStream The output stream to which standard error should be
* written. It may be {@code null} if error messages
* should be suppressed.
*
* @return A result code indicating whether the processing was successful.
*/
@NotNull()
public static ResultCode main(@NotNull final String[] args,
@Nullable final OutputStream outStream,
@Nullable final OutputStream errStream)
{
final LDAPCompare ldapCompare = new LDAPCompare(outStream, errStream);
return ldapCompare.runTool(args);
}
/**
* Creates a new instance of this tool.
*
* @param outStream The output stream to which standard out should be
* written. It may be {@code null} if output should be
* suppressed.
* @param errStream The output stream to which standard error should be
* written. It may be {@code null} if error messages
* should be suppressed.
*/
public LDAPCompare(@Nullable final OutputStream outStream,
@Nullable final OutputStream errStream)
{
super(outStream, errStream);
}
/**
* Retrieves the name for this tool.
*
* @return The name for this tool.
*/
@Override()
@NotNull()
public String getToolName()
{
return "ldapcompare";
}
/**
* Retrieves the description for this tool.
*
* @return The description for this tool.
*/
@Override()
@NotNull()
public String getToolDescription()
{
return "Perform LDAP compare operations in an LDAP directory server.";
}
/**
* Retrieves the version string for this tool.
*
* @return The version string for this tool.
*/
@Override()
@NotNull()
public String getToolVersion()
{
return Version.NUMERIC_VERSION_STRING;
}
/**
* Retrieves the minimum number of unnamed trailing arguments that are
* required.
*
* @return Two, to indicate that at least two trailing arguments
* (representing the attribute value assertion and at least one entry
* DN) must be provided.
*/
@Override()
public int getMinTrailingArguments()
{
return 2;
}
/**
* Retrieves the maximum number of unnamed trailing arguments that are
* allowed.
*
* @return A negative value to indicate that any number of trailing arguments
* may be provided.
*/
@Override()
public int getMaxTrailingArguments()
{
return -1;
}
/**
* Retrieves a placeholder string that may be used to indicate what kinds of
* trailing arguments are allowed.
*
* @return A placeholder string that may be used to indicate what kinds of
* trailing arguments are allowed.
*/
@Override()
@NotNull()
public String getTrailingArgumentsPlaceholder()
{
return "attr:value dn1 [dn2 [dn3 [...]]]";
}
/**
* Indicates whether this tool should provide support for an interactive mode,
* in which the tool offers a mode in which the arguments can be provided in
* a text-driven menu rather than requiring them to be given on the command
* line. If interactive mode is supported, it may be invoked using the
* "--interactive" argument. Alternately, if interactive mode is supported
* and {@link #defaultsToInteractiveMode()} returns {@code true}, then
* interactive mode may be invoked by simply launching the tool without any
* arguments.
*
* @return {@code true} if this tool supports interactive mode, or
* {@code false} if not.
*/
@Override()
public boolean supportsInteractiveMode()
{
return true;
}
/**
* Indicates whether this tool defaults to launching in interactive mode if
* the tool is invoked without any command-line arguments. This will only be
* used if {@link #supportsInteractiveMode()} returns {@code true}.
*
* @return {@code true} if this tool defaults to using interactive mode if
* launched without any command-line arguments, or {@code false} if
* not.
*/
@Override()
public boolean defaultsToInteractiveMode()
{
return true;
}
/**
* Indicates whether this tool should provide arguments for redirecting output
* to a file. If this method returns {@code true}, then the tool will offer
* an "--outputFile" argument that will specify the path to a file to which
* all standard output and standard error content will be written, and it will
* also offer a "--teeToStandardOut" argument that can only be used if the
* "--outputFile" argument is present and will cause all output to be written
* to both the specified output file and to standard output.
*
* @return {@code true} if this tool should provide arguments for redirecting
* output to a file, or {@code false} if not.
*/
@Override()
protected boolean supportsOutputFile()
{
return true;
}
/**
* Indicates whether this tool should default to interactively prompting for
* the bind password if a password is required but no argument was provided
* to indicate how to get the password.
*
* @return {@code true} if this tool should default to interactively
* prompting for the bind password, or {@code false} if not.
*/
@Override()
protected boolean defaultToPromptForBindPassword()
{
return true;
}
/**
* Indicates whether this tool supports the use of a properties file for
* specifying default values for arguments that aren't specified on the
* command line.
*
* @return {@code true} if this tool supports the use of a properties file
* for specifying default values for arguments that aren't specified
* on the command line, or {@code false} if not.
*/
@Override()
public boolean supportsPropertiesFile()
{
return true;
}
/**
* Indicates whether this tool supports the ability to generate a debug log
* file. If this method returns {@code true}, then the tool will expose
* additional arguments that can control debug logging.
*
* @return {@code true} if this tool supports the ability to generate a debug
* log file, or {@code false} if not.
*/
@Override()
protected boolean supportsDebugLogging()
{
return true;
}
/**
* Indicates whether the LDAP-specific arguments should include alternate
* versions of all long identifiers that consist of multiple words so that
* they are available in both camelCase and dash-separated versions.
*
* @return {@code true} if this tool should provide multiple versions of
* long identifiers for LDAP-specific arguments, or {@code false} if
* not.
*/
@Override()
protected boolean includeAlternateLongIdentifiers()
{
return true;
}
/**
* Indicates whether this tool should provide a command-line argument that
* allows for low-level SSL debugging. If this returns {@code true}, then an
* "--enableSSLDebugging}" argument will be added that sets the
* "javax.net.debug" system property to "all" before attempting any
* communication.
*
* @return {@code true} if this tool should offer an "--enableSSLDebugging"
* argument, or {@code false} if not.
*/
@Override()
protected boolean supportsSSLDebugging()
{
return true;
}
/**
* Adds the arguments used by this program that aren't already provided by the
* generic {@code LDAPCommandLineTool} framework.
*
* @param parser The argument parser to which the arguments should be added.
*
* @throws ArgumentException If a problem occurs while adding the arguments.
*/
@Override()
public void addNonLDAPArguments(@NotNull final ArgumentParser parser)
throws ArgumentException
{
// Save a reference to the argument parser.
this.parser = parser;
String description =
"Information about a control to include in the bind request.";
bindControls = new ControlArgument(null, "bindControl", false, 0, null,
description);
bindControls.addLongIdentifier("bind-control", true);
parser.addArgument(bindControls);
description = "Information about a control to include in compare requests.";
compareControls = new ControlArgument('J', "control", false, 0, null,
description);
parser.addArgument(compareControls);
}
/**
* {@inheritDoc}
*/
@Override()
public void doExtendedNonLDAPArgumentValidation()
throws ArgumentException
{
// There must have been at least two trailing arguments provided. The first
// must be in the form "attr:value". All subsequent trailing arguments
// must be parsable as valid DNs.
final List trailingArgs = parser.getTrailingArguments();
if (trailingArgs.size() < 2)
{
throw new ArgumentException("At least two trailing argument must be " +
"provided to specify the assertion criteria in the form " +
"'attr:value'. All additional trailing arguments must be the " +
"DNs of the entries against which to perform the compare.");
}
final Iterator argIterator = trailingArgs.iterator();
final String ava = argIterator.next();
if (ava.indexOf(':') < 1)
{
throw new ArgumentException("The first trailing argument value must " +
"specify the assertion criteria in the form 'attr:value'.");
}
while (argIterator.hasNext())
{
final String arg = argIterator.next();
try
{
new DN(arg);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new ArgumentException(
"Unable to parse trailing argument '" + arg + "' as a valid DN.",
e);
}
}
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
protected List getBindControls()
{
return bindControls.getValues();
}
/**
* Performs the actual processing for this tool. In this case, it gets a
* connection to the directory server and uses it to perform the requested
* comparisons.
*
* @return The result code for the processing that was performed.
*/
@Override()
@NotNull()
public ResultCode doToolProcessing()
{
// Make sure that at least two trailing arguments were provided, which will
// be the attribute value assertion and at least one entry DN.
final List trailingArguments = parser.getTrailingArguments();
if (trailingArguments.isEmpty())
{
err("No attribute value assertion was provided.");
err();
err(parser.getUsageString(StaticUtils.TERMINAL_WIDTH_COLUMNS - 1));
return ResultCode.PARAM_ERROR;
}
else if (trailingArguments.size() == 1)
{
err("No target entry DNs were provided.");
err();
err(parser.getUsageString(StaticUtils.TERMINAL_WIDTH_COLUMNS - 1));
return ResultCode.PARAM_ERROR;
}
// Parse the attribute value assertion.
final String avaString = trailingArguments.get(0);
final int colonPos = avaString.indexOf(':');
if (colonPos <= 0)
{
err("Malformed attribute value assertion.");
err();
err(parser.getUsageString(StaticUtils.TERMINAL_WIDTH_COLUMNS - 1));
return ResultCode.PARAM_ERROR;
}
final String attributeName = avaString.substring(0, colonPos);
final byte[] assertionValueBytes;
final int doubleColonPos = avaString.indexOf("::");
if (doubleColonPos == colonPos)
{
// There are two colons, so it's a base64-encoded assertion value.
try
{
assertionValueBytes = Base64.decode(avaString.substring(colonPos+2));
}
catch (final ParseException pe)
{
err("Unable to base64-decode the assertion value: ",
pe.getMessage());
err();
err(parser.getUsageString(StaticUtils.TERMINAL_WIDTH_COLUMNS - 1));
return ResultCode.PARAM_ERROR;
}
}
else
{
// There is only a single colon, so it's a simple UTF-8 string.
assertionValueBytes =
StaticUtils.getBytes(avaString.substring(colonPos+1));
}
// Get the connection to the directory server.
final LDAPConnection connection;
try
{
connection = getConnection();
out("Connected to ", connection.getConnectedAddress(), ':',
connection.getConnectedPort());
}
catch (final LDAPException le)
{
err("Error connecting to the directory server: ", le.getMessage());
return le.getResultCode();
}
// For each of the target entry DNs, process the compare.
ResultCode resultCode = ResultCode.SUCCESS;
CompareRequest compareRequest = null;
for (int i=1; i < trailingArguments.size(); i++)
{
final String targetDN = trailingArguments.get(i);
if (compareRequest == null)
{
compareRequest = new CompareRequest(targetDN, attributeName,
assertionValueBytes);
compareRequest.setControls(compareControls.getValues());
}
else
{
compareRequest.setDN(targetDN);
}
try
{
out("Processing compare request for entry ", targetDN);
final CompareResult result = connection.compare(compareRequest);
if (result.compareMatched())
{
out("The compare operation matched.");
}
else
{
out("The compare operation did not match.");
}
}
catch (final LDAPException le)
{
resultCode = le.getResultCode();
err("An error occurred while processing the request: ",
le.getMessage());
err("Result Code: ", le.getResultCode().intValue(), " (",
le.getResultCode().getName(), ')');
if (le.getMatchedDN() != null)
{
err("Matched DN: ", le.getMatchedDN());
}
if (le.getReferralURLs() != null)
{
for (final String url : le.getReferralURLs())
{
err("Referral URL: ", url);
}
}
}
out();
}
// Close the connection to the directory server and exit.
connection.close();
out();
out("Disconnected from the server");
return resultCode;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public LinkedHashMap getExampleUsages()
{
final LinkedHashMap examples =
new LinkedHashMap<>(StaticUtils.computeMapCapacity(1));
final String[] args =
{
"--hostname", "server.example.com",
"--port", "389",
"--bindDN", "uid=admin,dc=example,dc=com",
"--bindPassword", "password",
"givenName:John",
"uid=jdoe,ou=People,dc=example,dc=com"
};
final String description =
"Attempt to determine whether the entry for user " +
"'uid=jdoe,ou=People,dc=example,dc=com' has a value of 'John' for " +
"the givenName attribute.";
examples.put(args, description);
return examples;
}
}
