| /******************************************************************************* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| *******************************************************************************/ |
| |
| package org.ofbiz.minilang.method.callops; |
| |
| import java.util.ArrayList; |
| import java.util.Collections; |
| import java.util.List; |
| |
| import org.ofbiz.base.util.ObjectType; |
| import org.ofbiz.base.util.UtilXml; |
| import org.ofbiz.base.util.collections.FlexibleMapAccessor; |
| import org.ofbiz.minilang.MiniLangException; |
| import org.ofbiz.minilang.MiniLangUtil; |
| import org.ofbiz.minilang.MiniLangValidate; |
| import org.ofbiz.minilang.SimpleMethod; |
| import org.ofbiz.minilang.method.FieldObject; |
| import org.ofbiz.minilang.method.MethodContext; |
| import org.ofbiz.minilang.method.MethodObject; |
| import org.ofbiz.minilang.method.MethodOperation; |
| import org.ofbiz.minilang.method.StringObject; |
| import org.w3c.dom.Element; |
| |
| /** |
| * Implements the <call-class-method> element. |
| * |
| * @see <a href="https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{%3Ccallclassmethod%3E}}">Mini-language Reference</a> |
| */ |
| public final class CallClassMethod extends MethodOperation { |
| |
| public static final String module = CallClassMethod.class.getName(); |
| |
| private final String className; |
| private final Class<?> methodClass; |
| private final String methodName; |
| private final List<MethodObject<?>> parameters; |
| private final FlexibleMapAccessor<Object> retFieldFma; |
| |
| public CallClassMethod(Element element, SimpleMethod simpleMethod) throws MiniLangException { |
| super(element, simpleMethod); |
| if (MiniLangValidate.validationOn()) { |
| MiniLangValidate.handleError("<call-class-method> element is deprecated (use <script>)", simpleMethod, element); |
| MiniLangValidate.attributeNames(simpleMethod, element, "class-name", "method-name", "ret-field"); |
| MiniLangValidate.constantAttributes(simpleMethod, element, "class-name", "method-name"); |
| MiniLangValidate.requiredAttributes(simpleMethod, element, "class-name", "method-name"); |
| MiniLangValidate.childElements(simpleMethod, element, "string", "field"); |
| } |
| this.className = element.getAttribute("class-name"); |
| Class<?> methodClass = null; |
| try { |
| methodClass = ObjectType.loadClass(this.className); |
| } catch (ClassNotFoundException e) { |
| MiniLangValidate.handleError("Class not found with name " + this.className, simpleMethod, element); |
| } |
| this.methodClass = methodClass; |
| this.methodName = element.getAttribute("method-name"); |
| this.retFieldFma = FlexibleMapAccessor.getInstance(element.getAttribute("ret-field")); |
| List<? extends Element> parameterElements = UtilXml.childElementList(element); |
| if (parameterElements.size() > 0) { |
| ArrayList<MethodObject<?>> parameterList = new ArrayList<MethodObject<?>>(parameterElements.size()); |
| for (Element parameterElement : parameterElements) { |
| if ("string".equals(parameterElement.getNodeName())) { |
| parameterList.add(new StringObject(parameterElement, simpleMethod)); |
| } else if ("field".equals(parameterElement.getNodeName())) { |
| parameterList.add(new FieldObject<Object>(parameterElement, simpleMethod)); |
| } |
| } |
| parameterList.trimToSize(); |
| this.parameters = Collections.unmodifiableList(parameterList); |
| } else { |
| this.parameters = null; |
| } |
| } |
| |
| @Override |
| public boolean exec(MethodContext methodContext) throws MiniLangException { |
| MiniLangUtil.callMethod(this, methodContext, parameters, methodClass, null, methodName, retFieldFma); |
| return true; |
| } |
| |
| @Override |
| public String toString() { |
| StringBuilder sb = new StringBuilder("<call-class-method "); |
| if (!this.className.isEmpty()) { |
| sb.append("class-name=\"").append(this.className).append("\" "); |
| } |
| if (!this.methodName.isEmpty()) { |
| sb.append("method-name=\"").append(this.methodName).append("\" "); |
| } |
| if (!this.retFieldFma.isEmpty()) { |
| sb.append("ret-field=\"").append(this.retFieldFma).append("\" "); |
| } |
| sb.append("/>"); |
| return sb.toString(); |
| } |
| |
| /** |
| * A factory for the <call-class-method> element. |
| */ |
| public static final class CallClassMethodFactory implements Factory<CallClassMethod> { |
| @Override |
| public CallClassMethod createMethodOperation(Element element, SimpleMethod simpleMethod) throws MiniLangException { |
| return new CallClassMethod(element, simpleMethod); |
| } |
| |
| @Override |
| public String getName() { |
| return "call-class-method"; |
| } |
| } |
| } |