GetItemsRequest.java

  1. /**
  2.  *
  3.  * Copyright the original author or authors
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.jivesoftware.smackx.pubsub;

  18. import org.jivesoftware.smack.util.XmlStringBuilder;

  19. /**
  20.  * Represents a request to subscribe to a node.
  21.  *
  22.  * @author Robin Collier
  23.  */
  24. public class GetItemsRequest extends NodeExtension {
  25.     protected final String subId;
  26.     protected final int maxItems;

  27.     public GetItemsRequest(String nodeId) {
  28.         this(nodeId, null, -1);
  29.     }

  30.     public GetItemsRequest(String nodeId, String subscriptionId) {
  31.         this(nodeId, subscriptionId, -1);
  32.     }

  33.     public GetItemsRequest(String nodeId, int maxItemsToReturn) {
  34.         this(nodeId, null, maxItemsToReturn);
  35.     }

  36.     public GetItemsRequest(String nodeId, String subscriptionId, int maxItemsToReturn) {
  37.         super(PubSubElementType.ITEMS, nodeId);
  38.         maxItems = maxItemsToReturn;
  39.         subId = subscriptionId;
  40.     }

  41.     public String getSubscriptionId() {
  42.         return subId;
  43.     }

  44.     public int getMaxItems() {
  45.         return maxItems;
  46.     }

  47.     @Override
  48.     protected void addXml(XmlStringBuilder xml) {
  49.         xml.optAttribute("subid", getSubscriptionId());
  50.         xml.optIntAttribute("max_items", getMaxItems());
  51.         xml.closeEmptyElement();
  52.     }
  53. }