com.alipay.sofa.ark.spi.model

Interface Plugin

All Superinterfaces:

PriorityOrdered

public interface Plugin
extends PriorityOrdered

Ark Plugin Module Interface

Since:

0.1.0

Author:

qilong.zql

Field Summary

Fields inherited from interface com.alipay.sofa.ark.spi.service.PriorityOrdered

DEFAULT_PRECEDENCE, HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
String	getArtifactId() get Plugin ArtifactId
URL[]	getClassPath() get Plugin Class Path
Set<String>	getExportClasses() get plugin Export Classes
String	getExportMode() get Plugin Export Mode default exportMode = classLoader, means export class to load in this plugin classLoader exportMode = override, means export class to file only, and usually will be reload in another classLoader
Set<String>	getExportPackageNodes() get plugin export package which is exactly matched
Set<String>	getExportPackages() get Plugin Export Packages Config
Set<String>	getExportPackageStems() get plugin export package which is matched by prefix
Set<String>	getExportPrefixResourceStems() get plugin export resources matched by prefix
Set<String>	getExportResources() get Plugin Export Resources
Set<String>	getExportSuffixResourceStems() get plugin export resources matched by suffix
String	getGroupId() get Plugin GroupId
Set<String>	getImportClasses() get Plugin Import Classes
Set<String>	getImportPackageNodes() get plugin import package which is exactly matched
Set<String>	getImportPackages() get Plugin Import Packages Config
Set<String>	getImportPackageStems() get plugin import package which is matched by prefix
Set<String>	getImportPrefixResourceStems() get Plugin Import Resources matched by prefix
Set<String>	getImportResources() get Plugin Import Resources
Set<String>	getImportSuffixResourceStems() get Plugin Import Resources matched by suffix
String	getPluginActivator() get Plugin Activator
ClassLoader	getPluginClassLoader() get Plugin ClassLoader
PluginContext	getPluginContext() get Plugin Runtime Context
String	getPluginName() get Plugin Name
URL	getPluginURL() get Plugin Archive URL
int	getPriority() get Plugin Priority, mainly used in following 3 scenarios: 1.
String	getVersion() get Plugin Version
void	start() start Plugin
void	stop() stop Plugin

Method Detail

getPluginName

String getPluginName()

get Plugin Name

Returns:

plugin name

getGroupId

String getGroupId()

get Plugin GroupId

Returns:

plugin groupId

getArtifactId

String getArtifactId()

get Plugin ArtifactId

Returns:

plugin artifactId

getVersion

String getVersion()

get Plugin Version

Returns:

version

getPriority

int getPriority()

get Plugin Priority, mainly used in following 3 scenarios: 1. Plugin start up order 2. Plugin export class load priority 3. Plugin Service priority is higher as the number is smaller

Specified by:

getPriority in interface PriorityOrdered

Returns:

plugin priority

getPluginActivator

String getPluginActivator()

get Plugin Activator

Returns:

plugin activator

getClassPath

URL[] getClassPath()

get Plugin Class Path

Returns:

plugin class path

getPluginClassLoader

ClassLoader getPluginClassLoader()

get Plugin ClassLoader

Returns:

plugin classLoader

getPluginContext

PluginContext getPluginContext()

get Plugin Runtime Context

Returns:

plugin context

getExportMode

String getExportMode()

get Plugin Export Mode default exportMode = classLoader, means export class to load in this plugin classLoader exportMode = override, means export class to file only, and usually will be reload in another classLoader

Returns:

getExportPackages

Set<String> getExportPackages()

get Plugin Export Packages Config

Returns:

plugin export packages

getExportPackageNodes

Set<String> getExportPackageNodes()

get plugin export package which is exactly matched

Returns:

getExportPackageStems

Set<String> getExportPackageStems()

get plugin export package which is matched by prefix

Returns:

getExportClasses

Set<String> getExportClasses()

get plugin Export Classes

Returns:

plugin export classes

getImportPackages

Set<String> getImportPackages()

get Plugin Import Packages Config

Returns:

plugin import packages

getImportPackageNodes

Set<String> getImportPackageNodes()

get plugin import package which is exactly matched

Returns:

getImportPackageStems

Set<String> getImportPackageStems()

get plugin import package which is matched by prefix

Returns:

getImportClasses

Set<String> getImportClasses()

get Plugin Import Classes

Returns:

plugin import classes

getImportResources

Set<String> getImportResources()

get Plugin Import Resources

Returns:

plugin import resources

getImportPrefixResourceStems

Set<String> getImportPrefixResourceStems()

get Plugin Import Resources matched by prefix

Returns:

plugin Import Resources matched by prefix

getImportSuffixResourceStems

Set<String> getImportSuffixResourceStems()

get Plugin Import Resources matched by suffix

Returns:

plugin Import Resources matched by suffix

getExportResources

Set<String> getExportResources()

get Plugin Export Resources

Returns:

get plugin export resources

getExportPrefixResourceStems

Set<String> getExportPrefixResourceStems()

get plugin export resources matched by prefix

Returns:

plugin export resources matched by prefix

getExportSuffixResourceStems

Set<String> getExportSuffixResourceStems()

get plugin export resources matched by suffix

Returns:

get plugin export resources matched by suffix

getPluginURL

URL getPluginURL()

get Plugin Archive URL

Returns:

plugin archive url

start

void start()
    throws ArkRuntimeException

start Plugin

Throws:

ArkRuntimeException

stop

void stop()
   throws ArkRuntimeException

stop Plugin

Throws:

ArkRuntimeException