com.sun.enterprise.deployment.util.ModuleContentValidator 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 [2016-2020] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.deployment.util;
import com.sun.enterprise.deployment.*;
import com.sun.enterprise.util.LocalStringManagerImpl;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.jvnet.hk2.annotations.Service;
import org.glassfish.hk2.api.PerLookup;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
/**
* Allows validation of module content that might involve actually
* reading the bytes themselves from the module. Called after
* descriptor has been loaded but before module-specific archivist
* is closed.
*
* @author Kenneth Saks
*/
@Service
@PerLookup
public class ModuleContentValidator extends ModuleContentLinker implements ComponentPostVisitor {
private ReadableArchive archive_;
// resources...
private static final LocalStringManagerImpl localStrings = new LocalStringManagerImpl(ModuleContentValidator.class);
public ModuleContentValidator() {
}
@Override
public void setArchive(ReadableArchive archive) {
archive_ = archive;
}
@Override
public void accept(ServiceReferenceDescriptor serviceRef) {
if( serviceRef.hasWsdlFile() ) {
String wsdlFileUri = serviceRef.getWsdlFileUri();
// For JAXWS based clients, the user need not package WSDL and not refer to it
// in @WebServiceRef; in this case we rely on @WebClient in generated files to get
// wsdl location; this wsdl location can be URL or absolute path; in these cases
// ensure that the file is present and return
URL url = null;
try {
url = new URL(wsdlFileUri);
} catch(java.net.MalformedURLException e) {
// don't care, will eventuall fail below
}
if (url!=null) {
if (url.getProtocol().equals("http") || url.getProtocol().equals("https"))
return;
}
File tmpFile = new File(wsdlFileUri);
if(tmpFile.isAbsolute() && tmpFile.exists()) {
return;
}
try {
InputStream wsdlFileInputStream =
archive_.getEntry(wsdlFileUri);
if( wsdlFileInputStream != null ) {
wsdlFileInputStream.close();
} else {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.wsdlfilenotfound",
"wsdl file {0} does not exist for service-ref {1}",
new Object[] {wsdlFileUri, serviceRef.getName()});
DOLUtils.getDefaultLogger().warning(msg);
}
} catch(IOException ioe) {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.wsdlfilenotreadable",
"wsdl file {0} for service-ref {1} cannot be opened : {2}",
new Object[] {wsdlFileUri, serviceRef.getName(), ioe.getMessage()});
DOLUtils.getDefaultLogger().warning(msg);
}
}
if( serviceRef.hasMappingFile() ) {
String mappingFileUri = serviceRef.getMappingFileUri();
try {
InputStream mappingFileInputStream =
archive_.getEntry(mappingFileUri);
if( mappingFileInputStream != null ) {
mappingFileInputStream.close();
} else {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.mappingfilenotfound",
"mapping file {0} does not exist for service-ref {1}",
new Object[] {mappingFileUri, serviceRef.getName()});
DOLUtils.getDefaultLogger().severe(msg);
throw new RuntimeException(msg);
}
} catch(IOException ioe) {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.mappingfilenotreadable",
"mapping file {0} for service-ref {1} cannot be opened : {2}",
new Object[] {mappingFileUri, serviceRef.getName(), ioe.getMessage()});
DOLUtils.getDefaultLogger().severe(msg);
throw new RuntimeException(ioe);
}
}
}
@Override
public void accept(WebService webService) {
try {
String wsdlFileUri = webService.getWsdlFileUri();
if (!webService.hasWsdlFile()) {
// no wsdl was specified in the annotation or deployment descritor,
//it will be generated at deployment.
return;
}
try {
URL url = new URL(wsdlFileUri);
if (url.getProtocol()!=null && !url.getProtocol().equals("file"))
return;
} catch(java.net.MalformedURLException e) {
// ignore it could be a relative uri
}
InputStream wsdlFileInputStream = archive_.getEntry(wsdlFileUri);
if( wsdlFileInputStream != null ) {
wsdlFileInputStream.close();
BundleDescriptor bundle = webService.getBundleDescriptor();
if( !isWsdlContent(wsdlFileUri, bundle) ) {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.wsdlpackagedinwrongservicelocation",
"wsdl file {0} for web service {1} must be packaged in or below {2}",
new Object[] {wsdlFileUri, webService.getName(), bundle.getWsdlDir()});
DOLUtils.getDefaultLogger().severe(msg);
throw new RuntimeException(msg);
}
} else {
// let's look in the wsdl directory
String fullFileUri = webService.getBundleDescriptor().getWsdlDir() + "/" + wsdlFileUri;
wsdlFileInputStream = archive_.getEntry(fullFileUri);
if( wsdlFileInputStream != null ) {
// found it, let's update the DOL to not have to recalculate this again
wsdlFileInputStream.close();
webService.setWsdlFileUri(fullFileUri);
} else {
// this time I give up, no idea where this WSDL is
String msg = localStrings.getLocalString(
"enterprise.deployment.util.servicewsdlfilenotfound",
"wsdl file {0} does not exist for web service {1}",
new Object[] {wsdlFileUri, webService.getName()});
DOLUtils.getDefaultLogger().severe(msg);
throw new RuntimeException(msg);
}
}
} catch(IOException ioe) {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.servicewsdlfilenotreadable",
"wsdl file {0} for service-ref {1} cannot be opened : {2}",
new Object[] {webService.getWsdlFileUri(), webService.getName(), ioe.getMessage()});
DOLUtils.getDefaultLogger().severe(msg);
throw new RuntimeException(ioe);
}
if(webService.getMappingFileUri() == null) {
return;
}
try {
InputStream mappingFileInputStream =
archive_.getEntry(webService.getMappingFileUri());
if( mappingFileInputStream != null ) {
mappingFileInputStream.close();
} else {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.servicemappingfilenotfound",
"Web Service mapping file {0} for web service {1} not found",
new Object[] {webService.getMappingFileUri(), webService.getName()});
DOLUtils.getDefaultLogger().severe(msg);
throw new RuntimeException(msg);
}
} catch(IOException ioe) {
String msg = localStrings.getLocalString(
"enterprise.deployment.util.servicemappingfilenotreadable",
"Web Service mapping file {0} for web service {1} not found {2} ",
new Object[] {webService.getMappingFileUri(), webService.getName(), ioe});
DOLUtils.getDefaultLogger().severe(msg);
throw new RuntimeException(ioe);
}
}
/**
* All wsdl files and wsdl imported files live under a well-known
* wsdl directory.
* @param uri module uri
*/
public boolean isWsdlContent(String uri, BundleDescriptor bundle) {
String wsdlDir = bundle.getWsdlDir();
return (uri != null) && uri.startsWith(wsdlDir);
}
}