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