Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
WikiResource	40	0	-	0	0	-1.0 -	Show methods

Class WikiResource

Class WikiResource	Line # 40	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software 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 GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.rest.resources.wikis;
21
22		import java.io.InputStream;
23
24		import javax.ws.rs.DefaultValue;
25		import javax.ws.rs.GET;
26		import javax.ws.rs.POST;
27		import javax.ws.rs.Path;
28		import javax.ws.rs.PathParam;
29		import javax.ws.rs.QueryParam;
30
31		import org.xwiki.rest.XWikiRestException;
32		import org.xwiki.rest.model.jaxb.Wiki;
33
34		/**
35		* Resource for interacting with a specific wiki.
36		*
37		* @version $Id: 3c3f588147b9a0cc376ffb72872950085ee6084b $
38		*/
39		@Path("/wikis/{wikiName}")
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
40		public interface WikiResource
41		{
42		/**
43		* Get information about a wiki.
44		*
45		* @param wikiName the wiki name.
46		* @return information about the wiki.
47		* @throws XWikiRestException if something goes wrong.
48		*/
49		@GET Wiki get(
50		@PathParam("wikiName") String wikiName
51		) throws XWikiRestException;
52
53		/**
54		* Import a XAR into a given wiki.
55		*
56		* @param wikiName the wiki name.
57		* @param backup whether this is a backup pack.
58		* @param history how to manage page version when importing pages.
59		* @param is the input stream containing XAR data (POSTed by the client)
60		* @return the information about the wiki.
61		* @throws XWikiRestException if there was an error during import.
62		*/
63		@POST Wiki importXAR(
64		@PathParam("wikiName") String wikiName,
65		@QueryParam("backup") @DefaultValue("false") Boolean backup,
66		@QueryParam("history") @DefaultValue("add") String history,
67		InputStream is
68		) throws XWikiRestException;
69		}