9b3a1c60726b5bfcc621c3c3cf577387ca32c878
[utils] / security / src / main / java / org / wamblee / security / authorization / RegexpPathCondition.java
1 /*
2  * Copyright 2005 the original author or authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.security.authorization;
17
18 import org.wamblee.persistence.AbstractPersistent;
19
20
21 /**
22  * Condition to check whether a path  matches a given regula expression.
23  *
24  * @author Erik Brakkee
25  */
26 public class RegexpPathCondition extends AbstractPersistent
27     implements PathCondition {
28     /**
29      * String the path must start with.
30      */
31     private String pattern;
32
33 /**
34      * Constructs the condition. 
35      * @param aPattern String the path must start with. 
36      */
37     public RegexpPathCondition(String aPattern) {
38         pattern = aPattern;
39     }
40
41 /**
42      * For OR mapping. 
43      *
44      */
45     protected RegexpPathCondition() {
46         pattern = null;
47     }
48
49     /* (non-Javadoc)
50      * @see org.wamblee.security.authorization.PathCondition#matches(java.lang.String)
51      */
52     /**
53      * DOCUMENT ME!
54      *
55      * @param aPath DOCUMENT ME!
56      *
57      * @return DOCUMENT ME!
58      */
59     public boolean matches(String aPath) {
60         return aPath.matches(pattern);
61     }
62
63     /**
64      * DOCUMENT ME!
65      *
66      * @return Returns the _path.
67      */
68     protected String getPattern() {
69         return pattern;
70     }
71
72     /**
73      * DOCUMENT ME!
74      *
75      * @param aPattern The _path to set.
76      */
77     protected void setPattern(String aPattern) {
78         pattern = aPattern;
79     }
80
81     /* (non-Javadoc)
82      * @see java.lang.Object#toString()
83      */
84     /**
85      * DOCUMENT ME!
86      *
87      * @return DOCUMENT ME!
88      */
89     @Override
90     public String toString() {
91         return "RegexpCondition(pattern = '" + pattern + "')";
92     }
93 }