Classes

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

Class StandardURLConfiguration

Class StandardURLConfiguration	Line # 31	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.url.internal.standard;
21
22		import org.xwiki.component.annotation.Role;
23
24		/**
25		* Configuration options specific to the {@code standard} URL implementation scheme.
26		*
27		* @version $Id: d1c057ed759b10fa6e47b147177492f7c00f9caa $
28		* @since 2.3M1
29		*/
30		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
31		public interface StandardURLConfiguration
32		{
33		/**
34		* @return true if Entity URLs define the wiki they point to as part of the URL path (aka path-based) or false if
35		* the wiki is contained in the URL host (aka domain-based, e.g. "mywiki.server.com")
36		*/
37		boolean isPathBasedMultiWiki();
38
39		/**
40		* @return the path prefix used when using path-based URLs for multiwiki (e.g. for a wiki named {@code mywiki}:
41		* {@code http://server/xwiki/<prefix>/mywiki/...})
42		*/
43		String getWikiPathPrefix();
44
45		/**
46		* @return the path prefix used for signifying that a URL is pointing at a Model Entity (Document, Space, Object,
47		* etc): {@code http://server/xwiki/<prefix>/...}.
48		* For example: {@code http://server/xwiki/bin/...}.
49		*/
50		String getEntityPathPrefix();
51
52		/**
53		* @return the action to take when a subwiki is not found (ie there's no wiki descriptor for it)
54		*/
55		WikiNotFoundBehavior getWikiNotFoundBehavior();
56
57		/**
58		* @return true if the "view" action is hidden in the URL (other actions are never hidden).
59		* This is useful when you wish to have short URLs
60		* @since 7.2M1
61		*/
62		boolean isViewActionHidden();
63		}