forked from apache/pulsar
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change ContextClassLoader to NarClassLoader in AdditionalServlet (apa…
…che#13501) ### Motivation It's ``AddtionalServlet`` side change, like apache#11270 ### Modifications Change context class loader through Thread.currentThread().setContextClassLoader(classLoader) before every protocol handler callback, and change it back to original class loader afterwards.
- Loading branch information
1 parent
e9e3ea3
commit ae4bd52
Showing
4 changed files
with
166 additions
and
22 deletions.
There are no files selected for viewing
37 changes: 37 additions & 0 deletions
37
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ClassLoaderSwitcher.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
/** | ||
* 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.apache.pulsar.broker; | ||
|
||
/** | ||
* Help to switch the class loader of current thread to the NarClassLoader, and change it back when it's done. | ||
* With the help of try-with-resources statement, the code would be cleaner than using try finally every time. | ||
*/ | ||
public class ClassLoaderSwitcher implements AutoCloseable { | ||
private final ClassLoader prevClassLoader; | ||
|
||
public ClassLoaderSwitcher(ClassLoader classLoader) { | ||
prevClassLoader = Thread.currentThread().getContextClassLoader(); | ||
Thread.currentThread().setContextClassLoader(classLoader); | ||
} | ||
|
||
@Override | ||
public void close() { | ||
Thread.currentThread().setContextClassLoader(prevClassLoader); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
...ava/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServletWithClassLoaderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
/** | ||
* 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.apache.pulsar.broker.web.plugin.servlet; | ||
|
||
import static org.mockito.ArgumentMatchers.same; | ||
import static org.mockito.Mockito.mock; | ||
import static org.mockito.Mockito.times; | ||
import static org.mockito.Mockito.verify; | ||
import static org.mockito.Mockito.when; | ||
import static org.testng.Assert.assertEquals; | ||
import static org.testng.Assert.assertNull; | ||
import org.apache.pulsar.broker.ServiceConfiguration; | ||
import org.apache.pulsar.common.configuration.PulsarConfiguration; | ||
import org.apache.pulsar.common.nar.NarClassLoader; | ||
import org.eclipse.jetty.servlet.ServletHolder; | ||
import org.testng.annotations.Test; | ||
|
||
|
||
/** | ||
* Unit test {@link AdditionalServletWithClassLoader}. | ||
*/ | ||
@Test(groups = "broker") | ||
public class AdditionalServletWithClassLoaderTest { | ||
|
||
@Test | ||
public void testWrapper() { | ||
AdditionalServlet servlet = mock(AdditionalServlet.class); | ||
NarClassLoader loader = mock(NarClassLoader.class); | ||
AdditionalServletWithClassLoader wrapper = new AdditionalServletWithClassLoader(servlet, loader); | ||
// test getBasePath | ||
String basePath = "bathPath"; | ||
when(servlet.getBasePath()).thenReturn(basePath); | ||
assertEquals(basePath, wrapper.getBasePath()); | ||
verify(servlet, times(1)).getBasePath(); | ||
// test loadConfig | ||
ServiceConfiguration conf = new ServiceConfiguration(); | ||
wrapper.loadConfig(conf); | ||
verify(servlet, times(1)).loadConfig(same(conf)); | ||
// test getServlet | ||
assertEquals(wrapper.getServlet(),servlet); | ||
// test getServletHolder | ||
ServletHolder servletHolder = new ServletHolder(); | ||
when(servlet.getServletHolder()).thenReturn(servletHolder); | ||
assertEquals(wrapper.getServletHolder(),servletHolder); | ||
verify(servlet, times(1)).getServletHolder(); | ||
} | ||
|
||
@Test | ||
public void testClassLoaderSwitcher() throws Exception { | ||
NarClassLoader narLoader = mock(NarClassLoader.class); | ||
AdditionalServlet servlet = new AdditionalServlet() { | ||
@Override | ||
public void loadConfig(PulsarConfiguration pulsarConfiguration) { | ||
assertEquals(Thread.currentThread().getContextClassLoader(), narLoader); | ||
} | ||
|
||
@Override | ||
public String getBasePath() { | ||
assertEquals(Thread.currentThread().getContextClassLoader(), narLoader); | ||
return "base-path"; | ||
} | ||
|
||
@Override | ||
public ServletHolder getServletHolder() { | ||
assertEquals(Thread.currentThread().getContextClassLoader(), narLoader); | ||
return null; | ||
} | ||
|
||
@Override | ||
public void close() { | ||
assertEquals(Thread.currentThread().getContextClassLoader(), narLoader); | ||
} | ||
}; | ||
|
||
AdditionalServletWithClassLoader additionalServletWithClassLoader = | ||
new AdditionalServletWithClassLoader(servlet, narLoader); | ||
ClassLoader curClassLoader = Thread.currentThread().getContextClassLoader(); | ||
// test class loader | ||
assertEquals(additionalServletWithClassLoader.getClassLoader(), narLoader); | ||
// test getBasePath | ||
assertEquals(additionalServletWithClassLoader.getBasePath(), "base-path"); | ||
assertEquals(Thread.currentThread().getContextClassLoader(), curClassLoader); | ||
// test loadConfig | ||
ServiceConfiguration conf = new ServiceConfiguration(); | ||
additionalServletWithClassLoader.loadConfig(conf); | ||
assertEquals(Thread.currentThread().getContextClassLoader(), curClassLoader); | ||
// test getServletHolder | ||
assertNull(additionalServletWithClassLoader.getServletHolder()); | ||
assertEquals(Thread.currentThread().getContextClassLoader(), curClassLoader); | ||
// test getServlet | ||
assertEquals(additionalServletWithClassLoader.getServlet(), servlet); | ||
assertEquals(Thread.currentThread().getContextClassLoader(), curClassLoader); | ||
// test close | ||
additionalServletWithClassLoader.close(); | ||
assertEquals(Thread.currentThread().getContextClassLoader(), curClassLoader); | ||
|
||
} | ||
} |