src/net/pterodactylus/fcp/SubscribeUSK.java

   1 /*
   2  * jSite2 - SubscribeUSK.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp;
  21
  22 /**
  23  * With a “SubscribeUSK” a client requests to be notified if the edition number
  24  * of a USK changes.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  * @version $Id$
  28  */
  29 public class SubscribeUSK extends FcpMessage {
  30
  31         /**
  32          * Creates a new “SubscribeUSK” message.
  33          *
  34          * @param uri
  35          *            The URI to watch for changes
  36          * @param identifier
  37          *            The identifier of the request
  38          */
  39         public SubscribeUSK(String uri, String identifier) {
  40                 super("SubscribeUSK");
  41                 setField("URI", uri);
  42                 setField("Identifier", identifier);
  43         }
  44
  45         /**
  46          * Sets whether updates for the USK are actively searched.
  47          *
  48          * @param active
  49          *            <code>true</code> to actively search for newer editions,
  50          *            <code>false</code> to only watch for newer editions that are
  51          *            found from other requests
  52          */
  53         public void setActive(boolean active) {
  54                 setField("DontPoll", String.valueOf(!active));
  55         }
  56
  57 }