org.glassfish.grizzly.servlet.Registration Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2015 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.
*/
package org.glassfish.grizzly.servlet;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
/**
* Base class for all complex registrable components within a web application.
*
* @since 2.2
*/
public abstract class Registration {
protected String name;
protected String className;
protected Map initParameters;
protected final WebappContext ctx;
// ------------------------------------------------------------ Constructors
protected Registration(final WebappContext ctx,
final String name,
final String className) {
this.ctx = ctx;
this.name = name;
this.className = className;
initParameters = new LinkedHashMap(4, 1.0f);
}
// ---------------------------------------------------------- Public Methods
/**
* Gets the name of the Servlet or Filter that is represented by this
* Registration.
*
* @return the name of the Servlet or Filter that is represented by this
* Registration
*/
public String getName() {
return name;
}
/**
* Gets the fully qualified class name of the Servlet or Filter that
* is represented by this Registration.
*
* @return the fully qualified class name of the Servlet or Filter
* that is represented by this Registration, or null if this
* Registration is preliminary
*/
public String getClassName() {
return className;
}
/**
* Sets the initialization parameter with the given name and value
* on the Servlet or Filter that is represented by this Registration.
*
* @param name the initialization parameter name
* @param value the initialization parameter value
*
* @return true if the update was successful, i.e., an initialization
* parameter with the given name did not already exist for the Servlet
* or Filter represented by this Registration, and false otherwise
*
* @throws IllegalStateException if the WebappContext from which this
* Registration was obtained has already been initialized
* @throws IllegalArgumentException if the given name or value is
* null
*/
public boolean setInitParameter(String name, String value) {
if (ctx.deployed) {
throw new IllegalStateException("WebappContext has already been deployed");
}
if (name == null) {
throw new IllegalArgumentException("'name' cannot be null");
}
if (value == null) {
throw new IllegalArgumentException("'value' cannot be null");
}
if (!initParameters.containsKey(name)) {
initParameters.put(name, value);
return true;
}
return false;
}
/**
* Gets the value of the initialization parameter with the given name
* that will be used to initialize the Servlet or Filter represented
* by this Registration object.
*
* @param name the name of the initialization parameter whose value is
* requested
*
* @return the value of the initialization parameter with the given
* name, or null if no initialization parameter with the given
* name exists
*/
public String getInitParameter(String name) {
return ((name == null) ? null : initParameters.get(name));
}
/**
* Sets the given initialization parameters on the Servlet or Filter
* that is represented by this Registration.
*
* The given map of initialization parameters is processed
* by-value, i.e., for each initialization parameter contained
* in the map, this method calls {@link #setInitParameter(String,String)}.
* If that method would return false for any of the
* initialization parameters in the given map, no updates will be
* performed, and false will be returned. Likewise, if the map contains
* an initialization parameter with a null name or value, no
* updates will be performed, and an IllegalArgumentException will be
* thrown.
*
* @param initParameters the initialization parameters
*
* @return the (possibly empty) Set of initialization parameter names
* that are in conflict
*
* @throws IllegalStateException if the WebappContext from which this
* Registration was obtained has already been initialized
* @throws IllegalArgumentException if the given map contains an
* initialization parameter with a null name or value
*/
public Set setInitParameters(Map initParameters) {
if (ctx.deployed) {
throw new IllegalStateException("WebappContext has already been deployed");
}
if (initParameters == null) {
return Collections.emptySet();
}
final Set conflicts = new LinkedHashSet(4, 1.0f);
for (final Map.Entry entry : initParameters.entrySet()) {
if (!setInitParameter(entry.getKey(), entry.getValue())) {
conflicts.add(entry.getKey());
}
}
return conflicts;
}
/**
* Gets an immutable (and possibly empty) Map containing the
* currently available initialization parameters that will be used to
* initialize the Servlet or Filter represented by this Registration
* object.
*
* @return Map containing the currently available initialization
* parameters that will be used to initialize the Servlet or Filter
* represented by this Registration object
*/
public Map getInitParameters() {
return Collections.unmodifiableMap(initParameters);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Registration)) return false;
Registration that = (Registration) o;
if (className != null ? !className.equals(that.className) : that.className != null)
return false;
if (ctx != null ? !ctx.equals(that.ctx) : that.ctx != null)
return false;
if (name != null ? !name.equals(that.name) : that.name != null)
return false;
return true;
}
@Override
public int hashCode() {
int result = name != null ? name.hashCode() : 0;
result = 31 * result + (className != null ? className.hashCode() : 0);
result = 31 * result + (ctx != null ? ctx.hashCode() : 0);
return result;
}
}