1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.rendering.macro.script

File MacroPermissionPolicy.java

 

Code metrics

0
0
0
1
43
8
0
-
-
0
-

Classes

Class Line # Actions
MacroPermissionPolicy 33 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.rendering.macro.script;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.rendering.transformation.MacroTransformationContext;
24   
25    /**
26    * Decides whether a Script Macro can execute or not. Script Macros should implement this Role with a Hint being the
27    * same as the Macro Hint.
28    *
29    * @version $Id: c3b49fcbdc0d685121a7a07a77e1a48495b0156e $
30    * @since 4.1M1
31    */
32    @Role
 
33    public interface MacroPermissionPolicy
34    {
35    /**
36    * Verifies if the current execution Script Macro is allowed to execute its content or not.
37    *
38    * @param parameters the executing macro parameters
39    * @param context the transformation context in which the current macro is executing
40    * @return true if the script can execute or false otherwise
41    */
42    boolean hasPermission(ScriptMacroParameters parameters, MacroTransformationContext context);
43    }