01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19:
20: package org.apache.axis2.scripting.convertors;
21:
22: import org.apache.axiom.om.OMElement;
23: import org.apache.bsf.BSFEngine;
24:
25: /**
26: * The OMElementConvertor interface enables customizing the conversion of
27: * XML between Synapse and a script language. Some script languages have their
28: * own ways of using XML, such as E4X in JavaScript or REXML in Ruby. But BSF
29: * has no support for those so Synapse needs to handle this itself, which is what
30: * the OMElementConvertor does.
31: *
32: * Which OMElementConvertor type to use is discovered based on the file name suffix of
33: * the mediator script. The suffix is converted to uppercase and used as the prefix to
34: * the OMElementConvertor classname. For example, with a JavaScript script named myscript.js
35: * the .js suffix is taken to make the convertor class name
36: * "org.apache.synapse.mediators.bsf.convertors.JSOMElementConvertor"
37: * If the convertor class is not found then a default convertor is used which converts
38: * XML to a String representation.
39: */
40: public interface OMElementConvertor {
41:
42: public void setEngine(BSFEngine e);
43:
44: public Object toScript(OMElement omElement);
45:
46: public OMElement fromScript(Object o);
47:
48: }
|