rename fcplib to jFCPlib
[jFCPlib.git] / src / net / pterodactylus / fcp / URIGenerated.java
1 /*
2  * jSite2 - URIGenerated.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 “URIGenerated” message signals the client that an URI was generated for a
24  * {@link ClientPut} (or {@link ClientPutDiskDir} or {@link ClientPutComplexDir})
25  * request.
26  * 
27  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
28  * @version $Id$
29  */
30 public class URIGenerated extends BaseMessage {
31
32         /**
33          * Creates a new “URIGenerated” message that wraps the received message.
34          * 
35          * @param receivedMessage
36          *            The received message
37          */
38         URIGenerated(FcpMessage receivedMessage) {
39                 super(receivedMessage);
40         }
41
42         /**
43          * Returns the identifier of the request that generated an URI.
44          * 
45          * @return The identifier of the request
46          */
47         public String getIdentifier() {
48                 return getField("Identifier");
49         }
50
51         /**
52          * Returns the URI that was generated by the request.
53          * 
54          * @return The URI that was generated by the request
55          */
56         public String getURI() {
57                 return getField("URI");
58         }
59
60 }