com.sun.enterprise.deployment.WebServicesDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dol Show documentation
There is a newer version: 8.0.0-JDK17-M9
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. 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 com.sun.enterprise.deployment;

import java.util.Collection;
import java.util.HashSet;

import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.deployment.common.RootDeploymentDescriptor;

/**
 * Information about the web services defined in a single module.
 *
 * @author Kenneth Saks
 * @author Jerome Dochez
 */
public class WebServicesDescriptor extends RootDeploymentDescriptor {

    private static final long serialVersionUID = 1L;

    // Module in which these web services are defined.
    private BundleDescriptor bundleDesc;

    private final Collection webServices;

    /**
     * Default constructor.
     */
    public WebServicesDescriptor() {
        webServices = new HashSet<>();
    }


    /**
     * @return the default version of the deployment descriptor
     * loaded by this descriptor
     */
    @Override
    public String getDefaultSpecVersion() {
        // FIXME should be WebServicesDescriptorNode.SPEC_VERSION;
        return "2.0";
    }

    public void setBundleDescriptor(BundleDescriptor module) {
        bundleDesc = module;
    }

    public BundleDescriptor getBundleDescriptor() {
        return bundleDesc;
    }

    public boolean hasWebServices() {
        return !webServices.isEmpty();
    }

    @Override
    public boolean isEmpty() {
        return webServices.isEmpty();
    }

    public WebService getWebServiceByName(String webServiceName) {
        for (WebService webService : webServices) {
            if (webService.getName().equals(webServiceName)) {
                return webService;
            }
        }
        return null;
    }

    public void addWebService(WebService ws) {
        ws.setWebServicesDescriptor(this);
        webServices.add(ws);

    }

    public void removeWebService(WebService ws) {
        ws.setWebServicesDescriptor(null);
        webServices.remove(ws);

    }

    public Collection getWebServices() {
        return new HashSet<>(webServices);
    }

    /**
     * Endpoint has a unique name within all the endpoints in the module.
     * @return WebServiceEndpoint or null if not found
     */
    public WebServiceEndpoint getEndpointByName(String endpointName) {
        for (WebServiceEndpoint next : getEndpoints()) {
            if (next.getEndpointName().equals(endpointName)) {
                return next;
            }
        }
        return null;
    }


    public boolean hasEndpointsImplementedBy(EjbDescriptor ejb) {
        return !getEndpointsImplementedBy(ejb).isEmpty();
    }


    public Collection getEndpointsImplementedBy(EjbDescriptor ejb) {
        Collection endpoints = new HashSet<>();
        if (ejb instanceof EjbSessionDescriptor) {
            for (WebServiceEndpoint next : getEndpoints()) {
                if (next.implementedByEjbComponent(ejb)) {
                    endpoints.add(next);
                }
            }
        }
        return endpoints;
    }


    public boolean hasEndpointsImplementedBy(WebComponentDescriptor desc) {
        return !getEndpointsImplementedBy(desc).isEmpty();
    }


    public Collection getEndpointsImplementedBy(WebComponentDescriptor desc) {
        Collection endpoints = new HashSet<>();
        for (WebServiceEndpoint next : getEndpoints()) {
            if (next.implementedByWebComponent(desc)) {
                endpoints.add(next);
            }
        }
        return endpoints;
    }


    public Collection getEndpoints() {
        Collection allEndpoints = new HashSet<>();
        for (WebService webService : webServices) {
            allEndpoints.addAll(webService.getEndpoints());
        }
        return allEndpoints;
    }


    @Override
    public ArchiveType getModuleType() {
        if (bundleDesc != null) {
            return bundleDesc.getModuleType();
        }
        return null;
    }

    @Override
    public ClassLoader getClassLoader() {
        return null;
    }

    @Override
    public boolean isApplication() {
        return false;
    }

    /**
     * Returns a formatted String of the attributes of this object.
     */
    @Override
    public void print(StringBuffer toStringBuffer) {
        super.print(toStringBuffer);
        if (hasWebServices()) {
            for (WebService ws : getWebServices()) {
                toStringBuffer.append("\n Web Service : ");
                ws.print(toStringBuffer);
            }
        }
    }
}