jakarta.servlet.ServletSecurityElement Maven / Gradle / Ivy
/*
* Copyright (c) 2017, 2023 Oracle and/or its affiliates and others.
* All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.servlet;
import jakarta.servlet.annotation.HttpMethodConstraint;
import jakarta.servlet.annotation.ServletSecurity;
import java.util.*;
/**
* Java Class representation of a {@link ServletSecurity} annotation value.
*
* @since Servlet 3.0
*/
public class ServletSecurityElement extends HttpConstraintElement {
private final Collection methodNames;
private final 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
*
* @return 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;
}
}