org.glassfish.web.deployment.descriptor.WebResourceCollectionImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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.
*/
// Portions Copyright [2019] Payara Foundation and/or affiliates
package org.glassfish.web.deployment.descriptor;
import com.sun.enterprise.deployment.web.WebResourceCollection;
import org.glassfish.deployment.common.Descriptor;
import java.util.HashSet;
import java.util.Set;
/**
* This descriptor represents a description of a portion of a web app
* in terms of a collection of url patterns and
* a collection of http methods on this patterns.
*
*@author Danny Coward
*/
public class WebResourceCollectionImpl extends Descriptor
implements WebResourceCollection
{
private Set urlPatterns;
private Set httpMethods;
private Set httpMethodOmissions;
public WebResourceCollectionImpl() {
}
public WebResourceCollectionImpl(WebResourceCollectionImpl other) {
if (other.urlPatterns != null) {
this.urlPatterns = new HashSet(other.urlPatterns);
}
if (other.httpMethods != null) {
this.httpMethods = new HashSet(other.httpMethods);
}
if (other.httpMethodOmissions != null) {
this.httpMethodOmissions = new HashSet(other.httpMethodOmissions);
}
}
/**
* Return my urls patterns (String objects)
* @return the set of the url patterns.
*/
public Set getUrlPatterns() {
if (this.urlPatterns == null) {
this.urlPatterns = new HashSet();
}
return this.urlPatterns;
}
/**
* Add a URL pattern to this collection.
* @param the url pattern to be added.
*/
public void addUrlPattern(String urlPattern) {
this.getUrlPatterns().add(urlPattern);
}
/**
* Remove the specified url pattern from the collection.
* @param the url pattern to be removed.
*/
public void removeUrlPattern(String urlPattern) {
this.getUrlPatterns().remove(urlPattern);
}
/**
* Clean out the collection of URL pattern and replace
* it with the given Set of (String) url patterns.
* @param the url patterns to replace the current set.
*/
public void setUrlPatterns(Set urlPatterns) {
this.urlPatterns = urlPatterns;
}
/**
* Return the enumeration of HTTP methods this collection has.
* @return the enumeration of HTTP methods.
*/
public Set getHttpMethods() {
if (this.httpMethods == null) {
this.httpMethods = new HashSet();
}
return this.httpMethods;
}
/**
* Returns the HttpMethods this collection has in an array of strings
* This is added to speed up processing while creating webresource permissions
* @return array of strings of HttpMethods
*/
public String[] getHttpMethodsAsArray(){
if (httpMethods == null){
return (String[]) null;
}
return httpMethods.toArray(new String[httpMethods.size()]);
}
/**
* Sets the set of HTTP methods this collection has.
* @param the set of HTTP methods.
*/
public void setHttpMethods(Set httpMethods) {
this.httpMethods = httpMethods;
}
/**
* Adds the given HTTP method to the collection of http methods this
* collection has.
* @param the HTTP method to be added.
*/
public void addHttpMethod(String httpMethod) {
this.getHttpMethods().add(httpMethod);
}
/**
* Removes the given HTTP method from the collection of http methods.
* @param the HTTP method to be removed.
*/
public void removeHttpMethod(String httpMethod) {
this.getHttpMethods().remove(httpMethod);
}
/**
* Return the set of HTTP method omissions this collection has.
* @return the set of HTTP method omissions.
*/
public Set getHttpMethodOmissions() {
if (this.httpMethodOmissions == null) {
this.httpMethodOmissions = new HashSet();
}
return this.httpMethodOmissions;
}
/**
* Returns the HttpMethodOmissions this collection has in an array of strings
* This is added to speed up processing while creating webresource permissions
* @return array of strings of HttpMethodOmissions
*/
public String[] getHttpMethodOmissionsAsArray(){
if (httpMethodOmissions == null){
return (String[]) null;
}
return httpMethodOmissions.toArray(new String[httpMethodOmissions.size()]);
}
/**
* Sets the set of HTTP method omissions this collection has.
* @param the set of HTTP method omissions.
*/
public void setHttpMethodOmissions(Set httpMethodOmissions) {
this.httpMethodOmissions = httpMethodOmissions;
}
/**
* Adds the given HTTP method omission to the collection of http methods this
* collection has.
* @param the HTTP method to be added.
*/
public void addHttpMethodOmission(String httpMethodOmission) {
this.getHttpMethodOmissions().add(httpMethodOmission);
}
/**
* Removes the given HTTP method omission from the collection of http methods.
* @param the HTTP method to be removed.
*/
public void removeHttpMethodOmission(String httpMethodOmission) {
this.getHttpMethodOmissions().remove(httpMethodOmission);
}
/**
* A formatted string of the state.
*/
public void print(StringBuilder toStringBuilder) {
toStringBuilder.append("WebresourceCollection: ");
toStringBuilder.append(" urlPatterns: ").append(this.urlPatterns);
toStringBuilder.append(" httpMethods ").append(this.httpMethods);
toStringBuilder.append(" httpMethodOmissions ").append(this.httpMethodOmissions);
}
}