Examples with WebComponentDescriptor com.sun.enterprise.deployment.WebComponentDescriptor used on opensource projects

Example 26 with WebComponentDescriptor

use of com.sun.enterprise.deployment.WebComponentDescriptor in project Payara by payara.

the class WebServiceProviderHandler method processAnnotation.

@Override
public HandlerProcessingResult processAnnotation(AnnotationInfo annInfo) throws AnnotationProcessorException {
    AnnotatedElementHandler annCtx = annInfo.getProcessingContext().getHandler();
    AnnotatedElement annElem = annInfo.getAnnotatedElement();
    boolean ejbInWar = ignoreWebserviceAnnotations(annElem, annCtx);
    // and add webservices to that BundleDescriptor
    if (ejbInWar) {
        return HandlerProcessingResultImpl.getDefaultResult(getAnnotationType(), ResultType.PROCESSED);
    }
    // sanity check
    if (!(annElem instanceof Class)) {
        AnnotationProcessorException ape = new AnnotationProcessorException("@WebServiceProvider can only be specified on TYPE", annInfo);
        annInfo.getProcessingContext().getErrorHandler().error(ape);
        return HandlerProcessingResultImpl.getDefaultResult(getAnnotationType(), ResultType.FAILED);
    }
    if (isJaxwsRIDeployment(annInfo)) {
        // Looks like JAX-WS RI specific deployment, do not process Web Service annotations otherwise would end up as two web service endpoints
        conLogger.log(Level.INFO, LogUtils.DEPLOYMENT_DISABLED, new Object[] { annInfo.getProcessingContext().getArchive().getName(), "WEB-INF/sun-jaxws.xml" });
        return HandlerProcessingResultImpl.getDefaultResult(getAnnotationType(), ResultType.PROCESSED);
    }
    // WebServiceProvider MUST implement the provider interface, let's check this
    if (!javax.xml.ws.Provider.class.isAssignableFrom((Class) annElem)) {
        AnnotationProcessorException ape = new AnnotationProcessorException(annElem.toString() + "does not implement the javax.xml.ws.Provider interface", annInfo);
        annInfo.getProcessingContext().getErrorHandler().error(ape);
        return HandlerProcessingResultImpl.getDefaultResult(getAnnotationType(), ResultType.FAILED);
    }
    // let's get the main annotation of interest.
    javax.xml.ws.WebServiceProvider ann = (javax.xml.ws.WebServiceProvider) annInfo.getAnnotation();
    BundleDescriptor bundleDesc = null;
    try {
        // let's see the type of web service we are dealing with...
        if (ejbProvider != null && ejbProvider.getType("javax.ejb.Stateless") != null) {
            // this is an ejb !
            if (annCtx instanceof EjbContext) {
                EjbContext ctx = (EjbContext) annCtx;
                bundleDesc = ctx.getDescriptor().getEjbBundleDescriptor();
                bundleDesc.setSpecVersion("3.0");
            } else if (annCtx instanceof EjbsContext) {
                String name = getEjbName(annElem);
                for (EjbContext ejbCtx : ((EjbsContext) annCtx).getEjbContexts()) {
                    EjbDescriptor descriptor = ejbCtx.getDescriptor();
                    if (name.equals(descriptor.getName())) {
                        bundleDesc = descriptor.getEjbBundleDescriptor();
                        bundleDesc.setSpecVersion("3.0");
                        break;
                    }
                }
            }
        }
        if (bundleDesc == null) {
            // this has to be a servlet
            if (annCtx instanceof WebComponentContext) {
                bundleDesc = ((WebComponentContext) annCtx).getDescriptor().getWebBundleDescriptor();
            } else if (!(annCtx instanceof WebBundleContext)) {
                return getInvalidAnnotatedElementHandlerResult(annInfo.getProcessingContext().getHandler(), annInfo);
            }
            bundleDesc = ((WebBundleContext) annCtx).getDescriptor();
            bundleDesc.setSpecVersion("2.5");
        }
    } catch (Exception e) {
        throw new AnnotationProcessorException(wsLocalStrings.getLocalString("webservice.annotation.exception", "WS00023: Exception in processing @Webservice : {0}", e.getMessage()));
    }
    // For WSProvider, portComponentName is the fully qualified class name
    String portComponentName = ((Class) annElem).getName();
    // As per JSR181, the serviceName is either specified in the deployment descriptor
    // or in @WebSErvice annotation in impl class; if neither service name implclass+Service
    String svcName = ann.serviceName();
    if (svcName == null) {
        svcName = "";
    }
    // Store binding type specified in Impl class
    String userSpecifiedBinding = null;
    javax.xml.ws.BindingType bindingAnn = (javax.xml.ws.BindingType) ((Class) annElem).getAnnotation(javax.xml.ws.BindingType.class);
    if (bindingAnn != null) {
        userSpecifiedBinding = bindingAnn.value();
    }
    // In case user gives targetNameSpace in the Impl class, that has to be used as
    // the namespace for service, port; typically user will do this in cases where
    // port_types reside in a different namespace than that of server/port.
    // Store the targetNameSpace, if any, in the impl class for later use
    String targetNameSpace = ann.targetNamespace();
    if (targetNameSpace == null) {
        targetNameSpace = "";
    }
    String portName = ann.portName();
    if (portName == null) {
        portName = "";
    }
    // Check if the same endpoint is already defined in webservices.xml
    WebServicesDescriptor wsDesc = bundleDesc.getWebServices();
    WebServiceEndpoint endpoint = wsDesc.getEndpointByName(portComponentName);
    WebService newWS;
    if (endpoint == null) {
        // If so, add this endpoint to the existing service
        if (svcName.length() != 0) {
            newWS = wsDesc.getWebServiceByName(svcName);
        } else {
            newWS = wsDesc.getWebServiceByName(((Class) annElem).getSimpleName());
        }
        if (newWS == null) {
            newWS = new WebService();
            // service name from annotation
            if (svcName.length() != 0) {
                newWS.setName(svcName);
            } else {
                newWS.setName(((Class) annElem).getSimpleName());
            }
            wsDesc.addWebService(newWS);
        }
        endpoint = new WebServiceEndpoint();
        // port-component-name is fully qualified class name
        endpoint.setEndpointName(portComponentName);
        newWS.addEndpoint(endpoint);
        wsDesc.setSpecVersion(WebServicesDescriptorNode.SPEC_VERSION);
    } else {
        newWS = endpoint.getWebService();
    }
    // present overrides everything else
    if (endpoint.getWsdlService() != null) {
        if ((targetNameSpace.length() > 0) && (!endpoint.getWsdlService().getNamespaceURI().equals(targetNameSpace))) {
            throw new AnnotationProcessorException("Target Namespace inwsdl-service element does not match @WebService.targetNamespace", annInfo);
        }
        targetNameSpace = endpoint.getWsdlService().getNamespaceURI();
    }
    // Set binding id id @BindingType is specified by the user in the impl class
    if ((!endpoint.hasUserSpecifiedProtocolBinding()) && (userSpecifiedBinding != null) && (userSpecifiedBinding.length() != 0)) {
        endpoint.setProtocolBinding(userSpecifiedBinding);
    }
    // Use annotated values only if the deployment descriptor equivalent has not been specified
    if (newWS.getWsdlFileUri() == null) {
        // take wsdl location from annotation
        if (ann.wsdlLocation() != null && ann.wsdlLocation().length() != 0) {
            newWS.setWsdlFileUri(ann.wsdlLocation());
        }
    }
    annElem = annInfo.getAnnotatedElement();
    // we checked that the endpoint implements the provider interface above
    Class clz = (Class) annElem;
    Class serviceEndpointIntf = null;
    for (Class intf : clz.getInterfaces()) {
        if (javax.xml.ws.Provider.class.isAssignableFrom(intf)) {
            serviceEndpointIntf = intf;
            break;
        }
    }
    if (serviceEndpointIntf == null) {
        endpoint.setServiceEndpointInterface("javax.xml.ws.Provider");
    } else {
        endpoint.setServiceEndpointInterface(serviceEndpointIntf.getName());
    }
    if (DOLUtils.warType().equals(bundleDesc.getModuleType())) {
        if (endpoint.getServletImplClass() == null) {
            // Set servlet impl class here
            endpoint.setServletImplClass(((Class) annElem).getName());
        }
        // Servlet link name
        WebBundleDescriptor webBundle = (WebBundleDescriptor) bundleDesc;
        if (endpoint.getWebComponentLink() == null) {
            endpoint.setWebComponentLink(portComponentName);
        }
        if (endpoint.getWebComponentImpl() == null) {
            WebComponentDescriptor webComponent = (WebComponentDescriptor) webBundle.getWebComponentByCanonicalName(endpoint.getWebComponentLink());
            if (webComponent == null) {
                // GLASSFISH-3297
                WebComponentDescriptor[] wcs = webBundle.getWebComponentByImplName(((Class) annElem).getCanonicalName());
                if (wcs.length > 0) {
                    webComponent = wcs[0];
                }
            }
            // if servlet is not known, we should add it now
            if (webComponent == null) {
                webComponent = new WebComponentDescriptorImpl();
                webComponent.setServlet(true);
                webComponent.setWebComponentImplementation(((Class) annElem).getCanonicalName());
                webComponent.setName(endpoint.getEndpointName());
                webComponent.addUrlPattern("/" + newWS.getName());
                webBundle.addWebComponentDescriptor(webComponent);
            }
            endpoint.setWebComponentImpl(webComponent);
        }
    } else {
        String name = getEjbName(annElem);
        EjbDescriptor ejb = ((EjbBundleDescriptor) bundleDesc).getEjbByName(name);
        endpoint.setEjbComponentImpl(ejb);
        ejb.setWebServiceEndpointInterfaceName(endpoint.getServiceEndpointInterface());
        if (endpoint.getEjbLink() == null) {
            endpoint.setEjbLink(ejb.getName());
        }
    }
    if (endpoint.getWsdlPort() == null) {
        endpoint.setWsdlPort(new QName(targetNameSpace, portName, "ns1"));
    }
    if (endpoint.getWsdlService() == null) {
        endpoint.setWsdlService(new QName(targetNameSpace, svcName, "ns1"));
    }
    return HandlerProcessingResultImpl.getDefaultResult(getAnnotationType(), ResultType.PROCESSED);
}

Example 27 with WebComponentDescriptor

use of com.sun.enterprise.deployment.WebComponentDescriptor in project Payara by payara.

the class WebBundleDescriptorImpl method addCommonWebBundleDescriptor.

/**
 * This method combines all except welcome file set for two webBundleDescriptors.
 */
private void addCommonWebBundleDescriptor(WebBundleDescriptor wbd, boolean defaultDescriptor) {
    super.addBundleDescriptor(wbd);
    WebBundleDescriptorImpl webBundleDescriptor = (WebBundleDescriptorImpl) wbd;
    for (WebComponentDescriptor webComponentDesc : webBundleDescriptor.getWebComponentDescriptors()) {
        // don't modify the original one
        WebComponentDescriptorImpl webComponentDescriptor = new WebComponentDescriptorImpl(webComponentDesc);
        // set web bundle to null so that the urlPattern2ServletName
        // of the others will not be changed,
        // see WebComponentDescriptor.getUrlPatternsSet()
        webComponentDescriptor.setWebBundleDescriptor(null);
        List<String> removeUrlPatterns = null;
        for (String urlPattern : webComponentDescriptor.getUrlPatternsSet()) {
            String servletName = null;
            if (urlPattern2ServletName != null) {
                servletName = urlPattern2ServletName.get(urlPattern);
            }
            if (servletName != null && (!servletName.equals(webComponentDescriptor.getCanonicalName()))) {
                // need to remove the url pattern in current bundle servlet
                if (removeUrlPatterns == null) {
                    removeUrlPatterns = new ArrayList<String>();
                }
                removeUrlPatterns.add(urlPattern);
            }
        }
        if (removeUrlPatterns != null) {
            webComponentDescriptor.getUrlPatternsSet().removeAll(removeUrlPatterns);
        }
        addWebComponentDescriptor(webComponentDescriptor);
    }
    getContextParametersSet().addAll(webBundleDescriptor.getContextParametersSet());
    if (conflictedMimeMappingExtensions == null) {
        conflictedMimeMappingExtensions = webBundleDescriptor.getConflictedMimeMappingExtensions();
    } else {
        conflictedMimeMappingExtensions.addAll(webBundleDescriptor.getConflictedMimeMappingExtensions());
    }
    combineMimeMappings(webBundleDescriptor.getMimeMappingsSet());
    // do not call getErrorPageDescriptorsSet.addAll() as there is special overriding rule
    for (ErrorPageDescriptor errPageDesc : webBundleDescriptor.getErrorPageDescriptorsSet()) {
        addErrorPageDescriptor(errPageDesc);
    }
    getAppListeners().addAll(webBundleDescriptor.getAppListeners());
    if (webBundleDescriptor.isDenyUncoveredHttpMethods()) {
        setDenyUncoveredHttpMethods(true);
    }
    combineSecurityConstraints(getSecurityConstraintsSet(), webBundleDescriptor.getSecurityConstraintsSet());
    // ServletFilters
    combineServletFilters(webBundleDescriptor);
    combineServletFilterMappings(webBundleDescriptor);
    if (getLocaleEncodingMappingListDescriptor() == null) {
        setLocaleEncodingMappingListDescriptor(webBundleDescriptor.getLocaleEncodingMappingListDescriptor());
    }
    if (webBundleDescriptor.getJspConfigDescriptor() != null) {
        JspConfigDescriptorImpl jspConfigDesc = getJspConfigDescriptor();
        if (jspConfigDesc == null) {
            jspConfigDesc = new JspConfigDescriptorImpl();
            setJspConfigDescriptor(jspConfigDesc);
        }
        jspConfigDescriptor.add(webBundleDescriptor.getJspConfigDescriptor());
    }
    // WebServices
    WebServicesDescriptor thisWebServices = this.getWebServices();
    WebServicesDescriptor otherWebServices = webBundleDescriptor.getWebServices();
    for (WebService ws : otherWebServices.getWebServices()) {
        thisWebServices.addWebService(new WebService(ws));
    }
    if (getSessionConfig() == null) {
        setSessionConfig(webBundleDescriptor.getSessionConfig());
    }
    // combine login config with conflict resolution check
    combineLoginConfiguration(webBundleDescriptor);
    if (!defaultDescriptor && webBundleDescriptor.isExists()) {
        // ignore non-fragment (plain archive) files
        boolean otherDistributable = webBundleDescriptor.isDistributable();
        // the only way distributable is true is when
        // all of it's web fragments are true
        // The Servlet spec (section 8.2.3):
        setDistributable(distributable && otherDistributable);
    }
    combinePostConstructDescriptors(webBundleDescriptor);
    combinePreDestroyDescriptors(webBundleDescriptor);
    addJndiNameEnvironment(webBundleDescriptor);
}

Example 28 with WebComponentDescriptor

use of com.sun.enterprise.deployment.WebComponentDescriptor in project Payara by payara.

the class WebBundleDescriptorImpl method combineWebComponentDescriptor.

/**
 * This method combines descriptor except urlPattern and add
 * to current bundle descriptor if necessary.
 * It returns the web component descriptor in the current bundle descriptor.
 * @param webComponentDescriptor the new descriptor
 *
 * @return web component descriptor in current bundle
 */
@Override
protected WebComponentDescriptor combineWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor) {
    WebComponentDescriptor resultDesc = null;
    String name = webComponentDescriptor.getCanonicalName();
    WebComponentDescriptor webCompDesc = getWebComponentByCanonicalName(name);
    if (webCompDesc != null && webCompDesc instanceof WebComponentDescriptorStub) {
        // urlPattern from fragment is overridden by web.xml
        resultDesc = webComponentDescriptor;
        resultDesc.getUrlPatternsSet().clear();
        resultDesc.getUrlPatternsSet().addAll(webCompDesc.getUrlPatternsSet());
        removeWebComponentDescriptor(webCompDesc);
        addWebComponentDescriptor(resultDesc);
    } else if (webCompDesc != null) {
        // Servlet defined in web.xml
        resultDesc = webCompDesc;
        if (!webCompDesc.isConflict(webComponentDescriptor, true)) {
            // combine the contents of the given one to this one
            // except the urlPatterns
            webCompDesc.add(webComponentDescriptor, false, false);
        }
        String implFile = webCompDesc.getWebComponentImplementation();
        if (resultDesc.isConflict() && (implFile == null || implFile.length() == 0)) {
            throw new IllegalArgumentException(localStrings.getLocalString("web.deployment.exceptionconflictwebcompwithoutimpl", "Two or more web fragments define the same Servlet with conflicting implementation class names that are not overridden by the web.xml"));
        }
        if (resultDesc.getConflictedInitParameterNames().size() > 0) {
            throw new IllegalArgumentException(localStrings.getLocalString("web.deployment.exceptionconflictwebcompinitparam", "Two or more web fragments define the same Servlet with conflicting init param that are not overridden by the web.xml"));
        }
    } else {
        resultDesc = webComponentDescriptor;
        if (resultDesc.isConflict()) {
            throw new IllegalArgumentException(localStrings.getLocalString("web.deployment.exceptionconflictwebcomp", "One or more web fragments define the same Servlet in a conflicting way, and the Servlet is not defined in web.xml"));
        } else {
            this.getWebComponentDescriptors().add(resultDesc);
        }
    }
    return resultDesc;
}