Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8270286: com.sun.net.httpserver.spi.HttpServerProvider: remove use of deprecated API #4789

Closed
wants to merge 3 commits into from
Closed
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -29,6 +29,7 @@
import com.sun.net.httpserver.HttpsServer;

import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.net.InetSocketAddress;
import java.security.AccessController;
import java.security.PrivilegedAction;
@@ -96,12 +97,17 @@ private static boolean loadProviderFromProperty() {
if (cn == null)
return false;
try {
@SuppressWarnings("deprecation")
Object o = Class.forName(cn, true,
ClassLoader.getSystemClassLoader()).newInstance();
provider = (HttpServerProvider)o;
return true;
} catch (ClassNotFoundException |
var cls = Class.forName(cn, false, ClassLoader.getSystemClassLoader());
if (HttpServerProvider.class.isAssignableFrom(cls)) {
provider = (HttpServerProvider) cls.getDeclaredConstructor().newInstance();
return true;
} else {
throw new ServiceConfigurationError("not assignable to HttpServerProvider: "
+ cls.getName());
}
} catch (InvocationTargetException |
NoSuchMethodException |
ClassNotFoundException |
IllegalAccessException |
InstantiationException |
SecurityException x) {
@@ -0,0 +1,148 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/*
* @test
* @bug 8270286
* @summary Test for HttpServerProvider::loadProviderFromProperty
* @run testng/othervm
* -Dcom.sun.net.httpserver.HttpServerProvider=HttpServerProviderTest$ProviderP
* HttpServerProviderTest
* @run testng/othervm
* -Dcom.sun.net.httpserver.HttpServerProvider=HttpServerProviderTest$ProviderPNPC
* HttpServerProviderTest
* @run testng/othervm
* -Dcom.sun.net.httpserver.HttpServerProvider=HttpServerProviderTest$ProviderNP
* HttpServerProviderTest
* @run testng/othervm
* -Dcom.sun.net.httpserver.HttpServerProvider=HttpServerProviderTest$ProviderT
* HttpServerProviderTest
This conversation was marked as resolved by FrauBoes

This comment has been minimized.

@ChrisHegarty

ChrisHegarty Jul 21, 2021
Member

Maybe add a scenario where the given property is not a valid class, e..g DoesNotExist, or something.

This comment has been minimized.

@FrauBoes

FrauBoes Jul 21, 2021
Author Member

Good point, thanks.

*/

import java.lang.reflect.InvocationTargetException;
import java.net.InetSocketAddress;
import java.util.ServiceConfigurationError;
import com.sun.net.httpserver.HttpServer;
import com.sun.net.httpserver.HttpsServer;
import com.sun.net.httpserver.spi.HttpServerProvider;
import org.testng.annotations.Test;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.expectThrows;

public class HttpServerProviderTest {
public final static String PROPERTY_KEY = "com.sun.net.httpserver.HttpServerProvider";

@Test
public void test() throws Exception {
var provider = System.getProperty(PROPERTY_KEY);
switch (provider) {
case "HttpServerProviderTest$ProviderP" -> testPublic();
case "HttpServerProviderTest$ProviderPNPC" -> testPublicNonPublicConstructor();
case "HttpServerProviderTest$ProviderNP" -> testNonPublic();
case "HttpServerProviderTest$ProviderT" -> testThrowingConstructor();
default -> throw new AssertionError("unexpected test case");
}
}

private void testPublic() throws Exception {
var n = ProviderP.class.getName();
assertEquals(System.getProperty(PROPERTY_KEY), n);

var p = HttpServerProvider.provider();
assertNull(p.createHttpServer(null, 0));
assertNull(p.createHttpsServer(null, 0));
}

private void testPublicNonPublicConstructor() {
var n = ProviderPNPC.class.getName();
assertEquals(System.getProperty(PROPERTY_KEY), n);

var e = expectThrows(ServiceConfigurationError.class, HttpServerProvider::provider);
assertEquals(e.getClass(), ServiceConfigurationError.class);
assertEquals(e.getCause().getClass(), IllegalAccessException.class);
}

private void testNonPublic() {
var n = ProviderNP.class.getName();
assertEquals(System.getProperty(PROPERTY_KEY), n);

var e = expectThrows(ServiceConfigurationError.class, HttpServerProvider::provider);
assertEquals(e.getClass(), ServiceConfigurationError.class);
assertEquals(e.getCause().getClass(), IllegalAccessException.class);
}

private void testThrowingConstructor() {
var cn = ProviderT.class.getName();
assertEquals(System.getProperty(PROPERTY_KEY), cn);

var e = expectThrows(ServiceConfigurationError.class, HttpServerProvider::provider);
assertEquals(e.getClass(), ServiceConfigurationError.class);
assertEquals(e.getCause().getClass(), InvocationTargetException.class);
assertEquals(e.getCause().getCause().getMessage(), "throwing constructor");
}

/**
* Test provider that is public (P)
*/
public static class ProviderP extends HttpServerProvider {
// public default constructor
@Override
public HttpServer createHttpServer(InetSocketAddress addr, int backlog) { return null; }
@Override
public HttpsServer createHttpsServer(InetSocketAddress addr, int backlog) { return null; }
}

/**
* Test provider that is public with a non-public constructor (PNPC)
*/
public static class ProviderPNPC extends HttpServerProvider {
ProviderPNPC() { super(); }
@Override
public HttpServer createHttpServer(InetSocketAddress addr, int backlog) { return null; }
@Override
public HttpsServer createHttpsServer(InetSocketAddress addr, int backlog) { return null; }
}

/**
* Test provider that is not public (NP)
*/
static class ProviderNP extends HttpServerProvider {
// package-private default constructor
@Override
This conversation was marked as resolved by FrauBoes

This comment has been minimized.

@ChrisHegarty

ChrisHegarty Jul 21, 2021
Member

The class is pp here, while the default constructor ( as generated by the compiler ) is public. So the comment needs a little adjustment, or better still just add an explicit no-args public constructor.

This comment has been minimized.

@FrauBoes

FrauBoes Jul 21, 2021
Author Member

The default constructor has the same access modifier as the class (or is pp respectively), as per JLS 8.8.9. This being said, it's better to spell out the access control here, so I'll add explicit constructors to all test provider classes.

public HttpServer createHttpServer(InetSocketAddress addr, int backlog) { return null; }
@Override
public HttpsServer createHttpsServer(InetSocketAddress addr, int backlog) { return null; }
}

/**
* Test provider with a constructor that throws
*/
public static class ProviderT extends HttpServerProvider {
public ProviderT() { throw new AssertionError("throwing constructor"); }
@Override
public HttpServer createHttpServer(InetSocketAddress addr, int backlog) { return null; }
@Override
public HttpsServer createHttpsServer(InetSocketAddress addr, int backlog) { return null; }
}
}