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.core.request;
025    
026    import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
027    import microsoft.exchange.webservices.data.core.ExchangeService;
028    import microsoft.exchange.webservices.data.core.XmlElementNames;
029    import microsoft.exchange.webservices.data.core.response.SubscribeResponse;
030    import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
031    import microsoft.exchange.webservices.data.core.exception.misc.ArgumentException;
032    import microsoft.exchange.webservices.data.notification.StreamingSubscription;
033    
034    /**
035     * Defines the SubscribeToStreamingNotificationsRequest class.
036     */
037    public class SubscribeToStreamingNotificationsRequest extends
038        SubscribeRequest<StreamingSubscription> {
039    
040      /**
041       * Initializes a new instance of the
042       * SubscribeToStreamingNotificationsRequest class.
043       *
044       * @param service The service
045       * @throws Exception
046       */
047      public SubscribeToStreamingNotificationsRequest(ExchangeService service)
048          throws Exception {
049        super(service);
050      }
051    
052      /**
053       * Validate request.
054       *
055       * @throws Exception
056       */
057      @Override
058      protected void validate() throws Exception {
059        super.validate();
060    
061        if (!(this.getWatermark() == null || this.getWatermark().isEmpty())) {
062          throw new ArgumentException(
063              "Watermarks cannot be used with StreamingSubscriptions.");
064        }
065      }
066    
067    
068      /**
069       * Gets the name of the subscription XML element.
070       *
071       * @return XmlElementsNames
072       */
073      @Override
074      protected String getSubscriptionXmlElementName() {
075        return XmlElementNames.StreamingSubscriptionRequest;
076      }
077    
078      /**
079       * Internals the write elements to XML.
080       *
081       * @param writer The writer
082       */
083      @Override
084      protected void internalWriteElementsToXml(EwsServiceXmlWriter writer) {
085      }
086    
087      /**
088       * Creates the service response.
089       *
090       * @param service       The service
091       * @param responseIndex The responseIndex
092       * @return SubscribeResponse
093       * @throws Exception
094       */
095      @Override
096      protected SubscribeResponse<StreamingSubscription> createServiceResponse(ExchangeService service,
097          int responseIndex) throws Exception {
098        return new SubscribeResponse<StreamingSubscription>(
099            new StreamingSubscription(service));
100      }
101    
102      /**
103       * Gets the request version.
104       *
105       * @return ExchangeVersion
106       */
107      @Override
108      protected ExchangeVersion getMinimumRequiredServerVersion() {
109        return ExchangeVersion.Exchange2010_SP1;
110      }
111    }