javax.servlet.ServletSecurityElement Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2017-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.servlet;
import java.util.*;
import javax.servlet.annotation.HttpMethodConstraint;
import javax.servlet.annotation.ServletSecurity;
/**
* Java Class representation of a {@link ServletSecurity} annotation value.
*
* @since Servlet 3.0
*/
public class ServletSecurityElement extends HttpConstraintElement {
private Collection methodNames;
private Collection methodConstraints;
/**
* Constructs an instance using the default
* HttpConstraintElement value as the default Constraint
* element and with no HTTP Method specific constraint elements.
*/
public ServletSecurityElement() {
methodConstraints = new HashSet();
methodNames = Collections.emptySet();
}
/**
* Constructs an instance with a default Constraint element
* and with no HTTP Method specific constraint elements.
*
* @param constraint the HttpConstraintElement to be
* applied to all HTTP methods other than those represented in the
* methodConstraints
*/
public ServletSecurityElement(HttpConstraintElement constraint) {
super(constraint.getEmptyRoleSemantic(),
constraint.getTransportGuarantee(),
constraint.getRolesAllowed());
methodConstraints = new HashSet();
methodNames = Collections.emptySet();
}
/**
* Constructs an instance using the default
* HttpConstraintElement value as the default Constraint
* element and with a collection of HTTP Method specific constraint
* elements.
*
* @param methodConstraints the collection of HTTP method specific
* constraint elements
*
* @throws IllegalArgumentException if duplicate method names are
* detected
*/
public ServletSecurityElement(
Collection methodConstraints) {
this.methodConstraints = (methodConstraints == null ?
new HashSet() : methodConstraints);
methodNames = checkMethodNames(this.methodConstraints);
}
/**
* Constructs an instance with a default Constraint element
* and with a collection of HTTP Method specific constraint elements.
*
* @param constraint the HttpConstraintElement to be
* applied to all HTTP methods other than those represented in the
* methodConstraints
* @param methodConstraints the collection of HTTP method specific
* constraint elements.
*
* @throws IllegalArgumentException if duplicate method names are
* detected
*/
public ServletSecurityElement(HttpConstraintElement constraint,
Collection methodConstraints) {
super(constraint.getEmptyRoleSemantic(),
constraint.getTransportGuarantee(),
constraint.getRolesAllowed());
this.methodConstraints = (methodConstraints == null ?
new HashSet() : methodConstraints);
methodNames = checkMethodNames(this.methodConstraints);
}
/**
* Constructs an instance from a {@link ServletSecurity} annotation value.
*
* @param annotation the annotation value
*
* @throws IllegalArgumentException if duplicate method names are
* detected
*/
public ServletSecurityElement(ServletSecurity annotation) {
super(annotation.value().value(),
annotation.value().transportGuarantee(),
annotation.value().rolesAllowed());
this.methodConstraints = new HashSet();
for (HttpMethodConstraint constraint :
annotation.httpMethodConstraints()) {
this.methodConstraints.add(
new HttpMethodConstraintElement(
constraint.value(),
new HttpConstraintElement(constraint.emptyRoleSemantic(),
constraint.transportGuarantee(),
constraint.rolesAllowed())));
}
methodNames = checkMethodNames(this.methodConstraints);
}
/**
* Gets the (possibly empty) collection of HTTP Method specific
* constraint elements.
*
* If permitted, any changes to the returned Collection must not
* affect this ServletSecurityElement.
*
*
* @return the (possibly empty) collection of HttpMethodConstraintElement
* objects
*/
public Collection getHttpMethodConstraints() {
return Collections.unmodifiableCollection(methodConstraints);
}
/**
* Gets the set of HTTP method names named by the HttpMethodConstraints.
*
* If permitted, any changes to the returned Collection must not
* affect this ServletSecurityElement.
*
*
* @return the collection String method names
*/
public Collection getMethodNames() {
return Collections.unmodifiableCollection(methodNames);
}
/**
* Checks for duplicate method names in methodConstraints.
*
* @param methodConstraints
*
* @retrun Set of method names
*
* @throws IllegalArgumentException if duplicate method names are
* detected
*/
private Collection checkMethodNames(
Collection methodConstraints) {
Collection methodNames = new HashSet();
for (HttpMethodConstraintElement methodConstraint :
methodConstraints) {
String methodName = methodConstraint.getMethodName();
if (!methodNames.add(methodName)) {
throw new IllegalArgumentException(
"Duplicate HTTP method name: " + methodName);
}
}
return methodNames;
}
}