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.ds.types;
028    
029    
030    
031    import com.unboundid.util.NotExtensible;
032    import com.unboundid.util.ThreadSafety;
033    import com.unboundid.util.ThreadSafetyLevel;
034    
035    
036    
037    /**
038     * This interface defines a set of methods that may be used to interact with a
039     * change subscription that has been defined in the server.
040     */
041    @NotExtensible()
042    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
043    public interface ChangeSubscription
044    {
045      /**
046       * Retrieves the name of this change subscription.
047       *
048       * @return  The name of this change subscription.
049       */
050      String getName();
051    
052    
053    
054      /**
055       * Retrieves the DN of the configuration entry defining this change
056       * subscription.
057       *
058       * @return  The DN of the configuration entry defining this change
059       *          subscription.
060       */
061      String getDN();
062    
063    
064    
065      /**
066       * Retrieves the expiration time for this change subscription.    The value
067       * returned will be an offset in milliseconds since 12:00 a.m. on January 1,
068       * 1970.
069       *
070       * @return  The expiration time for this change subscription, or
071       *          {@code Long.MAX_VALUE} if none is defined.
072       */
073      long getExpirationTime();
074    }