com.opensymphony.xwork2.security.AcceptedPatternsChecker Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.opensymphony.xwork2.security;
import java.util.Set;
import java.util.regex.Pattern;
/**
* Used across different interceptors to check if given string matches one of the excluded patterns.
*/
public interface AcceptedPatternsChecker {
/**
* Checks if value matches any of patterns on exclude list
*
* @param value to check
* @return object containing result of matched pattern and pattern itself
*/
public IsAccepted isAccepted(String value);
/**
* Sets excluded patterns during runtime
*
* @param commaDelimitedPatterns comma delimited string with patterns
*/
public void setAcceptedPatterns(String commaDelimitedPatterns);
/**
* Set excluded patterns during runtime
*
* @param patterns array of additional excluded patterns
*/
public void setAcceptedPatterns(String[] patterns);
/**
* Sets excluded patterns during runtime
*
* @param patterns set of additional patterns
*/
public void setAcceptedPatterns(Set patterns);
/**
* Allow access list of all defined excluded patterns
*
* @return set of excluded patterns
*/
public Set getAcceptedPatterns();
public final static class IsAccepted {
private final boolean accepted;
private final String acceptedPattern;
public static IsAccepted yes(String acceptedPattern) {
return new IsAccepted(true, acceptedPattern);
}
public static IsAccepted no(String acceptedPatterns) {
return new IsAccepted(false, acceptedPatterns);
}
private IsAccepted(boolean accepted, String acceptedPattern) {
this.accepted = accepted;
this.acceptedPattern = acceptedPattern;
}
public boolean isAccepted() {
return accepted;
}
public String getAcceptedPattern() {
return acceptedPattern;
}
@Override
public String toString() {
return "IsAccepted {" +
"accepted=" + accepted +
", acceptedPattern=" + acceptedPattern +
" }";
}
}
}