org.netbeans.modules.payara.jakartaee.Hk2LibraryProvider Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.payara.jakartaee;
import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import org.netbeans.modules.payara.tooling.data.PayaraLibrary;
import org.netbeans.modules.payara.tooling.data.PayaraServer;
import org.netbeans.modules.payara.tooling.server.config.ConfigBuilder;
import org.netbeans.modules.payara.tooling.server.config.ConfigBuilderProvider;
import org.netbeans.api.project.libraries.Library;
import org.netbeans.api.project.libraries.LibraryManager;
import static org.netbeans.modules.payara.jakartaee.ide.Hk2PluginProperties.fileToUrl;
import org.netbeans.modules.j2ee.deployment.common.api.J2eeLibraryTypeProvider;
import org.netbeans.spi.project.libraries.LibraryImplementation;
import org.openide.ErrorManager;
import org.openide.filesystems.FileUtil;
import org.openide.modules.InstalledFileLocator;
/**
* Payara bundled libraries provider.
*
* Builds Library instance containing Jersey library from Payara
* modules..
*
* @author Tomas Kraus, Peter Benedikovic
*/
public class Hk2LibraryProvider /*implements JaxRsStackSupportImplementation*/ {
////////////////////////////////////////////////////////////////////////////
// Class attributes //
////////////////////////////////////////////////////////////////////////////
private static final Logger LOGGER = Logger.getLogger("payara-jakartaee");
/** Library provider type. */
private static final String PROVIDER_TYPE = "j2se";
/** Java EE library name suffix to be added after server instance name.
* Java EE library name must be unique so combination of instance name
* and some common suffix is used. */
private static final String JAVAEE_NAME_SUFFIX = " Java EE";
/**
* MicroProfile library name suffix to be added after server instance name.
* MicroProfile library name must be unique so combination of instance name
* and some common suffix is used.
*/
private static final String MICROPROFILE_NAME_SUFFIX = " MicroProfile";
/** Java EE library name suffix to be added after server instance name.
* Jersey library name must be unique so combination of instance name
* and some common suffix is used. */
private static final String JERSEY_NAME_SUFFIX = " Jersey";
/** JAX-RS library name suffix to be added after server instance name.
* JAX-RS library name must be unique so combination of instance name
* and some common suffix is used. */
private static final String JAXRS_NAME_SUFFIX = " JAX-RS";
/** Java EE library name pattern to search for it in
* PayaraLibrary list. */
private final Pattern JAVAEE_PATTERN = Pattern.compile("[jJ]ava {0,1}[eE]{2}");
/**
* MicroProfile library name pattern to search for it in
* PayaraLibrary list.
*/
private final Pattern MICROPROFILE_PATTERN = Pattern.compile("[mM]icro[pP]rofile");
/** Jersey library name pattern to search for it in
* PayaraLibrary list. */
private final Pattern JERSEY_PATTERN = Pattern.compile("[jJ]ersey.*");
/** JAX-RS library name pattern to search for it in
* PayaraLibrary list. */
private final Pattern JAXRS_PATTERN
= Pattern.compile("[jJ][aA][xX][ -]{0,1}[rR][sS]");
/** Code base for file locator. */
static final String JAVAEE_DOC_CODE_BASE
= "org.netbeans.modules.j2ee.platform";
/** Internal {@see PayaraServer} to {@see Hk2LibraryProvider}
* mapping. */
private static final Map providers
= new HashMap<>();
////////////////////////////////////////////////////////////////////////////
// Static methods //
////////////////////////////////////////////////////////////////////////////
/**
* Returns {@see Hk2LibraryProvider} class instance for specific server
* instance.
*
* Provider instances for individual {@see PayaraServer} instances
* are shared.
*
* @param server {@see PayaraServer} instance for which provider
* is returned.
* @return {@see Hk2LibraryProvider} class instance for given server
* instance.
*/
public static Hk2LibraryProvider getProvider(PayaraServer server) {
Hk2LibraryProvider provider;
synchronized(providers) {
if ((provider = providers.get(server)) == null)
providers.put(
server, provider = new Hk2LibraryProvider(server));
}
return provider;
}
////////////////////////////////////////////////////////////////////////////
// Instance attributes //
////////////////////////////////////////////////////////////////////////////
/** Library builder associated with current platform.
* This attribute should be accessed only using {@see #getBuilder()} even
* internally. */
private volatile ConfigBuilder builder;
/** Payara server home directory. */
private final String serverHome;
/** Payara server name. */
private final String serverName;
/** Payara server instance. */
private final PayaraServer server;
/** Java EE library name associated with current Payara server context.
* This is lazy initialized internal cache. Do not access this attribute
* outside {@see #getJavaEEName()} method! */
private volatile String javaEEName = null;
/**
* MicroProfile library name associated with current Payara server context.
* This is lazy initialized internal cache. Do not access this attribute
* outside {@see #getMicroProfileName()} method!
*/
private volatile String microProfileName = null;
/** Jersey library name associated with current Payara server context.
* This is lazy initialized internal cache. Do not access this attribute
* outside {@see #getJerseyName()} method! */
private volatile String jerseyName = null;
/** Jersey JAX-RS name associated with current Payara server context.
* This is lazy initialized internal cache. Do not access this attribute
* outside {@see #getJaxRsName()} method! */
private volatile String jaxRsName = null;
////////////////////////////////////////////////////////////////////////////
// Constructors //
////////////////////////////////////////////////////////////////////////////
/**
* Creates an instance of Jersey library provider.
*
* @param server Payara server entity.
*/
private Hk2LibraryProvider(PayaraServer server) {
if (server == null) {
throw new IllegalArgumentException(
"Payara server entity shall not be null.");
}
serverHome = server.getServerHome();
serverName = server.getName();
this.server = server;
}
////////////////////////////////////////////////////////////////////////////
// Methods //
////////////////////////////////////////////////////////////////////////////
/**
* Get Java EE library name for this server context.
*
* This library name shall be registered in default {@see LibraryManager}
* and is unique for Jersey modules of given Payara server instance.
* Library name is cached after first usage.
*
* @return Java EE library name for this server context.
*/
public String getJavaEEName() {
if (javaEEName != null) {
return javaEEName;
}
synchronized (this) {
StringBuilder sb = new StringBuilder(
serverName.length() + JAVAEE_NAME_SUFFIX.length());
sb.append(serverName);
sb.append(JAVAEE_NAME_SUFFIX);
javaEEName = sb.toString();
}
return javaEEName;
}
/**
* Get MicroProfile library name for this server context.
*
* This library name shall be registered in default {@see LibraryManager}
* and is unique for MicroProfile modules of given Payara
* server instance. Library name is cached after first usage.
*
* @return MicroProfile library name for this server context.
*/
public String getMicroProfileName() {
if (microProfileName != null) {
return microProfileName;
}
synchronized (this) {
StringBuilder sb = new StringBuilder(
serverName.length() + MICROPROFILE_NAME_SUFFIX.length());
sb.append(serverName);
sb.append(MICROPROFILE_NAME_SUFFIX);
microProfileName = sb.toString();
}
return microProfileName;
}
/**
* Get Jersey library name for this server context.
*
* This library name shall be registered in default {@see LibraryManager}
* and is unique for Jersey modules of given Payara server instance.
* Library name is cached after first usage.
*
* @return Jersey library name for this server context.
*/
public String getJerseyName() {
if (jerseyName != null) {
return jerseyName;
}
synchronized (this) {
StringBuilder sb = new StringBuilder(
serverName.length() + JERSEY_NAME_SUFFIX.length());
sb.append(serverName);
sb.append(JERSEY_NAME_SUFFIX);
jerseyName = sb.toString();
}
return jerseyName;
}
/**
* Get JAX-RS library name for this server context.
*
* This library name shall be registered in default {@see LibraryManager}
* and is unique for Jersey modules of given Payara server instance.
* Library name is cached after first usage.
*
* @return JAX-RS library name for this server context.
*/
public String getJaxRsName() {
if (jaxRsName != null) {
return jaxRsName;
}
synchronized (this) {
StringBuilder sb = new StringBuilder(
serverName.length() + JAXRS_NAME_SUFFIX.length());
sb.append(serverName);
sb.append(JAXRS_NAME_SUFFIX);
jaxRsName = sb.toString();
}
return jaxRsName;
}
/**
* Return Jersey libraries available in Payara.
*
* @return Jersey libraries available in Payara.
*/
public Library getJerseyLibrary() {
return getLibrary(JERSEY_PATTERN, getJerseyName());
}
/**
* Set {@see LibraryImplementation} content for Jersey libraries
* available in Payara.
*
* @param lib Target {@see LibraryImplementation}.
* @param libraryName Library name in returned Library instance.
*/
public void setJerseyImplementation(
LibraryImplementation lib, String libraryName) {
setLibraryImplementationContent(lib, JERSEY_PATTERN, libraryName);
}
/**
* Get {@see List} of class path {@see URL}s for Jersey libraries.
*
* @return {@see List} of class path {@see URL}s for Jersey libraries.
*/
public List getJerseyClassPathURLs() {
return getLibraryClassPathURLs(JERSEY_PATTERN);
}
/**
* Return JAX-RS libraries available in Payara.
*
* @return JAX-RS libraries available in Payara.
*/
public Library getJaxRsLibrary() {
return getLibrary(JAXRS_PATTERN, getJaxRsName());
}
/**
* Set {@see LibraryImplementation} content for JAX-RS libraries
* available in Payara.
*
* @param lib Target {@see LibraryImplementation}.
* @param libraryName Library name in returned Library instance.
*/
public void setJaxRsLibraryImplementation(
LibraryImplementation lib, String libraryName) {
setLibraryImplementationContent(lib, JAXRS_PATTERN, libraryName);
}
/**
* Get {@see List} of class path {@see URL}s for JAX-RS libraries.
*
* @return {@see List} of class path {@see URL}s for JAX-RS libraries.
*/
public List getJaxRsClassPathURLs() {
return getLibraryClassPathURLs(JAXRS_PATTERN);
}
/**
* Return Java EE libraries available in Payara.
*
* @return Java EE libraries available in Payara.
*/
public Library getJavaEELibrary() {
return getLibrary(JAVAEE_PATTERN, getJavaEEName());
}
/**
* Return MicroProfile libraries available in Payara.
*
* @return MicroProfile libraries available in Payara.
*/
public Library getMicroProfileLibrary() {
return getLibrary(MICROPROFILE_PATTERN, getMicroProfileName());
}
/**
* Set {@see LibraryImplementation} content for Java EE libraries
* available in Payara.
*
* @param lib Target {@see LibraryImplementation}.
* @param libraryName Library name in returned Library instance.
*/
public void setJavaEELibraryImplementation(
LibraryImplementation lib, String libraryName) {
setLibraryImplementationContent(lib, JAVAEE_PATTERN, libraryName);
}
/**
* Get {@see List} of class path {@see URL}s for Java EE libraries.
*
* @return {@see List} of class path {@see URL}s for Java EE libraries.
*/
public List getJavaEEClassPathURLs() {
return getLibraryClassPathURLs(JAVAEE_PATTERN);
}
/**
* Get {@see List} of class path {@see URL}s for MicroProfile libraries.
*
* @return {@see List} of class path {@see URL}s for MicroProfile libraries.
*/
public List getMicroProfileClassPathURLs() {
return getLibraryClassPathURLs(MICROPROFILE_PATTERN);
}
/**
* Return libraries available in Payara.
*
* @param namePattern Library name pattern to search for it in
* PayaraLibrary list.
* @param libraryName Library name in returned Library instance.
* @return Requested Payara library.
*/
private Library getLibrary(Pattern namePattern, String libraryName) {
Library lib = LibraryManager.getDefault().getLibrary(libraryName);
if (lib != null) {
return lib;
}
ConfigBuilder cb = ConfigBuilderProvider.getBuilder(server);
List gfLibs = cb.getPlatformLibraries(server.getPlatformVersion());
for (PayaraLibrary gfLib : gfLibs) {
if (namePattern.matcher(gfLib.getLibraryID()).matches()) {
Map> contents = new HashMap<>(1);
Map properties = new HashMap<>(2);
contents.put("classpath", translateArchiveUrls(gfLib.getClasspath()));
contents.put("javadoc", translateArchiveUrls(gfLib.getJavadocs()));
properties.put("maven-dependencies", gfLib.getMavenDeps());
properties.put("maven-repositories", "default");
try {
return LibraryManager.getDefault().createLibrary(
PROVIDER_TYPE,
libraryName,
null,
null,
contents,
properties);
} catch (IOException ioe) {
LOGGER.log(Level.WARNING,
"Could not create Jersey library for "
+ serverName + ": ", ioe);
}
}
}
return null;
}
/**
* Set {@see LibraryImplementation} content for given library name.
*
* @param lib Target {@see LibraryImplementation}.
* @param namePattern Library name pattern to search for it in
* PayaraLibrary list.
* @param libraryName Library name in returned Library instance.
*/
private void setLibraryImplementationContent(LibraryImplementation lib,
Pattern namePattern, String libraryName) {
ConfigBuilder cb = ConfigBuilderProvider.getBuilder(server);
List pfLibs = cb.getPlatformLibraries(server.getPlatformVersion());
for (PayaraLibrary pfLib : pfLibs) {
if (namePattern.matcher(pfLib.getLibraryID()).matches()) {
List javadocLookups = pfLib.getJavadocLookups();
lib.setName(libraryName);
// Build class path
List cp = new ArrayList<>();
for (URL url : pfLib.getClasspath()) {
if (FileUtil.isArchiveFile(url)) {
cp.add(FileUtil.getArchiveRoot(url));
} else {
cp.add(url);
}
}
// Build java docs
List javadoc = new ArrayList<>();
if (javadocLookups != null) {
for (String lookup : javadocLookups) {
try {
File j2eeDoc = InstalledFileLocator
.getDefault().locate(lookup,
JAVAEE_DOC_CODE_BASE, false);
if (j2eeDoc != null) {
javadoc.add(fileToUrl(j2eeDoc));
}
} catch (MalformedURLException e) {
ErrorManager.getDefault()
.notify(ErrorManager.INFORMATIONAL, e);
}
}
}
lib.setContent(J2eeLibraryTypeProvider.VOLUME_TYPE_CLASSPATH,
cp);
lib.setContent(J2eeLibraryTypeProvider.VOLUME_TYPE_JAVADOC,
javadoc);
}
}
}
/**
* Get list of class path {@see URL}s for given library name.
*
* @param namePattern Library name pattern to search for it in
* PayaraLibrary list.
* @param libraryName Library name in returned Library instance.
*/
private List getLibraryClassPathURLs(Pattern namePattern) {
ConfigBuilder cb = ConfigBuilderProvider.getBuilder(server);
List pfLibs = cb.getPlatformLibraries(server.getPlatformVersion());
for (PayaraLibrary pfLib : pfLibs) {
if (namePattern.matcher(pfLib.getLibraryID()).matches()) {
return pfLib.getClasspath();
}
}
return Collections.emptyList();
}
private List translateArchiveUrls(List urls) {
List result = new ArrayList<>(urls.size());
for (URL u : urls) {
if (FileUtil.isArchiveFile(u)) {
result.add(FileUtil.getArchiveRoot(u));
} else {
result.add(u);
}
}
return result;
}
}