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 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-2020] Payara Foundation and/or affiliates
package com.sun.enterprise.deployment;
import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.deployment.common.RootDeploymentDescriptor;
import java.util.Collection;
import java.util.HashSet;
/**
* Information about the web services defined in a single module.
*
* @author Kenneth Saks
* @author Jerome Dochez
*/
public class WebServicesDescriptor extends RootDeploymentDescriptor {
// Module in which these web services are defined.
private BundleDescriptor bundleDesc;
private 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() {
return "1.3";//TODO fix this WebServicesDescriptorNode.SPEC_VERSION;
}
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 descriptor) {
descriptor.setWebServicesDescriptor(this);
webServices.add(descriptor);
}
public void removeWebService(WebService descriptor) {
descriptor.setWebServicesDescriptor(null);
webServices.remove(descriptor);
}
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;
}
//
// Dummy RootDeploymentDescriptor implementations for methods that
// do not apply to WebServicesDescriptor.
//
@Override
public String getModuleID() { return ""; }
@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(StringBuilder toStringBuilder) {
super.print(toStringBuilder);
if (hasWebServices()) {
for (WebService aWebService : getWebServices()) {
toStringBuilder.append("\n Web Service : ");
aWebService.print(toStringBuilder);
}
}
}
}