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

File NamespaceValidator.java

 

Code metrics

0
0
0
1
48
9
0
-
-
0
-

Classes

Class Line # Actions
NamespaceValidator 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.component.namespace;
21   
22    import java.util.Collection;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * Validate a namespace against list of allowed namespaces.
28    *
29    * @version $Id: ab90906780ffb4282206afb149b2524d3929f01b $
30    * @since 8.0M1
31    */
32    @Role
 
33    public interface NamespaceValidator
34    {
35    /**
36    * @param allowedNamespaces the allowed dynamic (or not) namespaces, null matches any namespace
37    * @param namespace to validate against passed allowed namespaces
38    * @return the namespace(s) corresponding to the passed dynamic namespaces
39    */
40    boolean isAllowed(Collection<String> allowedNamespaces, String namespace);
41   
42    /**
43    * @param allowedNamespaces the allowed dynamic (or not) namespaces, null matches any namespace
44    * @param namespace to validate against passed allowed namespaces
45    * @throws NamespaceNotAllowedException when the passed namespace is not allowed
46    */
47    void checkAllowed(Collection<String> allowedNamespaces, String namespace) throws NamespaceNotAllowedException;
48    }