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-2019 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2019 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.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.util.NotMutable;
import com.unboundid.util.StaticUtils;
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 shut down or
* restart the server.
*
*
* 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:
*
*
A flag that indicates whether to shut down the server or to perform
* an in-core restart (in which the server shuts down and restarts itself
* within the same JVM).
*
An optional message that can be used to provide a reason for the
* shutdown or restart.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class ShutdownTask
extends Task
{
/**
* The fully-qualified name of the Java class that is used for the shutdown
* task.
*/
static final String SHUTDOWN_TASK_CLASS =
"com.unboundid.directory.server.tasks.ShutdownTask";
/**
* The name of the attribute used to define a shutdown message.
*/
private static final String ATTR_SHUTDOWN_MESSAGE =
"ds-task-shutdown-message";
/**
* The name of the attribute used to indicate whether to restart rather than
* shut down the server.
*/
private static final String ATTR_RESTART_SERVER =
"ds-task-restart-server";
/**
* The name of the object class used in shutdown task entries.
*/
private static final String OC_SHUTDOWN_TASK = "ds-task-shutdown";
/**
* The task property for the shutdown message.
*/
private static final TaskProperty PROPERTY_SHUTDOWN_MESSAGE =
new TaskProperty(ATTR_SHUTDOWN_MESSAGE,
INFO_DISPLAY_NAME_SHUTDOWN_MESSAGE.get(),
INFO_DESCRIPTION_SHUTDOWN_MESSAGE.get(), String.class,
false, false, false);
/**
* The task property for the restart server flag.
*/
private static final TaskProperty PROPERTY_RESTART_SERVER =
new TaskProperty(ATTR_RESTART_SERVER,
INFO_DISPLAY_NAME_RESTART_SERVER.get(),
INFO_DESCRIPTION_RESTART_SERVER.get(), Boolean.class,
false, false, false);
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -5332685779844073667L;
// Indicates whether to restart the server rather than shut it down.
private final boolean restartServer;
// A message that describes the reason for the shutdown.
private final String shutdownMessage;
/**
* Creates a new uninitialized shutdown 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 ShutdownTask()
{
shutdownMessage = null;
restartServer = false;
}
/**
* Creates a new shutdown 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 shutdownMessage A message that describes the reason for the
* shutdown. It may be {@code null}.
* @param restartServer Indicates whether to restart the server rather
* than shut it down.
*/
public ShutdownTask(final String taskID, final String shutdownMessage,
final boolean restartServer)
{
this(taskID, shutdownMessage, restartServer, null, null, null, null, null);
}
/**
* Creates a new shutdown 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 shutdownMessage A message that describes the reason for the
* shutdown. It may be {@code null}.
* @param restartServer Indicates whether to restart the server
* rather than shut it down.
* @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 ShutdownTask(final String taskID, final String shutdownMessage,
final boolean restartServer,
final Date scheduledStartTime,
final List dependencyIDs,
final FailedDependencyAction failedDependencyAction,
final List notifyOnCompletion,
final List notifyOnError)
{
this(taskID, shutdownMessage, restartServer, scheduledStartTime,
dependencyIDs, failedDependencyAction, null, notifyOnCompletion,
null, notifyOnError, null, null, null);
}
/**
* Creates a new shutdown 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 shutdownMessage A message that describes the reason for the
* shutdown. It may be {@code null}.
* @param restartServer Indicates whether to restart the server
* rather than shut it down.
* @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 ShutdownTask(final String taskID, final String shutdownMessage,
final boolean restartServer,
final Date scheduledStartTime,
final List dependencyIDs,
final FailedDependencyAction failedDependencyAction,
final List notifyOnStart,
final List notifyOnCompletion,
final List notifyOnSuccess,
final List notifyOnError,
final Boolean alertOnStart, final Boolean alertOnSuccess,
final Boolean alertOnError)
{
super(taskID, SHUTDOWN_TASK_CLASS, scheduledStartTime, dependencyIDs,
failedDependencyAction, notifyOnStart, notifyOnCompletion,
notifyOnSuccess, notifyOnError, alertOnStart, alertOnSuccess,
alertOnError);
this.shutdownMessage = shutdownMessage;
this.restartServer = restartServer;
}
/**
* Creates a new shutdown task from the provided entry.
*
* @param entry The entry to use to create this shutdown task.
*
* @throws TaskException If the provided entry cannot be parsed as a
* shutdown task entry.
*/
public ShutdownTask(final Entry entry)
throws TaskException
{
super(entry);
// Get the shutdown message. It may be absent.
shutdownMessage = entry.getAttributeValue(ATTR_SHUTDOWN_MESSAGE);
// Get the restart server flag. It may be absent.
restartServer = parseBooleanValue(entry, ATTR_RESTART_SERVER, false);
}
/**
* Creates a new shutdown 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 shutdown task.
*/
public ShutdownTask(final Map> properties)
throws TaskException
{
super(SHUTDOWN_TASK_CLASS, properties);
boolean r = false;
String m = null;
for (final Map.Entry> entry :
properties.entrySet())
{
final TaskProperty p = entry.getKey();
final String attrName = p.getAttributeName();
final List
