Spring/spring-plugin
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Switch from Docbook to Markdown for documentation.

Browse Source 
Added README.markdown with the current state of the reference docs in Markdown.
This commit is contained in:
Oliver Gierke
2012-02-22 16:03:18 +01:00
parent a9192a1808
commit 6ab36253aa
57 changed files with 295 additions and 1858 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
metadata/src/docbkx/metadata.xml
View File

@@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="metadata">
<title>Metadata</title>
<para>For plugin architectures it is essential to capture metadata
information about plugin instances. A very core set of metadata (name,
version) also serves as identifier of a plugin and thus can be used. The
Spring Plugin metadata module provides support to capture metadata.</para>
<section id="metadata.core-concepts">
<title>Core concepts</title>
<para>The metadata module actually builds around two core interfaces,
<interfacename>PluginMetadata</interfacename> and
<interfacename>MetadataProvider</interfacename>:</para>
<example>
<title>Core concepts</title>
<programlisting language="java">public interface PluginMetadata {
String getName();
String getVersion();
}
public interface MetadataProvider {
PluginMetadata getMetadata();
}</programlisting>
</example>
<para>The <interfacename>PluginMetadata</interfacename> interface captures
the required properties to define an identifyable plugin. This means, that
implementations should ensure uniqueness through these two properties.
With <classname>SimplePluginMetadata</classname> Spring Plugin provides a
Java bean style class to capture metadata. Of course applications can and
should provide extended metadata information according to their needs. The
very narrow interface is only targeted at integrating the metadata concept
with the <classname>PluginRegistry</classname> (see <xref
linkend="core.plugin-registry" />) without bothering developers with too
much information required.</para>
<para>The <interfacename>MetadataProvider</interfacename> interface is to
be used in application plugin interfaces to indicate that they can provide
metadata. To ease plugin implementation we provide
<classname>AbstractMetadataBasedPlugin</classname> that uses the internal
metadata to implement <methodname>supports(..)</methodname> method of
<interfacename>Plugin</interfacename>. Extending this base class plugins
with metadata as selection criteria can easily be build. This way you
could store the metadata in user specific configuration files and use this
to select a distinct plugin specific to a given user.</para>
</section>
</chapter>