org.glassfish.web.deployment.annotation.handlers.WebServletHandler 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-2013 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 [2016-2021] [Payara Foundation and/or its affiliates]
package org.glassfish.web.deployment.annotation.handlers;
import com.sun.enterprise.deployment.EnvironmentProperty;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.deployment.WebComponentDescriptor;
import com.sun.enterprise.deployment.annotation.context.WebBundleContext;
import com.sun.enterprise.deployment.annotation.context.WebComponentContext;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.util.net.URLPattern;
import fish.payara.nucleus.hotdeploy.ApplicationState;
import org.glassfish.apf.*;
import org.glassfish.web.deployment.descriptor.WebComponentDescriptorImpl;
import org.jvnet.hk2.annotations.Service;
import jakarta.servlet.annotation.WebInitParam;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import java.util.Arrays;
import java.util.logging.Level;
import org.glassfish.config.support.TranslatedConfigView;
/**
* This handler is responsible in handling
* jakarta.servlet.annotation.WebServlet.
*
* @author Shing Wai Chan
*/
@Service
@AnnotationHandlerFor(WebServlet.class)
public class WebServletHandler extends AbstractWebHandler {
protected final static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(WebFilterHandler.class);
public WebServletHandler() {
}
@Override
public HandlerProcessingResult processAnnotation(AnnotationInfo ainfo)
throws AnnotationProcessorException {
ProcessingContext context = ainfo.getProcessingContext();
AnnotatedElementHandler aeHandler = context.getHandler();
if (aeHandler instanceof WebBundleContext) {
WebBundleContext webBundleContext = (WebBundleContext)aeHandler;
WebBundleDescriptor descriptor = webBundleContext.getDescriptor();
WebServlet webServletAn = (WebServlet)ainfo.getAnnotation();
Class servletClass = (Class)ainfo.getAnnotatedElement();
String servletName = getServletName(webServletAn, servletClass);
// create a WebComponentDescriptor if there is none
WebComponentDescriptor webCompDesc = findWebComponentDescriptor(
servletName, servletClass, descriptor, context
);
if (webCompDesc == null) {
createWebComponentDescriptor(servletName, servletClass, descriptor);
}
}
return super.processAnnotation(ainfo);
}
private WebComponentDescriptor findWebComponentDescriptor(
String servletName, Class servletClass,
WebBundleDescriptor descriptor,
ProcessingContext context) {
WebComponentDescriptor webCompDesc
= descriptor.getWebComponentByCanonicalName(servletName);
ApplicationState state = context.getArchive().getExtraData(ApplicationState.class);
if (state != null) {
if (webCompDesc == null) {
WebComponentDescriptor[] webCompDescs
= descriptor.getWebComponentByImplName(servletClass.getName());
if (webCompDescs.length > 0) {
webCompDesc = webCompDescs[0];
}
}
if (webCompDesc != null) {
descriptor.removeWebComponentDescriptor(webCompDesc);
webCompDesc = null;
}
}
return webCompDesc;
}
@Override
protected HandlerProcessingResult processAnnotation(AnnotationInfo ainfo,
WebComponentContext[] webCompContexts)
throws AnnotationProcessorException {
HandlerProcessingResult result = null;
for (WebComponentContext webCompContext : webCompContexts) {
result = processAnnotation(ainfo,
webCompContext.getDescriptor());
if (result.getOverallResult() == ResultType.FAILED) {
break;
}
}
return result;
}
@Override
protected HandlerProcessingResult processAnnotation(
AnnotationInfo ainfo, WebBundleContext webBundleContext)
throws AnnotationProcessorException {
WebServlet webServletAn = (WebServlet)ainfo.getAnnotation();
Class webCompClass = (Class)ainfo.getAnnotatedElement();
String servletName = getServletName(webServletAn, webCompClass);
WebComponentDescriptor webCompDesc =
webBundleContext.getDescriptor().getWebComponentByCanonicalName(servletName);
if (webCompDesc == null) {
webCompDesc = createWebComponentDescriptor(servletName, webCompClass,
webBundleContext.getDescriptor());
}
HandlerProcessingResult result = processAnnotation(ainfo, webCompDesc);
if (result.getOverallResult() == ResultType.PROCESSED) {
WebComponentContext webCompContext = new WebComponentContext(webCompDesc);
// we push the new context on the stack...
webBundleContext.getProcessingContext().pushHandler(webCompContext);
}
return result;
}
private HandlerProcessingResult processAnnotation(
AnnotationInfo ainfo, WebComponentDescriptor webCompDesc)
throws AnnotationProcessorException {
Class webCompClass = (Class)ainfo.getAnnotatedElement();
if (!HttpServlet.class.isAssignableFrom(webCompClass)) {
log(Level.SEVERE, ainfo,
localStrings.getLocalString(
"web.deployment.annotation.handlers.needtoextend",
"The Class {0} having annotation {1} need to be a derived class of {2}.",
new Object[] { webCompClass.getName(), WebServlet.class.getName(), HttpServlet.class.getName() }));
return getDefaultFailedResult();
}
WebServlet webServletAn = (WebServlet)ainfo.getAnnotation();
String servletName = getServletName(webServletAn, webCompClass);
if (!servletName.equals(webCompDesc.getCanonicalName())) {
// skip the processing as it is not for given webCompDesc
return getDefaultProcessedResult();
}
String webCompImpl = webCompDesc.getWebComponentImplementation();
if (webCompImpl != null && webCompImpl.length() > 0 &&
(!webCompImpl.equals(webCompClass.getName()) || !webCompDesc.isServlet())) {
String messageKey = null;
String defaultMessage = null;
if (webCompDesc.isServlet()) {
messageKey = "web.deployment.annotation.handlers.servletimpldontmatch";
defaultMessage = "The servlet ''{0}'' has implementation ''{1}'' in xml. It does not match with ''{2}'' from annotation @{3}.";
} else {
messageKey = "web.deployment.annotation.handlers.servletimpljspdontmatch";
defaultMessage = "The servlet ''{0}'' is a jsp ''{1}'' in xml. It does not match with ''{2}'' from annotation @{3}.";
}
log(Level.SEVERE, ainfo,
localStrings.getLocalString(messageKey, defaultMessage,
new Object[] { webCompDesc.getCanonicalName(), webCompImpl, webCompClass.getName(),
WebServlet.class.getName() }));
return getDefaultFailedResult();
}
webCompDesc.setServlet(true);
webCompDesc.setWebComponentImplementation(webCompClass.getName());
if (webCompDesc.getUrlPatternsSet().isEmpty()) {
String[] urlPatterns = webServletAn.urlPatterns();
if (urlPatterns == null || urlPatterns.length == 0) {
urlPatterns = webServletAn.value();
}
// no url patterns is accepted as it may be defined in top level xml
boolean validUrlPatterns = true;
if (urlPatterns != null && urlPatterns.length > 0) {
for (String up : urlPatterns) {
if (!URLPattern.isValid(up)) {
validUrlPatterns = false;
break;
}
webCompDesc.addUrlPattern(TranslatedConfigView.expandValue(up));
}
}
if (!validUrlPatterns) {
String urlPatternString =
(urlPatterns != null) ? Arrays.toString(urlPatterns) : "";
throw new IllegalArgumentException(localStrings.getLocalString(
"web.deployment.annotation.handlers.invalidUrlPatterns",
"Invalid url patterns for {0}: {1}.",
new Object[] { webCompClass, urlPatternString }));
}
}
if (webCompDesc.getLoadOnStartUp() == null) {
webCompDesc.setLoadOnStartUp(webServletAn.loadOnStartup());
}
WebInitParam[] initParams = webServletAn.initParams();
if (initParams != null && initParams.length > 0) {
for (WebInitParam initParam : initParams) {
webCompDesc.addInitializationParameter(
new EnvironmentProperty(
initParam.name(), TranslatedConfigView.expandValue(initParam.value()),
initParam.description()));
}
}
if (webCompDesc.getSmallIconUri() == null) {
webCompDesc.setSmallIconUri(webServletAn.smallIcon());
}
if (webCompDesc.getLargeIconUri() == null) {
webCompDesc.setLargeIconUri(webServletAn.largeIcon());
}
if (webCompDesc.getDescription() == null ||
webCompDesc.getDescription().length() == 0) {
webCompDesc.setDescription(webServletAn.description());
}
if (webCompDesc.getDisplayName() == null ||
webCompDesc.getDisplayName().length() == 0) {
webCompDesc.setDisplayName(webServletAn.displayName());
}
if (webCompDesc.isAsyncSupported() == null) {
webCompDesc.setAsyncSupported(webServletAn.asyncSupported());
}
return getDefaultProcessedResult();
}
private String getServletName(WebServlet webServletAn, Class webCompClass) {
String servletName = webServletAn.name();
if (servletName == null || servletName.length() == 0) {
servletName = webCompClass.getName();
}
else {
servletName = TranslatedConfigView.expandValue(servletName);
}
return servletName;
}
private WebComponentDescriptor createWebComponentDescriptor(String servletName,
Class webCompClass, WebBundleDescriptor webBundleDescriptor) {
WebComponentDescriptor webCompDesc = new WebComponentDescriptorImpl();
webCompDesc.setName(servletName);
webCompDesc.setCanonicalName(servletName);
webCompDesc.setServlet(true);
webCompDesc.setWebComponentImplementation(webCompClass.getName());
webBundleDescriptor.addWebComponentDescriptor(webCompDesc);
return webCompDesc;
}
}