com.salesforce.cantor.functions

Interface Functions

All Known Implementing Classes:

FunctionsOnCantor

public interface Functions

Functions allow users to store/retrieve and execute a function in this sandbox.

Method Summary

Modifier and Type	Method and Description
void	create(String namespace) Create a new function namespace.
void	delete(String namespace, String function) Delete the function from the given namespace.
void	drop(String namespace) Drop a function namespace.
byte[]	get(String namespace, String function) Retrieve the function body from the given namespace.
Collection<String>	list(String namespace) Get the list of all functions in the given namespace.
void	run(String namespace, String function, Context context, Map<String,String> params) Execute the function, given the context and param arguments.
void	store(String namespace, String function, byte[] body) Store a function with the given name and body as byte array.
default void	store(String namespace, String function, String body) Store a function with the given name and body as string.

Method Detail

create

void create(String namespace)
     throws IOException

Create a new function namespace.

Parameters:

namespace - the namespace identifier

Throws:

IOException - exception thrown from the underlying storage implementation

drop

void drop(String namespace)
   throws IOException

Drop a function namespace.

Parameters:

namespace - the namespace identifier

Throws:

IOException - exception thrown from the underlying storage implementation

store

default void store(String namespace,
                   String function,
                   String body)
            throws IOException

Store a function with the given name and body as string.

Parameters:

namespace - the namespace identifier

function - the function name identifier

body - body of the function

Throws:

IOException - exception thrown from the underlying storage implementation

store

void store(String namespace,
           String function,
           byte[] body)
    throws IOException

Store a function with the given name and body as byte array.

Parameters:

namespace - the namespace identifier

function - the function name identifier

body - body of the function

Throws:

IOException - exception thrown from the underlying storage implementation

get

byte[] get(String namespace,
           String function)
    throws IOException

Retrieve the function body from the given namespace.

Parameters:

namespace - the namespace identifier

function - the function name identifier

Returns:

byte array representation of the body of the function; null if not found

Throws:

IOException - exception thrown from the underlying storage implementation

delete

void delete(String namespace,
            String function)
     throws IOException

Delete the function from the given namespace.

Parameters:

namespace - the namespace identifier

function - the function name identifier

Throws:

IOException - exception thrown from the underlying storage implementation

list

Collection<String> list(String namespace)
                 throws IOException

Get the list of all functions in the given namespace.

Parameters:

namespace - the namespace identifier

Throws:

IOException - exception thrown from the underlying storage implementation

run

void run(String namespace,
         String function,
         Context context,
         Map<String,String> params)
  throws IOException

Execute the function, given the context and param arguments.

Parameters:

namespace - the namespace identifier

function - the function name identifier

context - the context variables to pass to function on execution

params - the map of parameters to pass to function on execution

Throws:

IOException - exception thrown from the underlying storage implementation