com.neurosys.scribble

Class AdapterService<SCRIPT_OBJECT>

java.lang.Object

com.neurosys.scribble.AdapterService<SCRIPT_OBJECT>

Type Parameters:

SCRIPT_OBJECT - as the core Scripting Type Object; the implementation of this must ideally, also support the Adapter interface

Direct Known Subclasses:

GroovyAdapterService

public abstract class AdapterService<SCRIPT_OBJECT>
extends Object

Execute Scripting plugins

Author:

Arjun Dhar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdapterService.AdapterWrapper<SCRIPT_OBJECT>

Constructor Summary

Constructors

Constructor and Description
AdapterService()

Method Summary

Modifier and Type	Method and Description
Object	execute(String key, Object... args) Execute native scripts by given Adapter definition
abstract Object	executeMethod(String key, String methodName, Object... args) Execute Native script by default given method Name
boolean	flushAdapter(String key) Flush/Remove/Dispose the adapter instance
abstract AdapterService.AdapterWrapper	get(String key)
protected abstract AdapterService.AdapterWrapper	getAdapterWrapper(String resourceLocationName, org.springframework.scripting.ScriptSource scriptSource, org.springframework.core.io.Resource scriptResourceRef)
org.apache.commons.collections.Transformer	getAliasToPathTransformer() For a given key/alias return the actual path to the Resource.
abstract Collection<String>	getKeys()
Adapter	getRegisteredAdapter(String key) Get an Adapter from this service.
org.springframework.core.io.Resource	getResource(String scriptLocation) Resolve the script source for URL or Files.
AdapterService.AdapterWrapper	registerAdapter(String key, org.springframework.core.io.Resource resource) For a given Alias/Key register a Resource identified by its path aka resourceLocationName
AdapterService.AdapterWrapper	registerAdapter(String key, String resourceLocationName) For a given Alias/Key register a Resource identified by its path aka resourceLocationName
void	registerMultiple(Map<String,Object> resourceMap) If Adapters preset in #adapters Map then initialize all the Adapters automatically The map can have the path to the Reource or the Resource object itself.
List<String>	reload(Collection<String> keys)
String	reload(String keysStr) Reload Scripts by name (in a comma separated String list)
boolean	reloadAdapter(String key) Flush & Re-Load the adapter instance.
abstract void	remove(String key)
abstract AdapterService.AdapterWrapper	set(String key, AdapterService.AdapterWrapper adapter)
void	setAliasToPathTransformer(org.apache.commons.collections.Transformer aliasToPathTransformer) For a given key/alias return the actual path to the Resource.
void	verify(org.springframework.core.io.Resource resource) Allows to compile and check the script for compile time mistakes

Methods inherited from class java.lang.Object

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

Constructor Detail

AdapterService

public AdapterService()

Method Detail

getResource

public org.springframework.core.io.Resource getResource(String scriptLocation)
                                                 throws Exception

Resolve the script source for URL or Files.

Parameters:

scriptLocation -

Returns:

Throws:

Exception

get

public abstract AdapterService.AdapterWrapper get(String key)

set

public abstract AdapterService.AdapterWrapper set(String key,
                                                  AdapterService.AdapterWrapper adapter)

remove

public abstract void remove(String key)

getKeys

public abstract Collection<String> getKeys()

verify

public void verify(org.springframework.core.io.Resource resource)
            throws Exception

Allows to compile and check the script for compile time mistakes

Throws:

Exception

getAdapterWrapper

protected abstract AdapterService.AdapterWrapper getAdapterWrapper(String resourceLocationName,
                                                                   org.springframework.scripting.ScriptSource scriptSource,
                                                                   org.springframework.core.io.Resource scriptResourceRef)
                                                            throws Exception

Throws:

Exception

registerAdapter

public AdapterService.AdapterWrapper registerAdapter(String key,
                                                     String resourceLocationName)
                                              throws Exception

For a given Alias/Key register a Resource identified by its path aka resourceLocationName

Parameters:

key - as the Key Name to refer to the Adapter

resourceLocationName -

Returns:

AdapterService.AdapterWrapper

Throws:

Exception

registerAdapter

public AdapterService.AdapterWrapper registerAdapter(String key,
                                                     org.springframework.core.io.Resource resource)
                                              throws Exception

For a given Alias/Key register a Resource identified by its path aka resourceLocationName

Parameters:

key - as the Key Name to refer to the Adapter

resource - as Resource

Returns:

AdapterService.AdapterWrapper

Throws:

Exception

registerMultiple

public void registerMultiple(Map<String,Object> resourceMap)
                      throws Exception

If Adapters preset in #adapters Map then initialize all the Adapters automatically
The map can have the path to the Reource or the Resource object itself.

Throws:

Exception

flushAdapter

public boolean flushAdapter(String key)

Flush/Remove/Dispose the adapter instance

Parameters:

key - as the Key Name to refer to the Adapter

Returns:

boolean for status of operation

reloadAdapter

public boolean reloadAdapter(String key)

Flush & Re-Load the adapter instance. Note: While reloading if there is a problem; the key to the script will not be removed and be available for another try via reload.

Parameters:

key - as the Key Name to refer to the Adapter

Returns:

boolean for status of operation

getRegisteredAdapter

public Adapter getRegisteredAdapter(String key)
                             throws Exception

Get an Adapter from this service. If No adapter is defined for the key, then null will return.

If the Adapter is not registered (assuming it exists in the config), it will initialize the adapter on the call.

Parameters:

key - as adapter key id

Returns:

Adapter @nullable true

Throws:

Exception

executeMethod

public abstract Object executeMethod(String key,
                                     String methodName,
                                     Object... args)
                              throws Exception

Execute Native script by default given method Name

Parameters:

key - to derive Script Object

methodName - as String

args - as Object[]

Returns:

Object

Throws:

Exception

execute

public Object execute(String key,
                      Object... args)
               throws Exception

Execute native scripts by given Adapter definition

Parameters:

key -

methodName - as String

args - as Object[]

Returns:

Object

Throws:

Exception

getAliasToPathTransformer

public org.apache.commons.collections.Transformer getAliasToPathTransformer()

For a given key/alias return the actual path to the Resource. This is basically a resolver that can resolve a name to a path from a file, memory or persistence.

See Also:

DefaultAliasToPathTransformer

setAliasToPathTransformer

public void setAliasToPathTransformer(org.apache.commons.collections.Transformer aliasToPathTransformer)

For a given key/alias return the actual path to the Resource. This is basically a resolver that can resolve a name to a path from a file, memory or persistence.

See Also:

DefaultAliasToPathTransformer

reload

public String reload(String keysStr)
              throws Exception

Reload Scripts by name (in a comma separated String list)

Parameters:

keysStr - as String (comma separated)

Returns:

String as comma separated list of scripts loaded

Throws:

Exception

reload

public List<String> reload(Collection<String> keys)
                    throws Exception

Parameters:

keys - as Collection of script names

Returns:

List of scripts that are reloaded

Throws:

Exception