org.dspace.core.NameAwarePlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation

DSpace core data model and service APIs.

There is a newer version: 8.0

/**
 * 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;

/**
 * This is the interface that should be implemented by all the named plugin that
 * like to be aware of their name
 *
 * @author Andrea Bollini (andrea.bollini at 4science.it)
 * @version $Revision$
 * @see org.dspace.core.service.PluginService
 */
public interface NameAwarePlugin {

    /**
     * Get the instance's particular name.
     * Returns the name by which the class was chosen when
     * this instance was created.  Only works for instances created
     * by PluginService, or if someone remembers to call setPluginName.
     * 
     * Useful when the implementation class wants to be configured differently
     * when it is invoked under different names.
     *
     * @return name or null if not available.
     */
    public String getPluginInstanceName();

    /**
     * Set the name under which this plugin was instantiated.
     * Not to be invoked by application code, it is
     * called automatically by PluginService.getNamedPlugin()
     * when the plugin is instantiated.
     *
     * @param name -- name used to select this class.
     */
    public void setPluginInstanceName(String name);
}