/*
Copyright 2013 Nationale-Nederlanden
Licensed 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 nl.nn.adapterframework.extensions.sap.jco2;
import nl.nn.adapterframework.configuration.ConfigurationException;
import nl.nn.adapterframework.core.SenderException;
import nl.nn.adapterframework.core.TimeOutException;
import nl.nn.adapterframework.parameters.ParameterResolutionContext;
import nl.nn.adapterframework.parameters.ParameterValue;
import nl.nn.adapterframework.parameters.ParameterValueList;
import org.apache.commons.lang.StringUtils;
import com.sap.mw.jco.JCO;
/**
* Implementation of {@link nl.nn.adapterframework.core.ISender sender} that calls a SAP RFC-function.
* <p><b>Configuration:</b>
* <table border="1">
* <tr><th>attributes</th><th>description</th><th>default</th></tr>
* <tr><td>className</td><td>nl.nn.adapterframework.extensions.sap.SapSender</td><td> </td></tr>
* <tr><td>{@link #setName(String) name}</td><td>name of the Sender</td><td> </td></tr>
* <tr><td>{@link #setSapSystemName(String) sapSystemName}</td><td>name of the {@link SapSystem} used by this object</td><td> </td></tr>
* <tr><td>{@link #setSapSystemNameParam(String) sapSystemNameParam}</td><td>name of the parameter used to indicate the name of the {@link SapSystem} used by this object if the attribute <code>sapSystemName</code> is empty</td><td>sapSystemName</td></tr>
* <tr><td>{@link #setFunctionName(String) functionName}</td><td>Name of the RFC-function to be called in the SAP system</td><td> </td></tr>
* <tr><td>{@link #setFunctionNameParam(String) functionNameParam}</td><td>name of the parameter used to obtain the functionName from if the attribute <code>functionName</code> is empty</td><td>functionName</td></tr>
* <tr><td>{@link #setSynchronous(boolean) synchronous}</td><td>when <code>false</code>, the sender operates in RR mode: the a reply is expected from SAP, and the sender does not participate in a transaction. When <code>false</code>, the sender operates in FF mode: no reply is expected from SAP, and the sender joins the transaction, that must be present. The SAP transaction is committed right after the XA transaction is completed.</td><td>true</td></tr>
* <tr><td>{@link #setLuwHandleSessionKey(String) luwHandleSessionKey}</td><td>session key in which LUW information is stored. When set, actions that share a {@link SapLUWHandle LUW-handle} will be executed using the same client. Can only be used for synchronous functions</td><td> </td></tr>
* <tr><td>{@link #setCorrelationIdFieldIndex(int) correlationIdFieldIndex}</td><td>Index of the field in the ImportParameterList of the RFC function that contains the correlationId</td><td>0</td></tr>
* <tr><td>{@link #setCorrelationIdFieldName(String) correlationIdFieldName}</td><td>Name of the field in the ImportParameterList of the RFC function that contains the correlationId</td><td> </td></tr>
* <tr><td>{@link #setRequestFieldIndex(int) requestFieldIndex}</td><td>Index of the field in the ImportParameterList of the RFC function that contains the whole request message contents</td><td>0</td></tr>
* <tr><td>{@link #setRequestFieldName(String) requestFieldName}</td><td>Name of the field in the ImportParameterList of the RFC function that contains the whole request message contents</td><td> </td></tr>
* <tr><td>{@link #setReplyFieldIndex(int) replyFieldIndex}</td><td>Index of the field in the ExportParameterList of the RFC function that contains the whole reply message contents</td><td>0</td></tr>
* <tr><td>{@link #setReplyFieldName(String) replyFieldName}</td><td>Name of the field in the ExportParameterList of the RFC function that contains the whole reply message contents</td><td> </td></tr>
* </table>
* </p>
* <table border="1">
* <p><b>Parameters:</b>
* <tr><th>name</th><th>type</th><th>remarks</th></tr>
* <tr><td>sapSystemName</td><td>String</td><td>points to {@link SapSystem} to use; required when attribute <code>sapSystemName</code> is empty</td></tr>
* <tr><td>functionName</td><td>String</td><td>defines functionName; required when attribute <code>functionName</code> is empty</td></tr>
* <tr><td><i>inputfieldname</i></td><td><i>any</i></td><td>The value of the parameter is set to the (simple) input field</td></tr>
* <tr><td><i>structurename</i>/<i>inputfieldname</i></td><td><i>any</i></td><td>The value of the parameter is set to the named field of the named structure</td></tr>
* </table>
* </p>
* N.B. If no requestFieldIndex or requestFieldName is specified, input is converted from xml;
* If no replyFieldIndex or replyFieldName is specified, output is converted to xml.
* </p>
* @author Gerrit van Brakel
* @since 4.2
*/
public class SapSender extends SapSenderBase {
private String functionName=null;
private String functionNameParam="functionName";
public SapSender() {
super();
setSynchronous(true);
}
public void configure() throws ConfigurationException {
super.configure();
if (StringUtils.isEmpty(getFunctionName())) {
if (StringUtils.isEmpty(getFunctionNameParam())) {
throw new ConfigurationException(getLogPrefix()+"if attribute functionName is not specified, value of attribute functionNameParam must indicate parameter to obtain functionName from");
}
if (paramList==null || paramList.findParameter(getFunctionNameParam())==null) {
throw new ConfigurationException(getLogPrefix()+"functionName must be specified, either in attribute functionName, or via parameter ["+getFunctionNameParam()+"]");
}
} else {
if (StringUtils.isNotEmpty(getFunctionNameParam()) && paramList!=null && paramList.findParameter(getFunctionNameParam())!=null) {
throw new ConfigurationException(getLogPrefix()+"functionName cannot be specified both in attribute functionName ["+getFunctionName()+"] and via parameter ["+getFunctionNameParam()+"]");
}
}
}
public void open() throws SenderException {
super.open();
}
public void close() {
super.close();
}
public JCO.Function getFunction(SapSystem sapSystem, ParameterValueList pvl) throws SapException {
if (StringUtils.isNotEmpty(getSapSystemName()) && StringUtils.isNotEmpty(getFunctionName())) {
return getFunctionTemplate().getFunction();
}
String functionName=getFunctionName();
if (StringUtils.isEmpty(functionName)) {
if (pvl==null) {
throw new SapException("no parameters to determine functionName from");
}
ParameterValue pv = pvl.getParameterValue(getFunctionNameParam());
if (pv==null) {
throw new SapException("could not get ParameterValue for parameter ["+getFunctionNameParam()+"]");
}
functionName = pv.asStringValue(null);
}
if (StringUtils.isEmpty(functionName)) {
throw new SapException("could not determine functionName using parameter ["+getFunctionNameParam()+"]");
}
return getFunctionTemplate(sapSystem, functionName).getFunction();
}
public String sendMessage(String correlationID, String message, ParameterResolutionContext prc) throws SenderException, TimeOutException {
String tid=null;
try {
ParameterValueList pvl = null;
if (prc!=null) {
pvl=prc.getValues(paramList);
}
SapSystem sapSystem = getSystem(pvl);
JCO.Function function=getFunction(sapSystem, pvl);
if (StringUtils.isEmpty(getSapSystemName())) {
pvl.removeParameterValue(getSapSystemNameParam());
}
if (StringUtils.isEmpty(getFunctionName())) {
pvl.removeParameterValue(getFunctionNameParam());
}
message2FunctionCall(function, message, correlationID, pvl);
if (log.isDebugEnabled()) log.debug(getLogPrefix()+" function call ["+functionCall2message(function)+"]");
JCO.Client client = getClient(prc.getSession(), sapSystem);
try {
tid = getTid(client,sapSystem);
if (StringUtils.isEmpty(tid)) {
client.execute(function);
} else {
client.execute(function,tid);
}
} finally {
releaseClient(client,sapSystem);
}
if (isSynchronous()) {
return functionResult2message(function);
} else {
return tid;
}
} catch (Exception e) {
throw new SenderException(e);
}
}
public void setSynchronous(boolean b) {
super.setSynchronous(b);
}
public String getFunctionName() {
return functionName;
}
public void setFunctionName(String string) {
functionName = string;
}
public void setFunctionNameParam(String string) {
functionNameParam = string;
}
public String getFunctionNameParam() {
return functionNameParam;
}
}