org.dspace.core.SelfNamedPlugin Maven / Gradle / Ivy
Show all versions of dspace-api Show documentation
/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.core;
/**
* Simple lightweight "framework" for managing plugins.
*
* This is a superclass of all classes which are managed as self-named
* plugins. They must extend SelfNamedPlugin or its
* subclass.
*
* Unfortunately, this has to be an abstract class because
* an interface may not have static methods. The
* pluginAliases method is static so it can be invoked
* without creating an instance, and thus let the aliases live in the
* class itself so there is no need for name mapping in a separate
* configuration file.
*
* See the documentation in the
* PluginService class for more details.
*
* @author Larry Stone
* @version $Revision$
* @see org.dspace.core.service.PluginService
*/
public abstract class SelfNamedPlugin implements NameAwarePlugin {
// the specific alias used to find the class that created this instance.
private String myName = null;
/**
* Get the names of this plugin implementation.
* Returns all names to which this plugin answers.
*
* A name should be a short generic name illustrative of the
* service, e.g. "PDF", "JPEG", "GIF"
* for media filters.
*
* Each name must be unique among all the plugins implementing any
* given interface, but it can be the same as a name of
* a plugin for a different interface. For example, two classes
* may each have a "default" name if they do not
* implement any of the same interfaces.
*
* @return array of names of this plugin
*/
public static String[] getPluginNames() {
return null;
}
@Override
public String getPluginInstanceName() {
return myName;
}
@Override
public void setPluginInstanceName(String name) {
myName = name;
}
}