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 2009-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2009-2021 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) 2009-2021 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.unboundidds.tasks;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.ldap.sdk.Filter;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.SearchScope;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
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.Validator;
import static com.unboundid.ldap.sdk.unboundidds.tasks.TaskMessages.*;
/**
* This class defines a Directory Server task that can be used to perform an
* internal search within the server and write the contents to an LDIF file.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*
* The properties that are available for use with this type of task include:
*
*
The base DN to use for the search. This is required.
*
The scope to use for the search. This is required.
*
The filter to use for the search. This is required.
*
The attributes to return. This is optional and multivalued.
*
The authorization DN to use for the search. This is optional.
*
The path to the output file to use. This is required.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class SearchTask
extends Task
{
/**
* The fully-qualified name of the Java class that is used for the search
* task.
*/
@NotNull static final String SEARCH_TASK_CLASS =
"com.unboundid.directory.server.tasks.SearchTask";
/**
* The name of the attribute used to specify the search base DN.
*/
@NotNull private static final String ATTR_BASE_DN = "ds-task-search-base-dn";
/**
* The name of the attribute used to specify the search scope.
*/
@NotNull private static final String ATTR_SCOPE = "ds-task-search-scope";
/**
* The name of the attribute used to specify the search filter.
*/
@NotNull private static final String ATTR_FILTER = "ds-task-search-filter";
/**
* The name of the attribute used to specify the attribute(s) to return.
*/
@NotNull private static final String ATTR_RETURN_ATTR =
"ds-task-search-return-attribute";
/**
* The name of the attribute used to specify the authorization DN.
*/
@NotNull private static final String ATTR_AUTHZ_DN =
"ds-task-search-authz-dn";
/**
* The name of the attribute used to specify the output file.
*/
@NotNull private static final String ATTR_OUTPUT_FILE =
"ds-task-search-output-file";
/**
* The name of the object class used in search task entries.
*/
@NotNull private static final String OC_SEARCH_TASK = "ds-task-search";
/**
* The task property that will be used for the base DN.
*/
@NotNull private static final TaskProperty PROPERTY_BASE_DN =
new TaskProperty(ATTR_BASE_DN,
INFO_SEARCH_TASK_DISPLAY_NAME_BASE_DN.get(),
INFO_SEARCH_TASK_DESCRIPTION_BASE_DN.get(), String.class, true,
false, false);
/**
* The allowed values for the scope property.
*/
@NotNull private static final Object[] ALLOWED_SCOPE_VALUES =
{
"base", "baseobject", "0",
"one", "onelevel", "singlelevel", "1",
"sub", "subtree", "wholesubtree", "2",
"subord", "subordinate", "subordinatesubtree", "3"
};
/**
* The task property that will be used for the scope.
*/
@NotNull private static final TaskProperty PROPERTY_SCOPE =
new TaskProperty(ATTR_SCOPE,
INFO_SEARCH_TASK_DISPLAY_NAME_SCOPE.get(),
INFO_SEARCH_TASK_DESCRIPTION_SCOPE.get(), String.class, true,
false, false, ALLOWED_SCOPE_VALUES);
/**
* The task property that will be used for the filter.
*/
@NotNull private static final TaskProperty PROPERTY_FILTER =
new TaskProperty(ATTR_FILTER,
INFO_SEARCH_TASK_DISPLAY_NAME_FILTER.get(),
INFO_SEARCH_TASK_DESCRIPTION_FILTER.get(), String.class, true,
false, false);
/**
* The task property that will be used for the requested attributes.
*/
@NotNull private static final TaskProperty PROPERTY_REQUESTED_ATTR =
new TaskProperty(ATTR_RETURN_ATTR,
INFO_SEARCH_TASK_DISPLAY_NAME_RETURN_ATTR.get(),
INFO_SEARCH_TASK_DESCRIPTION_RETURN_ATTR.get(), String.class, false,
true, false);
/**
* The task property that will be used for the authorization DN.
*/
@NotNull private static final TaskProperty PROPERTY_AUTHZ_DN =
new TaskProperty(ATTR_AUTHZ_DN,
INFO_SEARCH_TASK_DISPLAY_NAME_AUTHZ_DN.get(),
INFO_SEARCH_TASK_DESCRIPTION_AUTHZ_DN.get(), String.class, false,
false, true);
/**
* The task property that will be used for the output file.
*/
@NotNull private static final TaskProperty PROPERTY_OUTPUT_FILE =
new TaskProperty(ATTR_OUTPUT_FILE,
INFO_SEARCH_TASK_DISPLAY_NAME_OUTPUT_FILE.get(),
INFO_SEARCH_TASK_DESCRIPTION_NAME_OUTPUT_FILE.get(), String.class,
true, false, false);
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -1742374271508548328L;
// The search filter.
@NotNull private final Filter filter;
// The list of attributes to return.
@NotNull private final List attributes;
// The search scope.
@NotNull private final SearchScope scope;
// The authorization DN.
@Nullable private final String authzDN;
// The search base DN.
@NotNull private final String baseDN;
// The output file path.
@NotNull private final String outputFile;
/**
* Creates a new uninitialized search task instance which should only be used
* for obtaining general information about this task, including the task name,
* description, and supported properties. Attempts to use a task created with
* this constructor for any other reason will likely fail.
*/
public SearchTask()
{
filter = null;
attributes = null;
scope = null;
authzDN = null;
baseDN = null;
outputFile = null;
}
/**
* Creates a new search task with the provided information.
*
* @param taskID The task ID to use for this task. If it is
* {@code null} then a UUID will be generated for use as
* the task ID.
* @param baseDN The base DN to use for the search. It must not be
* {@code null}.
* @param scope The scope to use for the search. It must not be
* {@code null}.
* @param filter The filter to use for the search. It must not be
* {@code null}.
* @param attributes The list of attributes to include in matching entries.
* If it is {@code null} or empty, then all user
* attributes will be selected.
* @param outputFile The path to the file (on the server filesystem) to
* which the results should be written. It must not be
* {@code null}.
*/
public SearchTask(@Nullable final String taskID,
@NotNull final String baseDN,
@NotNull final SearchScope scope,
@NotNull final Filter filter,
@Nullable final List attributes,
@NotNull final String outputFile)
{
this(taskID, baseDN, scope, filter, attributes, outputFile, null, null,
null, null, null, null);
}
/**
* Creates a new search task with the provided information.
*
* @param taskID The task ID to use for this task. If it is
* {@code null} then a UUID will be generated for use as
* the task ID.
* @param baseDN The base DN to use for the search. It must not be
* {@code null}.
* @param scope The scope to use for the search. It must not be
* {@code null}.
* @param filter The filter to use for the search. It must not be
* {@code null}.
* @param attributes The list of attributes to include in matching entries.
* If it is {@code null} or empty, then all user
* attributes will be selected.
* @param outputFile The path to the file (on the server filesystem) to
* which the results should be written. It must not be
* {@code null}.
* @param authzDN The DN of the user as whom the search should be
* processed. If this is {@code null}, then it will be
* processed as an internal root user.
*/
public SearchTask(@Nullable final String taskID,
@NotNull final String baseDN,
@NotNull final SearchScope scope,
@NotNull final Filter filter,
@Nullable final List attributes,
@NotNull final String outputFile,
@Nullable final String authzDN)
{
this(taskID, baseDN, scope, filter, attributes, outputFile, authzDN, null,
null, null, null, null);
}
/**
* Creates a new search task with the provided information.
*
* @param taskID The task ID to use for this task. If it is
* {@code null} then a UUID will be generated
* for use as the task ID.
* @param baseDN The base DN to use for the search. It must
* not be {@code null}.
* @param scope The scope to use for the search. It must
* not be {@code null}.
* @param filter The filter to use for the search. It must
* not be {@code null}.
* @param attributes The list of attributes to include in
* matching entries. If it is {@code null} or
* empty, then all user attributes will be
* selected.
* @param outputFile The path to the file (on the server
* filesystem) to which the results should be
* written. It must not be {@code null}.
* @param authzDN The DN of the user as whom the search
* should be processed. If this is
* {@code null}, then it will be processed as
* an internal root user.
* @param scheduledStartTime The time that this task should start
* running.
* @param dependencyIDs The list of task IDs that will be required
* to complete before this task will be
* eligible to start.
* @param failedDependencyAction Indicates what action should be taken if
* any of the dependencies for this task do
* not complete successfully.
* @param notifyOnCompletion The list of e-mail addresses of individuals
* that should be notified when this task
* completes.
* @param notifyOnError The list of e-mail addresses of individuals
* that should be notified if this task does
* not complete successfully.
*/
public SearchTask(@Nullable final String taskID,
@NotNull final String baseDN,
@NotNull final SearchScope scope,
@NotNull final Filter filter,
@Nullable final List attributes,
@NotNull final String outputFile,
@Nullable final String authzDN,
@Nullable final Date scheduledStartTime,
@Nullable final List dependencyIDs,
@Nullable final FailedDependencyAction failedDependencyAction,
@Nullable final List notifyOnCompletion,
@Nullable final List notifyOnError)
{
this(taskID, baseDN, scope, filter, attributes, outputFile, authzDN,
scheduledStartTime, dependencyIDs, failedDependencyAction, null,
notifyOnCompletion, null, notifyOnError, null, null, null);
}
/**
* Creates a new search task with the provided information.
*
* @param taskID The task ID to use for this task. If it is
* {@code null} then a UUID will be generated
* for use as the task ID.
* @param baseDN The base DN to use for the search. It must
* not be {@code null}.
* @param scope The scope to use for the search. It must
* not be {@code null}.
* @param filter The filter to use for the search. It must
* not be {@code null}.
* @param attributes The list of attributes to include in
* matching entries. If it is {@code null} or
* empty, then all user attributes will be
* selected.
* @param outputFile The path to the file (on the server
* filesystem) to which the results should be
* written. It must not be {@code null}.
* @param authzDN The DN of the user as whom the search
* should be processed. If this is
* {@code null}, then it will be processed as
* an internal root user.
* @param scheduledStartTime The time that this task should start
* running.
* @param dependencyIDs The list of task IDs that will be required
* to complete before this task will be
* eligible to start.
* @param failedDependencyAction Indicates what action should be taken if
* any of the dependencies for this task do
* not complete successfully.
* @param notifyOnStart The list of e-mail addresses of individuals
* that should be notified when this task
* starts running.
* @param notifyOnCompletion The list of e-mail addresses of individuals
* that should be notified when this task
* completes.
* @param notifyOnSuccess The list of e-mail addresses of individuals
* that should be notified if this task
* completes successfully.
* @param notifyOnError The list of e-mail addresses of individuals
* that should be notified if this task does
* not complete successfully.
* @param alertOnStart Indicates whether the server should send an
* alert notification when this task starts.
* @param alertOnSuccess Indicates whether the server should send an
* alert notification if this task completes
* successfully.
* @param alertOnError Indicates whether the server should send an
* alert notification if this task fails to
* complete successfully.
*/
public SearchTask(@Nullable final String taskID,
@NotNull final String baseDN,
@NotNull final SearchScope scope,
@NotNull final Filter filter,
@Nullable final List attributes,
@NotNull final String outputFile,
@Nullable final String authzDN,
@Nullable final Date scheduledStartTime,
@Nullable final List dependencyIDs,
@Nullable final FailedDependencyAction failedDependencyAction,
@Nullable final List notifyOnStart,
@Nullable final List notifyOnCompletion,
@Nullable final List notifyOnSuccess,
@Nullable final List notifyOnError,
@Nullable final Boolean alertOnStart,
@Nullable final Boolean alertOnSuccess,
@Nullable final Boolean alertOnError)
{
super(taskID, SEARCH_TASK_CLASS, scheduledStartTime, dependencyIDs,
failedDependencyAction, notifyOnStart, notifyOnCompletion,
notifyOnSuccess, notifyOnError, alertOnStart, alertOnSuccess,
alertOnError);
Validator.ensureNotNull(baseDN, scope, filter, outputFile);
this.baseDN = baseDN;
this.scope = scope;
this.filter = filter;
this.outputFile = outputFile;
this.authzDN = authzDN;
if (attributes == null)
{
this.attributes = Collections.emptyList();
}
else
{
this.attributes = Collections.unmodifiableList(attributes);
}
}
/**
* Creates a new search task from the provided entry.
*
* @param entry The entry to use to create this search task.
*
* @throws TaskException If the provided entry cannot be parsed as a search
* task entry.
*/
public SearchTask(@NotNull final Entry entry)
throws TaskException
{
super(entry);
// Get the base DN. It must be present.
baseDN = entry.getAttributeValue(ATTR_BASE_DN);
if (baseDN == null)
{
throw new TaskException(ERR_SEARCH_TASK_ENTRY_NO_BASE_DN.get(
entry.getDN()));
}
// Get the scope. It must be present.
final String scopeStr =
StaticUtils.toLowerCase(entry.getAttributeValue(ATTR_SCOPE));
if (scopeStr == null)
{
throw new TaskException(ERR_SEARCH_TASK_ENTRY_NO_SCOPE.get(
entry.getDN()));
}
if (scopeStr.equals("base") || scopeStr.equals("baseobject") ||
scopeStr.equals("0"))
{
scope = SearchScope.BASE;
}
else if (scopeStr.equals("one") || scopeStr.equals("onelevel") ||
scopeStr.equals("singlelevel") || scopeStr.equals("1"))
{
scope = SearchScope.ONE;
}
else if (scopeStr.equals("sub") || scopeStr.equals("subtree") ||
scopeStr.equals("wholesubtree") || scopeStr.equals("2"))
{
scope = SearchScope.SUB;
}
else if (scopeStr.equals("subord") || scopeStr.equals("subordinate") ||
scopeStr.equals("subordinatesubtree") || scopeStr.equals("3"))
{
scope = SearchScope.SUBORDINATE_SUBTREE;
}
else
{
throw new TaskException(ERR_SEARCH_TASK_ENTRY_INVALID_SCOPE.get(
entry.getDN(), scopeStr));
}
// Get the filter. It must be present.
final String filterStr = entry.getAttributeValue(ATTR_FILTER);
if (filterStr == null)
{
throw new TaskException(ERR_SEARCH_TASK_ENTRY_NO_FILTER.get(
entry.getDN()));
}
try
{
filter = Filter.create(filterStr);
}
catch (final LDAPException le)
{
Debug.debugException(le);
throw new TaskException(ERR_SEARCH_TASK_ENTRY_INVALID_FILTER.get(
entry.getDN(), filterStr), le);
}
// Get the list of requested attributes. It is optional.
final String[] attrs = entry.getAttributeValues(ATTR_RETURN_ATTR);
if (attrs == null)
{
attributes = Collections.emptyList();
}
else
{
attributes = Collections.unmodifiableList(Arrays.asList(attrs));
}
// Get the authorization DN. It is optional.
authzDN = entry.getAttributeValue(ATTR_AUTHZ_DN);
// Get the path to the output file. It must be present.
outputFile = entry.getAttributeValue(ATTR_OUTPUT_FILE);
if (outputFile == null)
{
throw new TaskException(ERR_SEARCH_TASK_ENTRY_NO_OUTPUT_FILE.get(
entry.getDN()));
}
}
/**
* Creates a new search task from the provided set of task properties.
*
* @param properties The set of task properties and their corresponding
* values to use for the task. It must not be
* {@code null}.
*
* @throws TaskException If the provided set of properties cannot be used to
* create a valid add schema file task.
*/
public SearchTask(@NotNull final Map> properties)
throws TaskException
{
super(SEARCH_TASK_CLASS, properties);
Filter tmpFilter = null;
SearchScope tmpScope = null;
String tmpAuthzDN = null;
String tmpBaseDN = null;
String tmpFile = null;
String[] tmpAttrs = null;
for (final Map.Entry> entry :
properties.entrySet())
{
final TaskProperty p = entry.getKey();
final String attrName = StaticUtils.toLowerCase(p.getAttributeName());
final List
