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 *      Portions Copyright 2010-2023 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.api;
028
029
030
031import com.unboundid.directory.sdk.broker.internal.BrokerExtension;
032import com.unboundid.directory.sdk.ds.internal.DirectoryServerExtension;
033import com.unboundid.directory.sdk.metrics.internal.MetricsEngineExtension;
034import com.unboundid.directory.sdk.proxy.internal.DirectoryProxyServerExtension;
035import com.unboundid.directory.sdk.sync.internal.SynchronizationServerExtension;
036import com.unboundid.ldap.sdk.LDAPException;
037import com.unboundid.util.Extensible;
038import com.unboundid.util.ThreadSafety;
039import com.unboundid.util.ThreadSafetyLevel;
040
041
042
043/**
044 * This interface defines a set of methods that may be implemented by a thread
045 * which should be run in the server.  If an extension needs to create one or
046 * more threads, then those threads should implement this interface and they
047 * should be created using the
048 * {@link com.unboundid.directory.sdk.common.types.ServerContext#createThread}
049 * method.
050 */
051@Extensible()
052@DirectoryServerExtension()
053@DirectoryProxyServerExtension(appliesToLocalContent=true,
054     appliesToRemoteContent=false)
055@SynchronizationServerExtension(appliesToLocalContent=true,
056     appliesToSynchronizedContent=false)
057@MetricsEngineExtension()
058@BrokerExtension()
059@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
060public interface ServerThread
061{
062  /**
063   * Performs the actual processing for this thread.  When this method returns,
064   * the thread will stop running.
065   *
066   * @throws  LDAPException  If the thread does not complete successfully.
067   */
068  void runThread()
069       throws LDAPException;
070}