src/net/pterodactylus/fcp/TestDDAComplete.java

   1 /*
   2  * jSite2 - TestDDAComplete.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  * The “TestDDAComplete” message signals that the node has finished checking
  24  * your read and write access to a certain directory.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public class TestDDAComplete extends BaseMessage {
  29
  30         /**
  31          * Creates a new “TestDDAComplete” message that wraps the received message.
  32          *
  33          * @param receivedMessage
  34          *            The received message
  35          */
  36         TestDDAComplete(FcpMessage receivedMessage) {
  37                 super(receivedMessage);
  38         }
  39
  40         /**
  41          * Returns the directory the authorization is given for.
  42          *
  43          * @return The directory that was tested for read and/or write access
  44          */
  45         public String getDirectory() {
  46                 return getField("Directory");
  47         }
  48
  49         /**
  50          * Returns whether read access to the directory is allowed.
  51          *
  52          * @return <code>true</code> if the client is allowed to read from that
  53          *         directory, <code>false</code> otherwise
  54          */
  55         public boolean isReadDirectoryAllowed() {
  56                 return Boolean.valueOf(getField("ReadDirectoryAllowed"));
  57         }
  58
  59         /**
  60          * Returns whether write access to the directory is allowed.
  61          *
  62          * @return <code>true</code> if the client is allowed to write into that
  63          *         directory, <code>false</code> otherwise
  64          */
  65         public boolean isWriteDirectoryAllowed() {
  66                 return Boolean.valueOf(getField("WriteDirectoryAllowed"));
  67         }
  68
  69 }