org.apache.synapse.mediators

Class GetPropertyFunction

java.lang.Object

org.apache.synapse.mediators.GetPropertyFunction

All Implemented Interfaces:

org.jaxen.Function

public class GetPropertyFunction
extends Object
implements org.jaxen.Function

Implements the XPath extension function synapse:get-property(scope,prop-name)

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_STRING

Constructor Summary

Constructors

Constructor and Description
GetPropertyFunction(MessageContext synCtx)

Method Summary

Modifier and Type	Method and Description
Object	call(org.jaxen.Context context, List args) Returns the string value of the property which is get from the corresponding context to the provided scope .
Object	evaluate(Object scopeObject, Object keyObject, Object dateformat, org.jaxen.Navigator navigator) Returns the string value of the property using arg one as key and arg two as scope
MessageContext	getSynCtx()

Methods inherited from class java.lang.Object

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

Field Detail

NULL_STRING

public static final String NULL_STRING

See Also:

Constant Field Values

Constructor Detail

GetPropertyFunction

public GetPropertyFunction(MessageContext synCtx)

Method Detail

getSynCtx

public MessageContext getSynCtx()

call

public Object call(org.jaxen.Context context,
                   List args)
            throws org.jaxen.FunctionCallException

Returns the string value of the property which is get from the corresponding context to the provided scope . The default scope is used to get property from the synapse message context

Specified by:

call in interface org.jaxen.Function

Parameters:

context - the context at the point in the expression when the function is called

args - arguments of the functions

Returns:

The string value of a property

Throws:

org.jaxen.FunctionCallException

evaluate

public Object evaluate(Object scopeObject,
                       Object keyObject,
                       Object dateformat,
                       org.jaxen.Navigator navigator)

Returns the string value of the property using arg one as key and arg two as scope

Parameters:

scopeObject - scope will decide from where property will be picked up from i.e. axis2, transport, default/synapse

keyObject - the key of the property

navigator - object model which can be used for navigation around

dateformat - The dateformat that need to convert

Returns:

The String value of property using arg one as key and arg two as scope