com.unboundid.ldap.sdk.unboundidds.tasks.ReloadHTTPConnectionHandlerCertificatesTask Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2018-2022 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2018-2022 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) 2018-2022 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.Collections;
import java.util.Date;
import java.util.List;
import java.util.Map;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.unboundidds.tasks.TaskMessages.*;
/**
* This class defines a Directory Server task that can be used to request that
* the server should dynamically reload all key and trust manager providers
* associated with all HTTP connection handlers configured with support for
* HTTPS. Note that this may cause problems with a client's ability to resume a
* TLS session that was created before the reload.
*
*
* 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 reload HTTP connection handler certificates task does not have any
* task-specific properties.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class ReloadHTTPConnectionHandlerCertificatesTask
extends Task
{
/**
* The fully-qualified name of the Java class in the server that is used for
* the reload HTTP connection handler certificates task.
*/
@NotNull static final String
RELOAD_HTTP_CONNECTION_HANDLER_CERTIFICATES_TASK_CLASS =
"com.unboundid.directory.server.tasks." +
"ReloadHTTPConnectionHandlerCertificatesTask";
/**
* The name of the object class used in reload HTTP connection handler
* certificates task entries.
*/
@NotNull private static final String
OC_RELOAD_HTTP_CONNECTION_HANDLER_CERTIFICATES_TASK =
"ds-task-reload-http-connection-handler-certificates";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 842594962305532389L;
/**
* Creates a new uninitialized reload HTTP connection handler certificates
* task instance that should only be used for obtaining general information
* about this task, including the task name, description, and supported
* properties.
*/
public ReloadHTTPConnectionHandlerCertificatesTask()
{
this(null, null, null, null, null, null);
}
/**
* Creates a new reload HTTP connection handler certificates 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.
*/
public ReloadHTTPConnectionHandlerCertificatesTask(
@Nullable final String taskID)
{
this(taskID, null, null, null, null, null);
}
/**
* Creates a new reload HTTP connection handler certificates 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 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 ReloadHTTPConnectionHandlerCertificatesTask(
@Nullable final String taskID,
@Nullable final Date scheduledStartTime,
@Nullable final List dependencyIDs,
@Nullable final FailedDependencyAction failedDependencyAction,
@Nullable final List notifyOnCompletion,
@Nullable final List notifyOnError)
{
this(taskID, scheduledStartTime, dependencyIDs, failedDependencyAction,
null, notifyOnCompletion, null, notifyOnError, null, null, null);
}
/**
* Creates a new reload HTTP connection handler certificates 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 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 ReloadHTTPConnectionHandlerCertificatesTask(
@Nullable final String taskID,
@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, RELOAD_HTTP_CONNECTION_HANDLER_CERTIFICATES_TASK_CLASS,
scheduledStartTime, dependencyIDs, failedDependencyAction,
notifyOnStart, notifyOnCompletion, notifyOnSuccess, notifyOnError,
alertOnStart, alertOnSuccess, alertOnError);
}
/**
* Creates a new reload HTTP connection handler certificates task from the
* provided entry.
*
* @param entry The entry to use to create this reload HTTP connection
* handler certificates task.
*
* @throws TaskException If the provided entry cannot be parsed as a reload
* HTTP connection handler certificates task entry.
*/
public ReloadHTTPConnectionHandlerCertificatesTask(
@NotNull final Entry entry)
throws TaskException
{
super(entry);
}
/**
* Creates a new reload HTTP connection handler certificates 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 reload HTTP connection handler
* certificates task.
*/
public ReloadHTTPConnectionHandlerCertificatesTask(
@NotNull final Map> properties)
throws TaskException
{
super(RELOAD_HTTP_CONNECTION_HANDLER_CERTIFICATES_TASK_CLASS, properties);
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getTaskName()
{
return INFO_TASK_NAME_RELOAD_HTTP_CONNECTION_HANDLER_CERTIFICATES.get();
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getTaskDescription()
{
return INFO_TASK_DESCRIPTION_RELOAD_HTTP_CONNECTION_HANDLER_CERTIFICATES.
get();
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
protected List getAdditionalObjectClasses()
{
return Collections.singletonList(
OC_RELOAD_HTTP_CONNECTION_HANDLER_CERTIFICATES_TASK);
}
}