/*
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.jco3;
import java.lang.reflect.Field;
import java.util.Iterator;
import nl.nn.adapterframework.util.AppConstants;
import nl.nn.adapterframework.util.CredentialFactory;
import nl.nn.adapterframework.util.GlobalListItem;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.ReflectionToStringBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;
import com.sap.conn.idoc.IDocRepository;
import com.sap.conn.idoc.jco.JCoIDoc;
import com.sap.conn.jco.JCo;
import com.sap.conn.jco.JCoDestination;
import com.sap.conn.jco.JCoDestinationManager;
import com.sap.conn.jco.JCoException;
import com.sap.conn.jco.JCoRepository;
/**
* A SapSystem is a provider of repository information and connections to a SAP-system.
* <p><b>Configuration:</b>
* <table border="1">
* <tr><th>attributes</th><th>description</th><th>default</th></tr>
* <tr><td>{@link #setName(String) name}</td><td>name of the System. SAP-related Ibis objects refer to SapSystems by setting their SystemName-attribute to this value</td><td> </td></tr>
* <tr><td>{@link #setHost(String) host}</td><td>default value for ashost, gwhost and mshost (i.e. when ashost, gwhost and mshost are all the same, only host needs to be specified)</td><td> </td></tr>
* <tr><td>{@link #setAshost(String) ashost}</td><td>SAP application server</td><td> </td></tr>
* <tr><td>{@link #setSystemnr(String) systemnr}</td><td>SAP system nr</td><td>00</td></tr>
* <tr><td>{@link #setGroup(String) group}</td><td>Group of SAP application servers, when specified logon group will be used and r3name and mshost need to be specified instead of ashost</td><td> </td></tr>
* <tr><td>{@link #setR3name(String) r3name}</td><td>System ID of the SAP system</td><td> </td></tr>
* <tr><td>{@link #setMshost(String) mshost}</td><td>SAP message server</td><td> </td></tr>
* <tr><td>{@link #setMsservOffset(int) msservOffset}</td><td>number added to systemNr to find corresponding message server port</td><td>3600</td></tr>
* <tr><td>{@link #setGwhost(String) gwhost}</td><td>Gateway host</td><td> </td></tr>
* <tr><td>{@link #setGwservOffset(int) gwservOffset}</td><td>number added to systemNr to find corresponding gateway port</td><td>3300</td></tr>
* <tr><td>{@link #setMandant(String) mandant}</td><td>Mandant i.e. 'destination'</td><td>100</td></tr>
* <tr><td>{@link #setAuthAlias(String) authAlias}</td><td>alias to obtain userid and password</td><td> </td></tr>
* <tr><td>{@link #setUserid(String) userid}</td><td>userid used in the connection</td><td> </td></tr>
* <tr><td>{@link #setPasswd(String) passwd}</td><td>passwd used in the connection</td><td> </td></tr>
* <tr><td>{@link #setLanguage(String) language}</td><td>Language indicator</td><td>NL</td></tr>
* <tr><td>{@link #setUnicode(boolean) unicode}</td><td>when set <code>true</code> the SAP system is interpreted as Unicode SAP system, otherwise as non-Unicode (only applies to SapListeners, not to SapSenders)</td><td>false</td></tr>
* <tr><td>{@link #setMaxConnections(int) maxConnections}</td><td>maximum number of connections that may connect simultaneously to the SAP system</td><td>10</td></tr>
* <tr><td>{@link #setTraceLevel(int) traceLevel}</td><td>trace level (effective only when logging level is debug). 0=none, 10= maximum</td><td>0</td></tr>
* </table>
* </p>
* @author Gerrit van Brakel
* @author Jaco de Groot
* @since 5.0
*/
public class SapSystem extends GlobalListItem {
private String host;
private String ashost;
private String systemnr = "00";
private String group;
private String r3name;
private String mshost;
private int msservOffset = 3600;
private String gwhost;
private int gwservOffset = 3300;
private String mandant = "100";
private String authAlias= null;
private String userid = null;
private String passwd = null;
private String language = "NL";
private boolean unicode = false;
private int maxConnections = 10;
private int traceLevel = 0;
private int referenceCount=0;
/**
* Retrieve a SapSystem from the list of systems.
*/
public static SapSystem getSystem(String name) {
return (SapSystem)getItem(name);
}
private void clearSystem() {
SapSystemDataProvider.getInstance().unregisterSystem(this);
}
private void initSystem() throws SapException {
try {
SapSystemDataProvider.getInstance().registerSystem(this);
if (log.isDebugEnabled() && getTraceLevel()>0) {
String logPath=AppConstants.getInstance().getResolvedProperty("logging.path");
JCo.setTrace(getTraceLevel(), logPath);
}
} catch (Throwable t) {
throw new SapException(getLogPrefix()+"exception initializing", t);
}
}
public static void configureAll() {
for(Iterator it = getRegisteredNames(); it.hasNext();) {
String systemName=(String)it.next();
SapSystem system = getSystem(systemName);
system.configure();
}
}
public synchronized void openSystem() throws SapException {
if (referenceCount++<=0) {
referenceCount=1;
log.debug(getLogPrefix()+"opening system");
initSystem();
log.debug(getLogPrefix()+"opened system");
}
}
public synchronized void closeSystem() {
if (--referenceCount<=0) {
log.debug(getLogPrefix()+"reference count ["+referenceCount+"], closing system");
referenceCount=0;
clearSystem();
log.debug(getLogPrefix()+"closed system");
} else {
log.debug(getLogPrefix()+"reference count ["+referenceCount+"], waiting for other references to close");
}
}
public static void openSystems() throws SapException {
for(Iterator it = getRegisteredNames(); it.hasNext();) {
String systemName=(String)it.next();
SapSystem system = getSystem(systemName);
system.openSystem();
}
}
public static void closeSystems() {
for(Iterator it = getRegisteredNames(); it.hasNext();) {
String systemName=(String)it.next();
SapSystem system = getSystem(systemName);
system.closeSystem();
}
}
public JCoDestination getDestination() throws JCoException {
JCoDestination destination = JCoDestinationManager.getDestination(getName());
return destination;
}
public JCoRepository getJcoRepository() throws JCoException {
return getDestination().getRepository();
}
public synchronized IDocRepository getIDocRepository() throws JCoException {
return JCoIDoc.getIDocRepository(getDestination());
}
public String getLogPrefix() {
return "SapSystem ["+getName()+"] ";
}
public String toString() {
//return ToStringBuilder.reflectionToString(this);
return (new ReflectionToStringBuilder(this) {
protected boolean accept(Field f) {
return super.accept(f) && !f.getName().equals("passwd");
}
}).toString(); }
public void setHost(String host) {
this.host = host;
}
public void setAshost(String ashost) {
this.ashost = ashost;
}
public String getAshost() {
if (StringUtils.isEmpty(ashost)) {
return host;
} else {
return ashost;
}
}
public void setSystemnr(String string) {
systemnr = string;
}
public String getSystemnr() {
return systemnr;
}
public void setGroup(String group) {
this.group = group;
}
public String getGroup() {
return group;
}
public void setR3name(String r3name) {
this.r3name = r3name;
}
public String getR3name() {
return r3name;
}
public void setMshost(String mshost) {
this.mshost = mshost;
}
public String getMshost() {
if (StringUtils.isEmpty(mshost)) {
return host;
} else {
return mshost;
}
}
/**
* String value of sum of msservOffset and systemnr.
*/
public String getMsserv() {
return String.valueOf(getMsservOffset() + Integer.parseInt(getSystemnr()));
}
public int getMsservOffset() {
return msservOffset;
}
public void setMsservOffset(int i) {
msservOffset = i;
}
public void setGwhost(String string) {
gwhost = string;
}
public String getGwhost() {
if (StringUtils.isEmpty(gwhost)) {
return host;
} else {
return gwhost;
}
}
/**
* String value of sum of gwservOffset and systemnr.
*/
public String getGwserv() {
return String.valueOf(getGwservOffset() + Integer.parseInt(getSystemnr()));
}
public void setGwservOffset(int i) {
gwservOffset = i;
}
public int getGwservOffset() {
return gwservOffset;
}
public void setMandant(String string) {
mandant = string;
}
public String getMandant() {
return mandant;
}
public void setAuthAlias(String string) {
authAlias = string;
}
public String getAuthAlias() {
return authAlias;
}
public void setUserid(String string) {
userid = string;
}
public String getUserid() {
return userid;
}
public void setPasswd(String string) {
passwd = string;
}
public String getPasswd() {
return passwd;
}
public String getLanguage() {
return language;
}
public void setLanguage(String string) {
language = string;
}
public void setUnicode(boolean b) {
unicode = b;
}
public boolean isUnicode() {
return unicode;
}
public void setMaxConnections(int i) {
maxConnections = i;
}
public int getMaxConnections() {
return maxConnections;
}
public void setTraceLevel(int i) {
traceLevel = i;
}
public int getTraceLevel() {
return traceLevel;
}
}