Package org.hansken.plugin.extraction.api

Class PluginId

java.lang.Object

org.hansken.plugin.extraction.api.PluginId

public class PluginId
extends Object

Identifier of a plugin, consisting of domain, category and name. Needs to be unique among all tools/plugins.

Author:

Netherlands Forensic Institute

Constructor Summary

Constructors

Constructor	Description
PluginId(String domain, String category, String name)	Create a unique identifier for a plugin, consisting of domain, category and name.

Method Summary

Modifier and Type	Method	Description
String	category()
String	domain()
String	name()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PluginId

public PluginId(String domain,
 String category,
 String name)

Create a unique identifier for a plugin, consisting of domain, category and name.

Parameters:

domain - the domain of the organisation, for example "nfi.nl"

category - the action group of the plugin, for example `extract`, `carve`, `classify` (read the SDK documentation for more details).

name - the name of the plugin, or in the classic sense, a description detailing the action(s) of the plugin. Note that the name can contain (forward) slashes.
example: "nfi.nl/extract/ocr/detection/plugin".
in this example nfi.nl is the domain, extract is the category, and ocr/detection/plugin is the name.

Method Details

domain

public String domain()

category

public String category()

name

public String name()

toString

public String toString()

Overrides:

toString in class Object