[TOC]

org.apache.nutch.plugin

Class Extension

public class Extension
extends Object

An Extension is a kind of listener descriptor that will be installed on a concrete ExtensionPoint that acts as kind of Publisher.

Constructor Summary

Constructors Constructor and Description Extension(PluginDescriptor pDescriptor, String pExtensionPoint, String pId, String pExtensionClass, org.apache.hadoop.conf.Configuration conf, PluginRepository pluginRepository)

Method Summary

Methods Modifier and Type Method and Description void addAttribute(String pKey, String pValue) Adds a attribute and is only used until model creation at plugin system start up. String getAttribute(String pKey) Returns a attribute value, that is setuped in the manifest file and is definied by the extension point xml schema. String getClazz() Returns the full class name of the extension point implementation PluginDescriptor getDescriptor() return the plugin descriptor. Object getExtensionInstance() Return an instance of the extension implementatio. String getId() Return the unique id of the extension. String getTargetPoint() Returns the Id of the extension point, that is implemented by this extension. void setClazz(String extensionClazz) Sets the Class that implement the concret extension and is only used until model creation at system start up. void setDescriptor(PluginDescriptor pDescriptor) Sets the plugin descriptor and is only used until model creation at system start up. void setId(String extensionID) Sets the unique extension Id and is only used until model creation at system start up.

-

Methods inherited from class java.lang.Object

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

Constructor Detail

-

Extension

public Extension(PluginDescriptor pDescriptor,
         String pExtensionPoint,
         String pId,
         String pExtensionClass,
         org.apache.hadoop.conf.Configuration conf,
         PluginRepository pluginRepository)
  - Parameters:
  - <code>pDescriptor</code> - a plugin descriptor
  - <code>pExtensionPoint</code> - an extension porin
  - <code>pId</code> - an unique id of the plugin

Method Detail

-

getAttribute

public String getAttribute(String pKey)

Returns a attribute value, that is setuped in the manifest file and is definied by the extension point xml schema.

  - Parameters:
  - <code>pKey</code> - a key 
  - Returns:
  - String a value       
-

getClazz

public String getClazz()

Returns the full class name of the extension point implementation

  - Returns:
  - String       
-

getId

public String getId()

Return the unique id of the extension.

  - Returns:
  - String       
-

addAttribute

public void addAttribute(String pKey,
                String pValue)

Adds a attribute and is only used until model creation at plugin system start up.

  - Parameters:
  - <code>pKey</code> - a key
  - <code>pValue</code> - a value       
-

setClazz

public void setClazz(String extensionClazz)

Sets the Class that implement the concret extension and is only used until model creation at system start up.

  - Parameters:
  - <code>extensionClazz</code> - The extensionClasname to set       
-

setId

public void setId(String extensionID)

Sets the unique extension Id and is only used until model creation at system start up.

  - Parameters:
  - <code>extensionID</code> - The extensionID to set       
-

getTargetPoint

public String getTargetPoint()

Returns the Id of the extension point, that is implemented by this extension.

-

getExtensionInstance

public Object getExtensionInstance()
                            throws PluginRuntimeException

Return an instance of the extension implementatio. Before we create a extension instance we startup the plugin if it is not already done. The plugin instance and the extension instance use the same PluginClassLoader. Each Plugin use its own classloader. The PluginClassLoader knows only own Plugin runtime libraries setuped in the plugin manifest file and exported libraries of the depenedend plugins.

  - Returns:
  - Object An instance of the extension implementation 
  - Throws: 
  - <code>PluginRuntimeException</code>       
-

getDescriptor

public PluginDescriptor getDescriptor()

return the plugin descriptor.

  - Returns:
  - PluginDescriptor       
-

setDescriptor

public void setDescriptor(PluginDescriptor pDescriptor)

Sets the plugin descriptor and is only used until model creation at system start up.

  - Parameters:
  - <code>pDescriptor</code> -

Copyright © 2014 The Apache Software Foundation