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

File SheetRequestInitializer.java

 

Coverage histogram

../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

2
3
1
1
66
26
2
0.67
3
1
2

Classes

Class Line # Actions
SheetRequestInitializer 41 3 0% 2 0
1.0100%
 

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.sheet.internal;
21   
22    import javax.inject.Inject;
23    import javax.inject.Named;
24    import javax.inject.Singleton;
25   
26    import org.xwiki.component.annotation.Component;
27    import org.xwiki.container.Request;
28    import org.xwiki.container.RequestInitializer;
29    import org.xwiki.container.RequestInitializerException;
30    import org.xwiki.context.Execution;
31   
32    /**
33    * Takes the sheet parameter from the request and puts it on the execution context to be used by the sheet manager.
34    *
35    * @version $Id: afc81ffcd88947ec8559f8127c73a959af05b9c8 $
36    * @since 3.2M3
37    */
38    @Component
39    @Named("sheet")
40    @Singleton
 
41    public class SheetRequestInitializer implements RequestInitializer
42    {
43    /**
44    * The name of the request parameter specifying the sheet to be applied to the requested document. This is also the
45    * name of the execution context property specifying the same thing.
46    */
47    private static final String SHEET_PROPERTY_NAME = "sheet";
48   
49    /**
50    * Execution context handler.
51    */
52    @Inject
53    private Execution execution;
54   
 
55  13163 toggle @Override
56    public void initialize(Request request) throws RequestInitializerException
57    {
58  13163 String sheet = (String) request.getProperty(SHEET_PROPERTY_NAME);
59    // Note: Empty string value makes sense because it means the sheet is the document itself (the sheet reference
60    // is resolved relative to the current document and thus the empty string reference refers to the current
61    // document). In other words, the empty string value can be used to display the document without a sheet.
62  13151 if (sheet != null) {
63  126 execution.getContext().setProperty(SHEET_PROPERTY_NAME, sheet);
64    }
65    }
66    }