org.restcomm.connect.rvd.interpreter

Class Interpreter

java.lang.Object

org.restcomm.connect.rvd.interpreter.Interpreter

public class Interpreter
extends Object

Constructor Summary

Constructors

Constructor and Description
Interpreter(ProjectAwareRvdContext rvdContext, String targetParam, String appName, javax.servlet.http.HttpServletRequest httpRequest, javax.ws.rs.core.MultivaluedMap<String,String> requestParams, WorkspaceStorage workspaceStorage, ApplicationContext applicationContext)

Method Summary

Methods

Modifier and Type	Method and Description
String	buildAction(Map<String,String> pairs)
void	clearModuleVariables() When switching from one module to the next clears module-scoped variables.
String	convertRecordingFileResourceHttp(String fileResource, javax.servlet.http.HttpServletRequest request) Converts a file resource to a recorded wav file into an http resource accessible over HTTP.
String	evaluateExtractorExpression(ValueExtractor extractor, com.google.gson.JsonElement response_element)
ApplicationContext	getApplicationContext()
String	getAppName()
String	getContextPath()
javax.servlet.http.HttpServletRequest	getHttpRequest()
String	getNodeNameByLabel(String label)
ProjectLogger	getProjectLogger()
javax.ws.rs.core.MultivaluedMap<String,String>	getRequestParams()
ProjectAwareRvdContext	getRvdContext()
RvdConfiguration	getRvdSettings()
Target	getTarget()
Map<String,String>	getVariables()
String	interpret()
String	interpret(String targetParam, RcmlResponse rcmlModel, Step prependStep, Target originTarget)
String	moduleUrl(String moduleName) Build a relative url to the named module
static String	nameModuleRequestParam(String name)
static String	nameStickyRequestParam(String name)
static Target	parseTarget(String targetParam)
String	populateVariables(String sourceText) Processes a block of text typically used for ing that may contain variable expressions.
void	putModuleVariable(String name, String value)
void	putStickyVariable(String name, String value) Make 'local copies' of sticky_* parameters passed in the URL.
void	putVariable(String name, String value)
static String	rcmlOnException()
void	setAppName(String appName)
void	setContextPath(String contextPath)
void	setProjectLogger(ProjectLogger projectLogger)
void	setRvdSettings(RvdConfiguration rvdSettings)
void	setTarget(Target target)
void	setVariables(Map<String,String> variables)

Methods inherited from class java.lang.Object

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

Constructor Detail

Interpreter

public Interpreter(ProjectAwareRvdContext rvdContext,
           String targetParam,
           String appName,
           javax.servlet.http.HttpServletRequest httpRequest,
           javax.ws.rs.core.MultivaluedMap<String,String> requestParams,
           WorkspaceStorage workspaceStorage,
           ApplicationContext applicationContext)

Method Detail

getProjectLogger

public ProjectLogger getProjectLogger()

getRvdContext

public ProjectAwareRvdContext getRvdContext()

setProjectLogger

public void setProjectLogger(ProjectLogger projectLogger)

setRvdSettings

public void setRvdSettings(RvdConfiguration rvdSettings)

rcmlOnException

public static String rcmlOnException()

getRvdSettings

public RvdConfiguration getRvdSettings()

getAppName

public String getAppName()

getApplicationContext

public ApplicationContext getApplicationContext()

setAppName

public void setAppName(String appName)

getHttpRequest

public javax.servlet.http.HttpServletRequest getHttpRequest()

getVariables

public Map<String,String> getVariables()

setVariables

public void setVariables(Map<String,String> variables)

getTarget

public Target getTarget()

setTarget

public void setTarget(Target target)

interpret

public String interpret()
                 throws RvdException

Throws:

RvdException

getRequestParams

public javax.ws.rs.core.MultivaluedMap<String,String> getRequestParams()

getContextPath

public String getContextPath()

setContextPath

public void setContextPath(String contextPath)

interpret

public String interpret(String targetParam,
               RcmlResponse rcmlModel,
               Step prependStep,
               Target originTarget)
                 throws InterpreterException,
                        StorageException

Throws:

InterpreterException

StorageException

evaluateExtractorExpression

public String evaluateExtractorExpression(ValueExtractor extractor,
                                 com.google.gson.JsonElement response_element)
                                   throws InvalidAccessOperationAction,
                                          BadExternalServiceResponse

Throws:

InvalidAccessOperationAction

BadExternalServiceResponse

populateVariables

public String populateVariables(String sourceText)

Processes a block of text typically used for ing that may contain variable expressions. Replaces variable expressions with their corresponding values from interpreter's variables map

buildAction

public String buildAction(Map<String,String> pairs)

parseTarget

public static Target parseTarget(String targetParam)

getNodeNameByLabel

public String getNodeNameByLabel(String label)

Parameters:

label -

Returns:

The 'name' of the first node with the specified label. If not found returns null

moduleUrl

public String moduleUrl(String moduleName)

Build a relative url to the named module

Parameters:

moduleName -

Returns:

the url or null if the module does not exist

convertRecordingFileResourceHttp

public String convertRecordingFileResourceHttp(String fileResource,
                                      javax.servlet.http.HttpServletRequest request)
                                        throws URISyntaxException

Converts a file resource to a recorded wav file into an http resource accessible over HTTP. The path generated path for the wav files is hardcoded to /restcomm/recordings

Parameters:

fileResource -

Returns:

Throws:

URISyntaxException

putStickyVariable

public void putStickyVariable(String name,
                     String value)

Make 'local copies' of sticky_* parameters passed in the URL. Propagate existing sticky variables by putting them in the variables array. Whoever creates an action link from now on should take them into account also make a local copy of them without the sticky_ prefix so that they can be accessed as ordinary module variables

nameStickyRequestParam

public static String nameStickyRequestParam(String name)

nameModuleRequestParam

public static String nameModuleRequestParam(String name)

putModuleVariable

public void putModuleVariable(String name,
                     String value)

putVariable

public void putVariable(String name,
               String value)

clearModuleVariables

public void clearModuleVariables()

When switching from one module to the next clears module-scoped variables.