github
/
pf4j
mirror of https://github.com/pf4j/pf4j.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Improve #292

pull/320/head
Decebal Suiu 6 years ago
parent
642f6343c9
commit
8a2674c539
11 changed files with 60 additions and 89 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 41
      pf4j/src/main/java/org/pf4j/AbstractPluginManager.java
  2. 4
      pf4j/src/main/java/org/pf4j/BasePluginRepository.java
  3. 2
      pf4j/src/main/java/org/pf4j/CompoundPluginRepository.java
  4. 2
      pf4j/src/main/java/org/pf4j/DefaultPluginRepository.java
  5. 20
      pf4j/src/main/java/org/pf4j/DefaultPluginStatusProvider.java
  6. 12
      pf4j/src/main/java/org/pf4j/PluginManager.java
  7. 2
      pf4j/src/main/java/org/pf4j/PluginRepository.java
  8. 6
      pf4j/src/main/java/org/pf4j/PluginStatusProvider.java
  9. 2
      pf4j/src/test/java/org/pf4j/DefaultPluginRepositoryTest.java
  10. 21
      pf4j/src/test/java/org/pf4j/DefaultPluginStatusProviderTest.java
  11. 3
      pf4j/src/test/java/org/pf4j/JarPluginRepositoryTest.java

41
pf4j/src/main/java/org/pf4j/AbstractPluginManager.java
Unescape View File

@ -232,11 +232,11 @@ public abstract class AbstractPluginManager implements PluginManager {
* Unload the specified plugin and it's dependents.
*/
@Override
public boolean unloadPlugin(String pluginId) {
public boolean unloadPlugin(String pluginId) throws PluginException {
return unloadPlugin(pluginId, true);
}
private boolean unloadPlugin(String pluginId, boolean unloadDependents) {
private boolean unloadPlugin(String pluginId, boolean unloadDependents) throws PluginException {
try {
if (unloadDependents) {
List<String> dependents = dependencyResolver.getDependents(pluginId);
@ -269,7 +269,7 @@ public abstract class AbstractPluginManager implements PluginManager {
try {
((Closeable) classLoader).close();
} catch (IOException e) {
log.error("Cannot close classloader", e);
throw new PluginException("Cannot close classloader", e);
}
}
}
@ -283,7 +283,7 @@ public abstract class AbstractPluginManager implements PluginManager {
}
@Override
public boolean deletePlugin(String pluginId) {
public boolean deletePlugin(String pluginId) throws PluginException {
checkPluginId(pluginId);
PluginWrapper pluginWrapper = getPlugin(pluginId);
@ -304,12 +304,7 @@ public abstract class AbstractPluginManager implements PluginManager {
}
// notify the plugin as it's deleted
try {
plugin.delete();
} catch (PluginException e) {
log.error(e.getMessage(), e);
return false;
}
Path pluginPath = pluginWrapper.getPluginPath();
@ -342,7 +337,7 @@ public abstract class AbstractPluginManager implements PluginManager {
* Start the specified plugin and its dependencies.
*/
@Override
public PluginState startPlugin(String pluginId) {
public PluginState startPlugin(String pluginId) throws PluginException {
checkPluginId(pluginId);
PluginWrapper pluginWrapper = getPlugin(pluginId);
@ -369,16 +364,12 @@ public abstract class AbstractPluginManager implements PluginManager {
startPlugin(dependency.getPluginId());
}
try {
log.info("Start plugin '{}'", getPluginLabel(pluginDescriptor));
pluginWrapper.getPlugin().start();
pluginWrapper.setPluginState(PluginState.STARTED);
startedPlugins.add(pluginWrapper);
firePluginStateEvent(new PluginStateEvent(this, pluginWrapper, pluginState));
} catch (PluginException e) {
log.error(e.getMessage(), e);
}
return pluginWrapper.getPluginState();
}
@ -413,11 +404,11 @@ public abstract class AbstractPluginManager implements PluginManager {
* Stop the specified plugin and it's dependents.
*/
@Override
public PluginState stopPlugin(String pluginId) {
public PluginState stopPlugin(String pluginId) throws PluginException {
return stopPlugin(pluginId, true);
}
private PluginState stopPlugin(String pluginId, boolean stopDependents) {
private PluginState stopPlugin(String pluginId, boolean stopDependents) throws PluginException {
checkPluginId(pluginId);
PluginWrapper pluginWrapper = getPlugin(pluginId);
@ -443,16 +434,12 @@ public abstract class AbstractPluginManager implements PluginManager {
}
}
try {
log.info("Stop plugin '{}'", getPluginLabel(pluginDescriptor));
pluginWrapper.getPlugin().stop();
pluginWrapper.setPluginState(PluginState.STOPPED);
startedPlugins.remove(pluginWrapper);
firePluginStateEvent(new PluginStateEvent(this, pluginWrapper, pluginState));
} catch (PluginException e) {
log.error(e.getMessage(), e);
}
return pluginWrapper.getPluginState();
}
@ -464,7 +451,7 @@ public abstract class AbstractPluginManager implements PluginManager {
}
@Override
public boolean disablePlugin(String pluginId) {
public boolean disablePlugin(String pluginId) throws PluginException {
checkPluginId(pluginId);
PluginWrapper pluginWrapper = getPlugin(pluginId);
@ -480,10 +467,7 @@ public abstract class AbstractPluginManager implements PluginManager {
firePluginStateEvent(new PluginStateEvent(this, pluginWrapper, PluginState.STOPPED));
if (!pluginStatusProvider.disablePlugin(pluginId)) {
return false;
}
pluginStatusProvider.disablePlugin(pluginId);
log.info("Disabled plugin '{}'", getPluginLabel(pluginDescriptor));
return true;
@ -493,7 +477,7 @@ public abstract class AbstractPluginManager implements PluginManager {
}
@Override
public boolean enablePlugin(String pluginId) {
public boolean enablePlugin(String pluginId) throws PluginException {
checkPluginId(pluginId);
PluginWrapper pluginWrapper = getPlugin(pluginId);
@ -509,9 +493,7 @@ public abstract class AbstractPluginManager implements PluginManager {
return true;
}
if (!pluginStatusProvider.enablePlugin(pluginId)) {
return false;
}
pluginStatusProvider.enablePlugin(pluginId);
pluginWrapper.setPluginState(PluginState.CREATED);
@ -612,7 +594,6 @@ public abstract class AbstractPluginManager implements PluginManager {
return extensionFactory;
}
// TODO remove
public PluginLoader getPluginLoader() {
return pluginLoader;
}

4
pf4j/src/main/java/org/pf4j/BasePluginRepository.java
Unescape View File

@ -86,7 +86,7 @@ public class BasePluginRepository implements PluginRepository {
}
@Override
public boolean deletePluginPath(Path pluginPath) {
public boolean deletePluginPath(Path pluginPath) throws PluginException {
if (!filter.accept(pluginPath.toFile())) {
return false;
}
@ -97,7 +97,7 @@ public class BasePluginRepository implements PluginRepository {
} catch (NoSuchFileException e) {
return false; // Return false on not found to be compatible with previous API (#135)
} catch (IOException e) {
throw new RuntimeException(e);
throw new PluginException(e);
}
}

2
pf4j/src/main/java/org/pf4j/CompoundPluginRepository.java
Unescape View File

@ -48,7 +48,7 @@ public class CompoundPluginRepository implements PluginRepository {
}
@Override
public boolean deletePluginPath(Path pluginPath) {
public boolean deletePluginPath(Path pluginPath) throws PluginException {
for (PluginRepository repository : repositories) {
if (repository.deletePluginPath(pluginPath)) {
return true;

2
pf4j/src/main/java/org/pf4j/DefaultPluginRepository.java
Unescape View File

@ -54,7 +54,7 @@ public class DefaultPluginRepository extends BasePluginRepository {
}
@Override
public boolean deletePluginPath(Path pluginPath) {
public boolean deletePluginPath(Path pluginPath) throws PluginException {
FileUtils.optimisticDelete(FileUtils.findWithEnding(pluginPath, ".zip", ".ZIP", ".Zip"));
return super.deletePluginPath(pluginPath);
}

20
pf4j/src/main/java/org/pf4j/DefaultPluginStatusProvider.java
Unescape View File

@ -66,31 +66,23 @@ public class DefaultPluginStatusProvider implements PluginStatusProvider {
}
@Override
public boolean disablePlugin(String pluginId) {
if (disabledPlugins.add(pluginId)) {
public void disablePlugin(String pluginId) throws PluginException {
disabledPlugins.add(pluginId);
try {
FileUtils.writeLines(disabledPlugins, pluginsRoot.resolve("disabled.txt").toFile());
} catch (IOException e) {
log.error("Failed to disable plugin {}", pluginId, e);
return false;
throw new PluginException(e);
}
}
return true;
}
@Override
public boolean enablePlugin(String pluginId) {
if (disabledPlugins.remove(pluginId)) {
public void enablePlugin(String pluginId) throws PluginException {
disabledPlugins.remove(pluginId);
try {
FileUtils.writeLines(disabledPlugins, pluginsRoot.resolve("disabled.txt").toFile());
} catch (IOException e) {
log.error("Failed to enable plugin {}", pluginId, e);
return false;
throw new PluginException(e);
}
}
return true;
}
}

12
pf4j/src/main/java/org/pf4j/PluginManager.java
Unescape View File

@ -85,7 +85,7 @@ public interface PluginManager {
*
* @return the plugin state
*/
PluginState startPlugin(String pluginId);
PluginState startPlugin(String pluginId) throws PluginException;
/**
* Stop all active plugins.
@ -97,7 +97,7 @@ public interface PluginManager {
*
* @return the plugin state
*/
PluginState stopPlugin(String pluginId);
PluginState stopPlugin(String pluginId) throws PluginException;
/**
* Unload a plugin.
@ -105,7 +105,7 @@ public interface PluginManager {
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if the plugin was unloaded
*/
boolean unloadPlugin(String pluginId);
boolean unloadPlugin(String pluginId) throws PluginException;
/**
* Disables a plugin from being loaded.
@ -113,7 +113,7 @@ public interface PluginManager {
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if plugin is disabled
*/
boolean disablePlugin(String pluginId);
boolean disablePlugin(String pluginId) throws PluginException;
/**
* Enables a plugin that has previously been disabled.
@ -121,7 +121,7 @@ public interface PluginManager {
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if plugin is enabled
*/
boolean enablePlugin(String pluginId);
boolean enablePlugin(String pluginId) throws PluginException;
/**
* Deletes a plugin.
@ -129,7 +129,7 @@ public interface PluginManager {
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if the plugin was deleted
*/
boolean deletePlugin(String pluginId);
boolean deletePlugin(String pluginId) throws PluginException;
ClassLoader getPluginClassLoader(String pluginId);

2
pf4j/src/main/java/org/pf4j/PluginRepository.java
Unescape View File

@ -39,6 +39,6 @@ public interface PluginRepository {
* @param pluginPath the plugin path
* @return true if deleted
*/
boolean deletePluginPath(Path pluginPath);
boolean deletePluginPath(Path pluginPath) throws PluginException;
}

6
pf4j/src/main/java/org/pf4j/PluginStatusProvider.java
Unescape View File

@ -33,16 +33,14 @@ public interface PluginStatusProvider {
* Disables a plugin from being loaded.
*
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if plugin is disabled
*/
boolean disablePlugin(String pluginId);
void disablePlugin(String pluginId) throws PluginException;
/**
* Enables a plugin that has previously been disabled.
*
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if plugin is enabled
*/
boolean enablePlugin(String pluginId);
void enablePlugin(String pluginId) throws PluginException;
}

2
pf4j/src/test/java/org/pf4j/DefaultPluginRepositoryTest.java
Unescape View File

@ -85,7 +85,7 @@ public class DefaultPluginRepositoryTest {
* Test of {@link DefaultPluginRepository#deletePluginPath(Path)} method.
*/
@Test
public void testDeletePluginPath() {
public void testDeletePluginPath() throws PluginException {
PluginRepository repository = new DefaultPluginRepository(pluginsPath, false);
assertTrue(Files.exists(pluginsPath.resolve("plugin-1.zip")));

21
pf4j/src/test/java/org/pf4j/DefaultPluginStatusProviderTest.java
Unescape View File

@ -60,58 +60,59 @@ public class DefaultPluginStatusProviderTest {
}
@Test
public void testDisablePlugin() throws IOException {
public void testDisablePlugin() throws Exception {
createEnabledFile();
createDisabledFile();
PluginStatusProvider statusProvider = new DefaultPluginStatusProvider(pluginsPath);
statusProvider.disablePlugin("plugin-1");
assertTrue(statusProvider.disablePlugin("plugin-1"));
assertTrue(statusProvider.isPluginDisabled("plugin-1"));
assertTrue(statusProvider.isPluginDisabled("plugin-2"));
assertTrue(statusProvider.isPluginDisabled("plugin-3"));
}
@Test
public void testDisablePluginWithEnableEmpty() throws IOException {
public void testDisablePluginWithEnableEmpty() throws Exception {
createDisabledFile();
PluginStatusProvider statusProvider = new DefaultPluginStatusProvider(pluginsPath);
statusProvider.disablePlugin("plugin-1");
assertTrue(statusProvider.disablePlugin("plugin-1"));
assertTrue(statusProvider.isPluginDisabled("plugin-1"));
assertTrue(statusProvider.isPluginDisabled("plugin-2"));
assertFalse(statusProvider.isPluginDisabled("plugin-3"));
}
@Test
public void testEnablePlugin() throws IOException {
public void testEnablePlugin() throws Exception {
createEnabledFile();
PluginStatusProvider statusProvider = new DefaultPluginStatusProvider(pluginsPath);
statusProvider.enablePlugin("plugin-2");
assertTrue(statusProvider.enablePlugin("plugin-2"));
assertFalse(statusProvider.isPluginDisabled("plugin-1"));
assertFalse(statusProvider.isPluginDisabled("plugin-2"));
assertTrue(statusProvider.isPluginDisabled("plugin-3"));
}
@Test
public void testEnablePluginWithEnableEmpty() {
public void testEnablePluginWithEnableEmpty() throws Exception{
PluginStatusProvider statusProvider = new DefaultPluginStatusProvider(pluginsPath);
statusProvider.enablePlugin("plugin-2");
assertTrue(statusProvider.enablePlugin("plugin-2"));
assertFalse(statusProvider.isPluginDisabled("plugin-1"));
assertFalse(statusProvider.isPluginDisabled("plugin-2"));
assertFalse(statusProvider.isPluginDisabled("plugin-3"));
}
@Test
public void testDisablePluginWithoutDisabledFile() {
public void testDisablePluginWithoutDisabledFile() throws Exception {
PluginStatusProvider statusProvider = new DefaultPluginStatusProvider(pluginsPath);
assertFalse(statusProvider.isPluginDisabled("plugin-1"));
assertTrue(statusProvider.disablePlugin("plugin-1"));
statusProvider.disablePlugin("plugin-1");
assertTrue(statusProvider.isPluginDisabled("plugin-1"));
}

3
pf4j/src/test/java/org/pf4j/JarPluginRepositoryTest.java
Unescape View File

@ -18,7 +18,6 @@ package org.pf4j;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
@ -39,7 +38,7 @@ public class JarPluginRepositoryTest {
* Test of {@link JarPluginRepository#deletePluginPath(Path)} method.
*/
@Test
public void testDeletePluginPath() throws IOException {
public void testDeletePluginPath() throws Exception {
PluginRepository repository = new JarPluginRepository(pluginsPath);
Path plugin1Path = Files.createDirectory(pluginsPath.resolve("plugin-1"));

Write Preview
Loading…
Cancel
Save