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

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