-
-
Notifications
You must be signed in to change notification settings - Fork 542
/
SpacePreferencesConfigurationSource.java
82 lines (71 loc) · 2.92 KB
/
SpacePreferencesConfigurationSource.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.configuration.internal;
import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;
import org.xwiki.bridge.DocumentAccessBridge;
import org.xwiki.component.annotation.Component;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.model.reference.SpaceReference;
/**
* Configuration source taking its data in the Space Preferences wiki document (using data from the
* XWiki.XWikiPreferences object attached to that document).
*
* @version $Id$
* @since 2.0M2
*/
@Component
@Named("space")
@Singleton
public class SpacePreferencesConfigurationSource extends AbstractXWikiPreferencesConfigurationSource
{
static final String DOCUMENT_NAME = "WebPreferences";
@Inject
private DocumentAccessBridge documentAccessBridge;
@Override
protected String getCacheId()
{
return "configuration.document.space";
}
@Override
protected String getCacheKeyPrefix()
{
DocumentReference currentDocumentReference = this.documentAccessBridge.getCurrentDocumentReference();
if (currentDocumentReference != null) {
return this.referenceSerializer.serialize(currentDocumentReference.getParent());
}
return null;
}
@Override
protected DocumentReference getDocumentReference()
{
// Note: We would normally use a Reference Resolver here but since the Model module uses the Configuration
// module we cannot use one as otherwise we would create a cyclic build dependency...
// Get the current document reference to extract the wiki and space names.
DocumentReference currentDocumentReference = this.documentAccessBridge.getCurrentDocumentReference();
if (currentDocumentReference != null) {
// Add the current spaces and current wiki references to the Web Preferences document reference to form
// an absolute reference.
return new DocumentReference(DOCUMENT_NAME, (SpaceReference) currentDocumentReference.getParent());
}
return null;
}
}