Package com.morpheusdata.core.providers

Interface ActionProvider

All Superinterfaces:

PluginProvider

public interface ActionProvider
extends PluginProvider

Provides support for defining custom actions on objects

Since:

1.5.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.morpheusdata.core.providers.PluginProvider

PluginProvider.ConfigurationDriftCheckFacet<T>, PluginProvider.EventSubscriberFacet<E extends Event>, PluginProvider.UpdateFacet<T>

Method Summary

Modifier and Type	Method	Description
String	getKey()	The identifier used to access the action.
default String	getNamespace()	Datasets namespacing prevents key collision between action and provides a way to group similar or associated action.
ActionInfo.ActionState	getState(ActionRequest request)
ServiceResponse<HashMap<String,Object>>	prepare(ActionRequest request)
ServiceResponse<ActionResponse>	runAction(ActionRequest request)

Methods inherited from interface com.morpheusdata.core.providers.PluginProvider

getCode, getMorpheus, getName, getPlugin

Method Details

getKey

String getKey()

The identifier used to access the action.

Returns:

the key identifier used to access the action

getNamespace

default String getNamespace()

Datasets namespacing prevents key collision between action and provides a way to group similar or associated action. A null namespace is for the global namespace

Returns:

the action namespace

getState

ActionInfo.ActionState getState(ActionRequest request)

runAction

ServiceResponse<ActionResponse> runAction(ActionRequest request)

prepare

ServiceResponse<HashMap<String,Object>> prepare(ActionRequest request)