001    /*
002     * The MIT License
003     * Copyright (c) 2012 Microsoft Corporation
004     *
005     * Permission is hereby granted, free of charge, to any person obtaining a copy
006     * of this software and associated documentation files (the "Software"), to deal
007     * in the Software without restriction, including without limitation the rights
008     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009     * copies of the Software, and to permit persons to whom the Software is
010     * furnished to do so, subject to the following conditions:
011     *
012     * The above copyright notice and this permission notice shall be included in
013     * all copies or substantial portions of the Software.
014     *
015     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021     * THE SOFTWARE.
022     */
023    
024    package microsoft.exchange.webservices.data.notification;
025    
026    import microsoft.exchange.webservices.data.core.ExchangeService;
027    import microsoft.exchange.webservices.data.misc.AsyncCallback;
028    import microsoft.exchange.webservices.data.misc.IAsyncResult;
029    
030    /**
031     * Represents a streaming subscription.
032     */
033    public final class StreamingSubscription extends SubscriptionBase {
034    
035      public StreamingSubscription(ExchangeService service) throws Exception {
036        super(service);
037      }
038    
039      /**
040       * Unsubscribes from the streaming subscription.
041       */
042      public void unsubscribe() throws Exception {
043        this.getService().unsubscribe(this.getId());
044      }
045    
046      /**
047       * Begins an asynchronous request to unsubscribe from the streaming subscription.
048       *
049       * @param callback The AsyncCallback delegate.
050       * @param state    An object that contains state information for this request.
051       * @return An IAsyncResult that references the asynchronous request.
052       * @throws Exception
053       */
054      public IAsyncResult beginUnsubscribe(AsyncCallback callback, Object state) throws Exception {
055        return this.getService().beginUnsubscribe(callback, state, this.getId());
056      }
057    
058      /**
059       * Ends an asynchronous request to unsubscribe from the streaming subscription.
060       *
061       * @param asyncResult An IAsyncResult that references the asynchronous request.
062       */
063      public void endUnsubscribe(IAsyncResult asyncResult) throws Exception {
064        this.getService().endUnsubscribe(asyncResult);
065      }
066    
067      /**
068       * Gets the service used to create this subscription.
069       */
070      public ExchangeService getService() {
071        return super.getService();
072      }
073    
074    
075      /**
076       * Gets a value indicating whether this subscription uses watermarks.
077       */
078      @Override
079      protected boolean getUsesWatermark() {
080        return false;
081      }
082    }