com.canto.cumulus.ejp

Class AbstractEJP

java.lang.Object

com.canto.cumulus.ejp.AbstractEJP

All Implemented Interfaces:

EJP

Direct Known Subclasses:

AbstractGenericEJP

public abstract class AbstractEJP
extends java.lang.Object
implements EJP

Abstract base class for an EJP. You can use this class as a base class when implementing the EJP interface. The following methods are abstract because each EJP needs to provide its own implementation: - getName()

Since:

EJaP 6.0.0

Constructor Summary

Constructors

Constructor and Description
AbstractEJP()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Default implementation of the close() interface method.
java.lang.String	executeScriptingCommand(java.lang.String cmd) Execute a command that comes in through the scripting API of the Cumulus client.
java.lang.String	getID() Return a unique ID for this EJP instance.
abstract java.lang.String	getName() Return a user readable name for this plugin.
void	initialize(EJPContext context) Default implementation of the initialize() interface method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEJP

public AbstractEJP()

Method Detail

initialize

public void initialize(EJPContext context)

Default implementation of the initialize() interface method. It stores the context in a member variiabble "context".

Specified by:

initialize in interface EJP

Parameters:

context - the EJP context for this EJP instance.

close

public void close()

Default implementation of the close() interface method. This does nothing.

Specified by:

close in interface EJP

getID

public java.lang.String getID()

Return a unique ID for this EJP instance. This ID is generated at runtime so it is unknown and can not be referenced from other EJPs or from the Scripting API.

Specified by:

getID in interface EJP

Returns:

A unique ID.

getName

public abstract java.lang.String getName()

Description copied from interface: EJP

Return a user readable name for this plugin.

Specified by:

getName in interface EJP

Returns:

A user readable name for this plugin

executeScriptingCommand

public java.lang.String executeScriptingCommand(java.lang.String cmd)

Description copied from interface: EJP

Execute a command that comes in through the scripting API of the Cumulus client.

Specified by:

executeScriptingCommand in interface EJP

Parameters:

cmd - A command string. You can use any format for the information you want to pass. This can be null if the script did not provide a command.

Returns:

A return value (null if executing does not return a value)