src/main/java/net/pterodactylus/fcp/TestDDAComplete.java

   1 /*
   2  * jFCPlib - TestDDAComplete.java - Copyright © 2008 David Roden
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package net.pterodactylus.fcp;
  20
  21 /**
  22  * The “TestDDAComplete” message signals that the node has finished checking
  23  * your read and write access to a certain directory.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class TestDDAComplete extends BaseMessage {
  28
  29         /**
  30          * Creates a new “TestDDAComplete” message that wraps the received message.
  31          *
  32          * @param receivedMessage
  33          *            The received message
  34          */
  35         public TestDDAComplete(FcpMessage receivedMessage) {
  36                 super(receivedMessage);
  37         }
  38
  39         /**
  40          * Returns the directory the authorization is given for.
  41          *
  42          * @return The directory that was tested for read and/or write access
  43          */
  44         public String getDirectory() {
  45                 return getField("Directory");
  46         }
  47
  48         /**
  49          * Returns whether read access to the directory is allowed.
  50          *
  51          * @return <code>true</code> if the client is allowed to read from that
  52          *         directory, <code>false</code> otherwise
  53          */
  54         public boolean isReadDirectoryAllowed() {
  55                 return Boolean.valueOf(getField("ReadDirectoryAllowed"));
  56         }
  57
  58         /**
  59          * Returns whether write access to the directory is allowed.
  60          *
  61          * @return <code>true</code> if the client is allowed to write into that
  62          *         directory, <code>false</code> otherwise
  63          */
  64         public boolean isWriteDirectoryAllowed() {
  65                 return Boolean.valueOf(getField("WriteDirectoryAllowed"));
  66         }
  67
  68 }