Package eu.rarogsoftware.rarog.platform.api.plugins

Interface PluginArtifact

All Known Implementing Classes:
JarPluginArtifact
public interface PluginArtifact
Interface representing an artifact used to install the plugin.

  • Method Details

    • getResource

      InputStream getResource(String location) throws IOException
      Returns the resource located in the artifact.
      Parameters:
      location - determines the resource to be returned
      Returns:
      stream of the requested resource
      Throws:
      IOException - when problems accessing the resource occur.

    • getManifest

      PluginManifest getManifest() throws IOException, PluginException
      Retrieves a PluginManifest from the artifact.
      Returns:
      plugin's manifest
      Throws:
      IOException - when problems accessing the artifact occur.
      PluginException - when the artifact doesn't contain a valid manifest.

    • getId

      String getId()
      Returns a string identifying the artifact.
      Returns:
      string identifying the artifact e.g. 'jar:/path/to/file.jar'

    • exists

      boolean exists()
      Checks if the underlying resource actually exists.
      Returns:
      does the underlying resource actually exists.