001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2010-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.ds.types;
028
029
030
031import com.unboundid.directory.sdk.common.types.Entry;
032import com.unboundid.util.NotExtensible;
033import com.unboundid.util.ThreadSafety;
034import com.unboundid.util.ThreadSafetyLevel;
035
036
037
038/**
039 * This interface may be used to obtain information about an administrative
040 * task which is being processed.
041 */
042@NotExtensible()
043@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
044public interface TaskContext
045{
046  /**
047   * Retrieves the DN of the entry that contains the definition for this task.
048   *
049   * @return  The DN of the entry that contains the definition for this task.
050   */
051  String getTaskEntryDN();
052
053
054
055  /**
056   * Retrieves a read-only copy of the entry that contains the definition for
057   * this task.
058   *
059   * @return  A read-only copy of the entry that contains the definition for
060   *          this task.
061   */
062  Entry getTaskEntry();
063
064
065
066  /**
067   * Retrieves the unique identifier for this task.
068   *
069   * @return  The unique identifier for this task.
070   */
071  String getTaskID();
072
073
074
075  /**
076   * Retrieves information about the server in which the task is being
077   * processed.
078   *
079   * @return  Information about the server in which the task is being processed.
080   */
081  DirectoryServerContext getServerContext();
082}