oracle.wsc.feature.webrtc.template

Interface TemplateContext

All Superinterfaces:

WscContext

public interface TemplateContext
extends WscContext

Template script context.

Method Summary

Modifier and Type	Method and Description
WscDiameterFactory	getDiameterFactory() Gets the diameter factory used for Diameter related message interaction.
WscMediaFactory	getMediaFactory() Gets the media factory used for Media related message interaction.
WscSipMessage	getOriginatingSipMessage() Gets any SIP message sent from the network.
WscProperties	getProperties() Get the properties from the current context.
RestClient	getRestClient() Gets the REST client for submitting outbound REST requests.
SdpExchangeStatus	getSdpExchangeStatus() Get SDP exchange status for current call.
Map<String,Object>	getSecurityContext() Gets the security context.
TemplateAttributeStore	getSessionStore() Gets the attribute store used to persist attributes associated with the current session.
WscSipFactory	getSipFactory() Gets the SIP factory used for SIP related message interaction.
javax.servlet.sip.SipSession.State	getSipSessionState() Gets the current SIP session state.
TemplateAttributeStore	getSubSessionStore() Gets the attribute store used to persist attributes associated with the current sub session.
Map<String,Object>	getTaskArgs() Gets the argument map associated with the current task.
TaskBuilder	getTaskBuilder(String functionName) Gets the task builder that supports creation of new tasks.
WscWebFactory	getWebFactory() Gets the WEB factory used for JSON related message interaction.
Map<String,Object>	getWebMessage() Gets any WEB message sent from the application.

Methods inherited from interface oracle.wsc.feature.webrtc.template.WscContext

getUniqueId

Method Detail

getProperties

WscProperties getProperties()

Get the properties from the current context. ex: In groovy it can be accesses as .properties.application.name. List of properties are: name, requestURI, packages

Returns:

current context object.

getSessionStore

TemplateAttributeStore getSessionStore()

Gets the attribute store used to persist attributes associated with the current session.

Returns:

Attribute store

getRestClient

RestClient getRestClient()

Gets the REST client for submitting outbound REST requests. Only asynchronous call outs are allowed in this context.

Returns:

RestClient instance.

getSipFactory

WscSipFactory getSipFactory()

Gets the SIP factory used for SIP related message interaction.

Returns:

SIP Factory

getWebFactory

WscWebFactory getWebFactory()

Gets the WEB factory used for JSON related message interaction.

Returns:

Web factory

getDiameterFactory

WscDiameterFactory getDiameterFactory()

Gets the diameter factory used for Diameter related message interaction.

Returns:

Diameter factory

getMediaFactory

WscMediaFactory getMediaFactory()

Gets the media factory used for Media related message interaction.

Returns:

Media factory

getWebMessage

Map<String,Object> getWebMessage()

Gets any WEB message sent from the application.

Returns:

Normalized data or null.

getOriginatingSipMessage

WscSipMessage getOriginatingSipMessage()

Gets any SIP message sent from the network.

Returns:

SIP message or null

getSecurityContext

Map<String,Object> getSecurityContext()

Gets the security context. Currently supported fields:

• "webId" - Web identity. Default is "anonymous".
• "publicId" - Public SIP identity, for example, "bob@example.com". Default is same as webId.
• "privateId" - Private SIP identity. Default is unset.
• "privatePassword" - Public SIP identity. Default is unset.
• "isAuthenticated" - If the user has been authenticated. Default is false.

Returns:

Security context map

getSubSessionStore

TemplateAttributeStore getSubSessionStore()

Gets the attribute store used to persist attributes associated with the current sub session.

Returns:

Attribute store

getSipSessionState

javax.servlet.sip.SipSession.State getSipSessionState()

Gets the current SIP session state.

Returns:

Sip session state

getTaskBuilder

TaskBuilder getTaskBuilder(String functionName)

Gets the task builder that supports creation of new tasks. The tasks will be executed at a later point in time when the future objects that the task depends on are ready, or when there is an error condition indicating the future objects won't be available.

Parameters:

functionName - The groovy function name to invoke while executing the future task

Returns:

Task builder

getTaskArgs

Map<String,Object> getTaskArgs()

Gets the argument map associated with the current task. Applicable only for future task execution, otherwise return null.

Returns:

Arguments for the task or null.

getSdpExchangeStatus

SdpExchangeStatus getSdpExchangeStatus()

Get SDP exchange status for current call. Note this status is valid for call package only.

Returns:

SDP exchange status