1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.security.internal

File XWikiConstants.java

 

Code metrics

0
0
0
1
86
22
0
-
-
0
-

Classes

Class Line # Actions
XWikiConstants 32 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

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.security.internal;
21   
22    import org.xwiki.model.EntityType;
23    import org.xwiki.model.reference.EntityReference;
24    import org.xwiki.model.reference.LocalDocumentReference;
25   
26    /**
27    * This class contains constants for accessing various xwiki elements.
28    *
29    * @version $Id: 2cae98ee9a1bfb855f98d3b84f09d10f5f74fb15 $
30    * @since 4.0M2
31    */
 
32    public interface XWikiConstants
33    {
34    /** Name of the space where user document and global preferences is stored. */
35    String XWIKI_SPACE = "XWiki";
36   
37    /** Name of document where wiki rights are stored. */
38    String WIKI_DOC = "XWikiPreferences";
39   
40    /**
41    * Relative reference of the space where user document and global preferences is stored.
42    *
43    * @since 7.2M1
44    */
45    EntityReference XWIKI_SPACE_REFERENCE = new EntityReference(XWIKI_SPACE, EntityType.SPACE);
46   
47    /**
48    * XWiki.XWikiPreferences reference.
49    *
50    * @since 7.2M1
51    */
52    LocalDocumentReference WIKI_DOC_REFERENCE = new LocalDocumentReference(XWIKI_SPACE, WIKI_DOC);
53   
54    /** Name of document where space rights are stored. */
55    String SPACE_DOC = "WebPreferences";
56   
57    /** Prefix of wiki descriptor documents. */
58    String WIKI_DESCRIPTOR_PREFIX = "XWikiServer";
59   
60    /** Name of group class. */
61    String GROUP_CLASS = "XWiki.XWikiGroups";
62   
63    /** XWiki class for storing global rights. */
64    String GLOBAL_CLASSNAME = "XWikiGlobalRights";
65   
66    /** XWiki class for storing rights. */
67    String LOCAL_CLASSNAME = "XWikiRights";
68   
69    /** Field name for level in xwiki rights object. */
70    String LEVELS_FIELD_NAME = "levels";
71   
72    /** Field name for group in xwiki rights object. */
73    String GROUPS_FIELD_NAME = "groups";
74   
75    /** Field name for users in xwiki rights object. */
76    String USERS_FIELD_NAME = "users";
77   
78    /** Field name for rights in xwiki rights object. */
79    String ALLOW_FIELD_NAME = "allow";
80   
81    /** The Guest username. */
82    String GUEST_USER = "XWikiGuest";
83   
84    /** The Guest full name. */
85    String GUEST_USER_FULLNAME = XWIKI_SPACE + '.' + GUEST_USER;
86    }