├── src
├── dist
│ ├── log
│ │ └── q2.log
│ ├── bin
│ │ ├── start
│ │ ├── stop
│ │ ├── bsh
│ │ ├── q2
│ │ └── q2.bat
│ └── deploy
│ │ ├── 62_clientmux.xml
│ │ ├── 99_sysmon.xml
│ │ ├── 60_clientws.xml
│ │ ├── 61_clientchannel.xml
│ │ ├── 40_server.xml
│ │ ├── 30_processors.xml
│ │ └── 00_logger.xml
└── main
│ └── java
│ └── middleware
│ ├── ProxyMBean.java
│ ├── MessageProcessor.java
│ ├── webservice
│ ├── WebserviceInterface.java
│ ├── ISOMessageContent.java
│ └── Webservice.java
│ ├── Server.java
│ └── Proxy.java
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── .gitignore
├── COPYRIGHT
├── README.md
├── gradlew.bat
├── .classpath
├── gradlew
├── jpos-app.gradle
└── LICENSE
/src/dist/log/q2.log:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/src/dist/bin/start:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | cd `dirname $0`
4 | echo Starting Q2
5 | nohup ./q2 > /dev/null 2>&1 &
6 |
--------------------------------------------------------------------------------
/src/dist/bin/stop:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | echo Stopping Q2
4 | echo '' > `dirname $0`/../deploy/shutdown.xml
5 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/bedefaced/jpos-example/HEAD/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.swp
2 | *.iml
3 | *.ipr
4 | *.iws
5 | .idea
6 | .settings
7 | .project
8 | .gradle
9 | build
10 | man
11 |
12 | /bin/
13 |
--------------------------------------------------------------------------------
/src/main/java/middleware/ProxyMBean.java:
--------------------------------------------------------------------------------
1 | package middleware;
2 |
3 | import org.jpos.q2.QBean;
4 |
5 | public interface ProxyMBean extends QBean {
6 | }
7 |
--------------------------------------------------------------------------------
/src/main/java/middleware/MessageProcessor.java:
--------------------------------------------------------------------------------
1 | package middleware;
2 |
3 | import org.jpos.iso.ISOMsg;
4 |
5 | public interface MessageProcessor {
6 | public ISOMsg process(ISOMsg message);
7 | }
8 |
--------------------------------------------------------------------------------
/src/dist/bin/bsh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | cd `dirname $0`/.. || exit 1
3 | CLASSPATH=classes:$CLASSPATH
4 | CLASSPATH=`echo @jarname@ lib/*.jar | tr ' ' ':'`:$CLASSPATH
5 | exec java -cp $CLASSPATH bsh.Interpreter $*
6 |
--------------------------------------------------------------------------------
/src/dist/deploy/62_clientmux.xml:
--------------------------------------------------------------------------------
1 |
2 | clientchannel-out
3 | clientmux-out
4 | clientchannel.ready
5 |
--------------------------------------------------------------------------------
/src/dist/bin/q2:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | cd `dirname $0`/.. || exit 1
4 | rm -f deploy/shutdown.xml
5 | java -server \
6 | -Xmx1G \
7 | -Dcom.sun.management.jmxremote \
8 | -jar @jarname@ "$@"
9 |
10 |
--------------------------------------------------------------------------------
/src/dist/deploy/99_sysmon.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 3600000
4 | true
5 |
6 |
7 |
--------------------------------------------------------------------------------
/src/dist/deploy/60_clientws.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Mon Dec 02 21:11:51 UYST 2013
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | distributionUrl=http\://services.gradle.org/distributions/gradle-1.9-bin.zip
7 |
--------------------------------------------------------------------------------
/src/main/java/middleware/webservice/WebserviceInterface.java:
--------------------------------------------------------------------------------
1 | package middleware.webservice;
2 |
3 | import javax.jws.WebMethod;
4 | import javax.jws.WebService;
5 |
6 | @WebService
7 | public interface WebserviceInterface {
8 |
9 | @WebMethod
10 | ISOMessageContent send(ISOMessageContent message) throws Exception;
11 |
12 | }
13 |
--------------------------------------------------------------------------------
/src/dist/deploy/61_clientchannel.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 | clientmux-out
8 | clientchannel-out
9 | 5000
10 |
--------------------------------------------------------------------------------
/src/dist/deploy/40_server.xml:
--------------------------------------------------------------------------------
1 |
2 | 1121
3 |
5 |
9 |
10 |
11 |
12 | serverchannel-in
13 | serverchannel-out
14 |
--------------------------------------------------------------------------------
/src/main/java/middleware/webservice/ISOMessageContent.java:
--------------------------------------------------------------------------------
1 | package middleware.webservice;
2 |
3 | import java.util.HashMap;
4 |
5 | public class ISOMessageContent {
6 |
7 | String MTI;
8 | String ISOHeader;
9 | HashMap fields = new HashMap();
10 |
11 | public String getMTI() {
12 | return MTI;
13 | }
14 |
15 | public void setMTI(String mTI) {
16 | MTI = mTI;
17 | }
18 |
19 | public String getISOHeader() {
20 | return ISOHeader;
21 | }
22 |
23 | public void setISOHeader(String iSOHeader) {
24 | ISOHeader = iSOHeader;
25 | }
26 |
27 | public HashMap getFields() {
28 | return fields;
29 | }
30 |
31 | public void setFields(HashMap fields) {
32 | this.fields = fields;
33 | }
34 |
35 | }
36 |
--------------------------------------------------------------------------------
/COPYRIGHT:
--------------------------------------------------------------------------------
1 | /*
2 | * jPOS Project [http://jpos.org]
3 | * Copyright (C) 2000-2013 Alejandro P. Revilla d/b/a jPOS Consulting
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU Affero General Public License as
7 | * published by the Free Software Foundation, either version 3 of the
8 | * License, or (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU Affero General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU Affero General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 |
--------------------------------------------------------------------------------
/src/main/java/middleware/Server.java:
--------------------------------------------------------------------------------
1 | package middleware;
2 |
3 | import org.jpos.iso.ISOMsg;
4 | import org.jpos.iso.ISORequestListener;
5 | import org.jpos.iso.ISOSource;
6 | import org.jpos.util.NameRegistrar;
7 |
8 | public class Server implements ISORequestListener {
9 |
10 | @Override
11 | public boolean process(ISOSource source, ISOMsg message) {
12 | try {
13 | ISOMsg isoMessageResponse = (ISOMsg) message.clone();
14 | isoMessageResponse.setResponseMTI(); // default response
15 |
16 | MessageProcessor serverprocessor = (MessageProcessor) NameRegistrar
17 | .getIfExists("serverprocessor");
18 | if (serverprocessor != null) {
19 | isoMessageResponse = serverprocessor.process(message);
20 | }
21 |
22 | source.send(isoMessageResponse);
23 | return true;
24 | } catch (Exception e) {
25 | return false;
26 | }
27 | }
28 |
29 | }
30 |
--------------------------------------------------------------------------------
/src/dist/deploy/30_processors.xml:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## jPOS-example
2 | This is example of using jPOS. In this project jPOS (with some Java classes) works as SOAP server which proxies requests to ISO-8583 processing server and as ISO-8583 processing server.
3 |
4 | ### SOAP server
5 | - it's a JAX-WS web service that just does mapping of SOAP fields to ISO message fields, send it to ISO-8583 server and return ISO response as SOAP response
6 | - web service parameters are listed in **/src/dist/deploy/60_clientws.xml**
7 | - sources in **/src/main/java/middleware/webservice/**
8 | - messages are pre-processed before sending to ISO-8583 server by **/src/dist/deploy/30_processors.xml** jPOS script
9 | - by default runs on **http://localhost:8000/ws/**, WSDL: **http://localhost:8000/ws/?wsdl**
10 | - remote ISO-8583 server connection parameters are listed in **/src/dist/deploy/61_clientchannel.xml**
11 |
12 | ### ISO-8583 server
13 |
14 | - it is a dummy-server, that just responses OK (response code 0 in 39 field) to any request.
15 | - channel parameters are listed in **/src/dist/deploy/40_server.xml**
16 | - message processing is described by the same **/src/dist/deploy/30_processors.xml** jPOS script
17 |
18 | ### Build and run
19 | Build with Gradle (or Gradle wrapper):
20 |
21 | gradlew installApp
22 |
23 | and run Q2 server:
24 |
25 | build/install/jpos-example/bin/q2
26 |
27 | ### Used jPOS Documentation
28 |
29 | - [jPOS-Project-Guide.pdf](http://jpos.org/doc/jPOS-Project-Guide.pdf)
30 | - [proguide-draft.pdf](http://jpos.org/doc/proguide-draft.pdf)
31 | - [jPOS-EE.pdf](http://jpos.org/doc/jPOS-EE.pdf)
32 | - [jPOS Blog](http://jpos.org/blog/)
33 | - [jPOS Google group](http://markmail.org/search/?q=com.googlegroups.jpos-users)
34 | - [jPOS Server](http://didikhari.web.id/java/jpos-server-forward-request-message-to-another-server/)
35 | - [jPOS keep-alive](https://groups.google.com/forum/#!topic/jpos-users/jxA2MGdqaaA)
36 |
37 | ### Remarks
38 | Since jPOS runs as standalone Q2 server, it is possible to update message processors (or any other xml's) «on-the-fly», while jPOS is running.
39 |
40 | ### jPOS-template
41 | This project is based on [jPOS Template](https://github.com/jpos/jPOS-template/blob/master/README.md).
42 |
--------------------------------------------------------------------------------
/src/dist/deploy/00_logger.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
35 |
41 |
42 |
43 |
49 |
52 |
58 |
59 |
60 |
61 |
--------------------------------------------------------------------------------
/src/dist/bin/q2.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem run startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | @rem Add default JVM options here. You can also use JAVA_OPTS and RUN_OPTS to pass JVM options to this script.
12 | set DEFAULT_JVM_OPTS=
13 |
14 | set DIRNAME=%~dp0
15 | if "%DIRNAME%" == "" set DIRNAME=.
16 | set APP_BASE_NAME=%~n0
17 | set APP_HOME=%DIRNAME%..
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windowz variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 | if "%@eval[2+2]" == "4" goto 4NT_args
53 |
54 | :win9xME_args
55 | @rem Slurp the command line arguments.
56 | set CMD_LINE_ARGS=
57 | set _SKIP=2
58 |
59 | :win9xME_args_slurp
60 | if "x%~1" == "x" goto execute
61 |
62 | set CMD_LINE_ARGS=%*
63 | goto execute
64 |
65 | :4NT_args
66 | @rem Get arguments from the 4NT Shell from JP Software
67 | set CMD_LINE_ARGS=%$
68 |
69 | :execute
70 | @rem Setup the command line
71 |
72 | @rem Execute run
73 | CD "%APP_HOME%"
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %RUN_OPTS% -jar @jarname@ %CMD_LINE_ARGS%
75 |
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 |
80 | :fail
81 | rem Set variable RUN_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if not "" == "%RUN_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 |
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 |
89 | :omega
90 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
12 | set DEFAULT_JVM_OPTS=
13 |
14 | set DIRNAME=%~dp0
15 | if "%DIRNAME%" == "" set DIRNAME=.
16 | set APP_BASE_NAME=%~n0
17 | set APP_HOME=%DIRNAME%
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windowz variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 | if "%@eval[2+2]" == "4" goto 4NT_args
53 |
54 | :win9xME_args
55 | @rem Slurp the command line arguments.
56 | set CMD_LINE_ARGS=
57 | set _SKIP=2
58 |
59 | :win9xME_args_slurp
60 | if "x%~1" == "x" goto execute
61 |
62 | set CMD_LINE_ARGS=%*
63 | goto execute
64 |
65 | :4NT_args
66 | @rem Get arguments from the 4NT Shell from JP Software
67 | set CMD_LINE_ARGS=%$
68 |
69 | :execute
70 | @rem Setup the command line
71 |
72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if "%ERRORLEVEL%"=="0" goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
85 | exit /b 1
86 |
87 | :mainEnd
88 | if "%OS%"=="Windows_NT" endlocal
89 |
90 | :omega
91 |
--------------------------------------------------------------------------------
/src/main/java/middleware/Proxy.java:
--------------------------------------------------------------------------------
1 | package middleware;
2 |
3 | import java.util.concurrent.ExecutorService;
4 | import java.util.concurrent.Executors;
5 |
6 | import javax.xml.ws.Endpoint;
7 |
8 | import middleware.webservice.Webservice;
9 |
10 | import org.jpos.core.Configurable;
11 | import org.jpos.core.Configuration;
12 | import org.jpos.core.ConfigurationException;
13 | import org.jpos.q2.Q2;
14 | import org.jpos.q2.QBean;
15 | import org.jpos.util.Log;
16 |
17 | public class Proxy implements QBean, ProxyMBean, Configurable {
18 |
19 | private volatile int state;
20 | private Log log;
21 | private int webservicePort;
22 | private int webserviceThreads;
23 | private int transactionTimeout;
24 | private Endpoint webserviceEndpoint;
25 |
26 | public Proxy() {
27 | state = -1;
28 | log = Log.getLog(Q2.LOGGER_NAME, "middleware");
29 | log.info("constructor");
30 | }
31 |
32 | @Override
33 | public void init() throws Exception {
34 | log.info("initializing");
35 | state = QBean.STARTING;
36 | }
37 |
38 | @Override
39 | public void start() throws Exception {
40 | log.info("starting");
41 | log.info("webservice port: " + this.getWebservicePort() + ", threadpool: " + this.getWebserviceThreads());
42 | /* create webservice endpoint and publish */
43 | this.webserviceEndpoint = Endpoint.create(new Webservice(this.getTransactionTimeout()));
44 | ExecutorService executor = Executors.newFixedThreadPool(this.getWebserviceThreads());
45 | this.webserviceEndpoint.setExecutor(executor);
46 | this.webserviceEndpoint.publish("http://0.0.0.0:" + this.getWebservicePort() + "/ws/");
47 | state = QBean.STARTED;
48 | }
49 |
50 | @Override
51 | public void stop() throws Exception {
52 | log.info("stopping");
53 | /* stop endpoing */
54 | this.webserviceEndpoint.stop();
55 | state = QBean.STOPPED;
56 | }
57 |
58 | @Override
59 | public void destroy() throws Exception {
60 | log.info("destroying");
61 | state = QBean.STOPPED;
62 | }
63 |
64 | @Override
65 | public int getState() {
66 | return state;
67 | }
68 |
69 | @Override
70 | public String getStateAsString() {
71 | return state >= 0 ? QBean.stateString[state] : "Unknown";
72 | }
73 |
74 | public int getWebservicePort() {
75 | return webservicePort;
76 | }
77 |
78 | public void setWebservicePort(int webservicePort) {
79 | this.webservicePort = webservicePort;
80 | }
81 |
82 | public int getWebserviceThreads() {
83 | return webserviceThreads;
84 | }
85 |
86 | public void setWebserviceThreads(int webserviceThreads) {
87 | this.webserviceThreads = webserviceThreads;
88 | }
89 |
90 | @Override
91 | public void setConfiguration(Configuration cfg)
92 | throws ConfigurationException {
93 | this.setWebservicePort(cfg.getInt("webservicePort", 100));
94 | this.setWebserviceThreads(cfg.getInt("webserviceThreads", 10));
95 | this.setTransactionTimeout(cfg.getInt("transactionTimeout", 10000));
96 | }
97 |
98 | int getTransactionTimeout() {
99 | return transactionTimeout;
100 | }
101 |
102 | void setTransactionTimeout(int transactionTimeout) {
103 | this.transactionTimeout = transactionTimeout;
104 | }
105 |
106 | }
107 |
--------------------------------------------------------------------------------
/src/main/java/middleware/webservice/Webservice.java:
--------------------------------------------------------------------------------
1 | package middleware.webservice;
2 |
3 | import java.util.Map.Entry;
4 | import java.util.concurrent.TimeoutException;
5 |
6 | import javax.jws.WebMethod;
7 | import javax.jws.WebService;
8 | import javax.xml.bind.DatatypeConverter;
9 |
10 | import middleware.MessageProcessor;
11 |
12 | import org.jpos.iso.ISOException;
13 | import org.jpos.iso.ISOMsg;
14 | import org.jpos.q2.iso.QMUX;
15 | import org.jpos.util.NameRegistrar;
16 |
17 | @WebService
18 | public class Webservice implements WebserviceInterface {
19 |
20 | private int transactionTimeout = 10000;
21 |
22 | public Webservice(int transactionTimeout) {
23 | this.setTransactionTimeout(transactionTimeout);
24 | }
25 |
26 | public Webservice() {
27 | }
28 |
29 | static ISOMsg createISOMsgFromISOMessageContent(
30 | ISOMessageContent messageRequest) throws ISOException {
31 | ISOMsg isoMessageRequest = new ISOMsg();
32 | /* set MTI and header */
33 | isoMessageRequest.setMTI(messageRequest.getMTI());
34 | isoMessageRequest.setHeader(messageRequest.getISOHeader().getBytes());
35 | /* map ISOMessageContent hashmap to ISOMsg fields */
36 | for (Entry entry : messageRequest.getFields()
37 | .entrySet()) {
38 | String key = entry.getKey();
39 | String value = entry.getValue();
40 | if (!isStringNullOrEmpty(key) && !isStringNullOrEmpty(value)) {
41 | isoMessageRequest.set(key, value);
42 | }
43 | }
44 |
45 | return isoMessageRequest;
46 | }
47 |
48 | static ISOMessageContent createISOMessageContentFromISOMsg(
49 | ISOMsg isoResponseMessage) throws ISOException {
50 | ISOMessageContent response = new ISOMessageContent();
51 | /* set MTI and header */
52 | response.setMTI(isoResponseMessage.getMTI());
53 | if (isoResponseMessage.getHeader() != null) {
54 | response.setISOHeader(new String(isoResponseMessage.getHeader()));
55 | }
56 | /* map ISOMsg fields and subfields to ISOMessageContent hashmap */
57 | for (int i = 1; i <= isoResponseMessage.getMaxField(); i++) {
58 | if (isoResponseMessage.hasField(i)) {
59 | response.getFields().put(i + "",
60 | isoResponseMessage.getString(i));
61 | }
62 | }
63 | return response;
64 | }
65 |
66 | @Override
67 | @WebMethod
68 | public ISOMessageContent send(ISOMessageContent messageRequest)
69 | throws Exception {
70 |
71 | ISOMsg isoMessageRequest = createISOMsgFromISOMessageContent(messageRequest);
72 | MessageProcessor messagePreprocessor = (MessageProcessor) NameRegistrar
73 | .getIfExists("preprocessor");
74 | if (messagePreprocessor != null) {
75 | isoMessageRequest = messagePreprocessor.process(isoMessageRequest);
76 | }
77 |
78 | QMUX qmux = (QMUX) QMUX.getMUX("clientmux");
79 | ISOMsg isoResponseMessage = qmux.request(isoMessageRequest,
80 | this.getTransactionTimeout());
81 |
82 | if (isoResponseMessage == null) {
83 | throw new TimeoutException("Transaction timed out!");
84 | }
85 | ISOMessageContent response = createISOMessageContentFromISOMsg(isoResponseMessage);
86 |
87 | return response;
88 | }
89 |
90 | private int getTransactionTimeout() {
91 | return transactionTimeout;
92 | }
93 |
94 | private void setTransactionTimeout(int transactionTimeout) {
95 | this.transactionTimeout = transactionTimeout;
96 | }
97 |
98 | static boolean isStringNullOrEmpty(String string) {
99 | return string == null || string.isEmpty();
100 | }
101 | }
102 |
--------------------------------------------------------------------------------
/.classpath:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10 | DEFAULT_JVM_OPTS=""
11 |
12 | APP_NAME="Gradle"
13 | APP_BASE_NAME=`basename "$0"`
14 |
15 | # Use the maximum available, or set MAX_FD != -1 to use that value.
16 | MAX_FD="maximum"
17 |
18 | warn ( ) {
19 | echo "$*"
20 | }
21 |
22 | die ( ) {
23 | echo
24 | echo "$*"
25 | echo
26 | exit 1
27 | }
28 |
29 | # OS specific support (must be 'true' or 'false').
30 | cygwin=false
31 | msys=false
32 | darwin=false
33 | case "`uname`" in
34 | CYGWIN* )
35 | cygwin=true
36 | ;;
37 | Darwin* )
38 | darwin=true
39 | ;;
40 | MINGW* )
41 | msys=true
42 | ;;
43 | esac
44 |
45 | # For Cygwin, ensure paths are in UNIX format before anything is touched.
46 | if $cygwin ; then
47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
48 | fi
49 |
50 | # Attempt to set APP_HOME
51 | # Resolve links: $0 may be a link
52 | PRG="$0"
53 | # Need this for relative symlinks.
54 | while [ -h "$PRG" ] ; do
55 | ls=`ls -ld "$PRG"`
56 | link=`expr "$ls" : '.*-> \(.*\)$'`
57 | if expr "$link" : '/.*' > /dev/null; then
58 | PRG="$link"
59 | else
60 | PRG=`dirname "$PRG"`"/$link"
61 | fi
62 | done
63 | SAVED="`pwd`"
64 | cd "`dirname \"$PRG\"`/" >&-
65 | APP_HOME="`pwd -P`"
66 | cd "$SAVED" >&-
67 |
68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
69 |
70 | # Determine the Java command to use to start the JVM.
71 | if [ -n "$JAVA_HOME" ] ; then
72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
73 | # IBM's JDK on AIX uses strange locations for the executables
74 | JAVACMD="$JAVA_HOME/jre/sh/java"
75 | else
76 | JAVACMD="$JAVA_HOME/bin/java"
77 | fi
78 | if [ ! -x "$JAVACMD" ] ; then
79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
80 |
81 | Please set the JAVA_HOME variable in your environment to match the
82 | location of your Java installation."
83 | fi
84 | else
85 | JAVACMD="java"
86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
87 |
88 | Please set the JAVA_HOME variable in your environment to match the
89 | location of your Java installation."
90 | fi
91 |
92 | # Increase the maximum file descriptors if we can.
93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
94 | MAX_FD_LIMIT=`ulimit -H -n`
95 | if [ $? -eq 0 ] ; then
96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
97 | MAX_FD="$MAX_FD_LIMIT"
98 | fi
99 | ulimit -n $MAX_FD
100 | if [ $? -ne 0 ] ; then
101 | warn "Could not set maximum file descriptor limit: $MAX_FD"
102 | fi
103 | else
104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
105 | fi
106 | fi
107 |
108 | # For Darwin, add options to specify how the application appears in the dock
109 | if $darwin; then
110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
111 | fi
112 |
113 | # For Cygwin, switch paths to Windows format before running java
114 | if $cygwin ; then
115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
158 | function splitJvmOpts() {
159 | JVM_OPTS=("$@")
160 | }
161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
163 |
164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
165 |
--------------------------------------------------------------------------------
/jpos-app.gradle:
--------------------------------------------------------------------------------
1 | def archiveJarName="${project.name}-${project.version}.jar"
2 | def archiveWarName="${project.name}-${project.version}.war"
3 | def installDir=file("${project.buildDir}/install/${project.name}")
4 | project.ext {
5 | targetConfiguration = new Properties()
6 | def target = project.hasProperty('target') ? target : 'devel'
7 | targetConfiguration.put('jarname', archiveJarName.toString())
8 | targetConfiguration.put('warname', archiveWarName.toString())
9 | targetConfiguration.put('target', target.toString())
10 | targetConfiguration.put("buildTimestamp", new Date().format("yyyy-MM-dd HH:mm:ss z"));
11 | File cfgFile = file("${target}.properties")
12 | if (cfgFile.exists()) {
13 | cfgFile.withInputStream{
14 | targetConfiguration.load(it);
15 | }
16 | }
17 | }
18 |
19 | def jposCopySpec = copySpec {
20 | from(file("src/dist")) {
21 | exclude 'cfg/*.jks'
22 | exclude '**/*.jpg'
23 | exclude '**/*.gif'
24 | exclude '**/*.png'
25 | exclude '**/*.pdf'
26 | filter(
27 | org.apache.tools.ant.filters.ReplaceTokens,
28 | tokens: targetConfiguration
29 | )
30 | }
31 | from(file("src/dist")) {
32 | include 'cfg/*.ks'
33 | include 'cfg/*.jks'
34 | include '**/*.jpg'
35 | include '**/*.gif'
36 | include '**/*.png'
37 | include '**/*.pdf'
38 | }
39 | from(jar) {
40 | rename archiveJarName, "${targetConfiguration.jarname}"
41 | }
42 | into("lib") {
43 | from(configurations.runtime)
44 | }
45 | into("webapps") {
46 | from(file("build/libs")) {
47 | include '*.war'
48 | }
49 | }
50 | }
51 |
52 | // Create the jar's manifest
53 | jar.manifest {
54 | attributes \
55 | 'Implementation-Title': project.name,
56 | 'Implementation-Version': project.version,
57 | 'Main-Class': 'org.jpos.q2.Q2',
58 | 'Class-Path': configurations.runtime.collect { "lib/" + it.getName() }.join(' ')
59 | }
60 |
61 | task sourceJar( type: Jar ) {
62 | classifier = "sources"
63 | from sourceSets.main.allSource
64 | }
65 |
66 | task javadocJar (type: Jar, dependsOn: javadoc) {
67 | classifier = 'javadoc'
68 | from new File(project.buildDir, 'docs/javadoc')
69 | }
70 |
71 | artifacts {
72 | archives sourceJar, javadocJar
73 | }
74 |
75 | processResources {
76 | from(sourceSets.main.resources.srcDirs) {
77 | include '**/*.properties'
78 | include '**/*.xml'
79 | include '**/*.cfg'
80 | include '**/*.asc'
81 | filter(
82 | org.apache.tools.ant.filters.ReplaceTokens,
83 | tokens: targetConfiguration
84 | )
85 | }
86 | }
87 | //--------------------------------------------------
88 | // TASKS
89 | //--------------------------------------------------
90 |
91 | task version (type: JavaExec, dependsOn: classes) {
92 | description = "Shows jPOS Version"
93 | main = 'org.jpos.q2.Q2'
94 | args = ['--version']
95 | classpath configurations.runtime
96 | }
97 |
98 | task dist(type: Tar) {
99 | dependsOn 'assemble', 'sourceJar'
100 | description 'Creates tar distribution'
101 | compression = Compression.GZIP
102 | includeEmptyDirs true
103 | into "$project.name-$version"
104 | with jposCopySpec
105 | extension "tar.gz"
106 | }
107 |
108 | task zip(type: Zip) {
109 | dependsOn 'assemble', 'sourceJar'
110 | description 'Creates zip distribution'
111 | includeEmptyDirs true
112 | into "$project.name-$version"
113 | with jposCopySpec
114 | extension "zip"
115 | }
116 |
117 | task installApp(type: Sync) {
118 | description 'Installs jPOS based application'
119 | into { installDir }
120 | with jposCopySpec
121 | }
122 |
123 | task wrapper( type: Wrapper ) {
124 | description = "Generate gradlew[.bat]"
125 | gradleVersion = '1.9'
126 | }
127 |
128 | task installResources(dependsOn: 'classes', type: JavaExec) {
129 | classpath = sourceSets.main.runtimeClasspath
130 | main = 'org.jpos.q2.install.Install'
131 | args = ["--outputDir=src/dist"]
132 | }
133 |
134 | task run( dependsOn: 'installApp', type: Exec ) {
135 | workingDir installDir
136 | commandLine 'java','-jar', archiveJarName
137 | }
138 |
139 | /*
140 | task genDocker(type: Docker, dependsOn: 'jar') {
141 | def projectName = project.name
142 | applicationName = "${projectName}"
143 | workingDir "/app"
144 | addFile {
145 | into('/app') {
146 | with(jposCopySpec)
147 | }
148 | }
149 | defaultCommand = ["/bin/sh","/app/bin/q2"]
150 | }
151 | */
152 |
153 | class GitRevisionTask extends DefaultTask
154 | {
155 | @InputFile @Optional
156 | File gitHead
157 | boolean gotHead
158 |
159 | File getRefFile()
160 | {
161 | return new File(gitHead.parent,gitHead.text.replace('ref: ', '').trim())
162 | }
163 |
164 | @OutputFile
165 | File outputFile
166 |
167 | @TaskAction
168 | public void writeFile()
169 | {
170 | Properties props=new Properties()
171 | if (gotHead) {
172 | File ref=getRefFile()
173 | if (ref.exists()) {
174 | props.put("branch",ref.getName())
175 | props.put("revision",ref.text.substring(0,7))
176 | } else {
177 | props.put("branch", "detached");
178 | props.put("revision", gitHead.text.substring(0,7))
179 | }
180 | } else {
181 | props.put("branch", "unknown");
182 | props.put("revision", "unknown");
183 | }
184 | props.store(new FileOutputStream(outputFile),"Revision Properties")
185 | }
186 | }
187 |
188 | class BuildTimestampTask extends DefaultTask {
189 | // We don't want to declare @OutputFile,
190 | // we need a fresh timestamp on every run
191 | File outputFile
192 |
193 | @TaskAction
194 | public void writeFile() {
195 | new File(outputFile.parent).mkdirs()
196 | Properties props=new Properties()
197 | props.put("projectName", project.name);
198 | props.put("version", project.version);
199 | props.put("buildTimestamp", new Date().format("yyyy-MM-dd HH:mm:ss z"));
200 | props.store(new FileOutputStream(outputFile),"Revision Properties")
201 | }
202 | }
203 |
204 |
205 | task createBuildTimestampPropertyFile(type: BuildTimestampTask) {
206 | outputFile = "$sourceSets.main.output.resourcesDir/buildinfo.properties" as File
207 | }
208 |
209 | task createRevisionPropertyFile(type: GitRevisionTask) {
210 | gitHead = "$rootDir/.git/HEAD" as File
211 | gotHead = gitHead.exists()
212 | if (!gotHead)
213 | gitHead = null;
214 | outputFile = "$sourceSets.main.output.resourcesDir/revision.properties" as File
215 | }
216 |
217 | processResources.dependsOn createBuildTimestampPropertyFile, createRevisionPropertyFile
218 |
219 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license
11 | for software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are
15 | designed to take away your freedom to share and change the works. By
16 | contrast, our General Public Licenses are intended to guarantee your
17 | freedom to share and change all versions of a program--to make sure it
18 | remains free software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public
64 | License.
65 |
66 | "Copyright" also means copyright-like laws that apply to other kinds
67 | of works, such as semiconductor masks.
68 |
69 | "The Program" refers to any copyrightable work licensed under this
70 | License. Each licensee is addressed as "you". "Licensees" and
71 | "recipients" may be individuals or organizations.
72 |
73 | To "modify" a work means to copy from or adapt all or part of the work
74 | in a fashion requiring copyright permission, other than the making of an
75 | exact copy. The resulting work is called a "modified version" of the
76 | earlier work or a work "based on" the earlier work.
77 |
78 | A "covered work" means either the unmodified Program or a work based
79 | on the Program.
80 |
81 | To "propagate" a work means to do anything with it that, without
82 | permission, would make you directly or secondarily liable for
83 | infringement under applicable copyright law, except executing it on a
84 | computer or modifying a private copy. Propagation includes copying,
85 | distribution (with or without modification), making available to the
86 | public, and in some countries other activities as well.
87 |
88 | To "convey" a work means any kind of propagation that enables other
89 | parties to make or receive copies. Mere interaction with a user through
90 | a computer network, with no transfer of a copy, is not conveying.
91 |
92 | An interactive user interface displays "Appropriate Legal Notices"
93 | to the extent that it includes a convenient and prominently visible
94 | feature that (1) displays an appropriate copyright notice, and (2)
95 | tells the user that there is no warranty for the work (except to the
96 | extent that warranties are provided), that licensees may convey the
97 | work under this License, and how to view a copy of this License. If
98 | the interface presents a list of user commands or options, such as a
99 | menu, a prominent item in the list meets this criterion.
100 |
101 | 1. Source Code.
102 |
103 | The "source code" for a work means the preferred form of the work
104 | for making modifications to it. "Object code" means any non-source
105 | form of a work.
106 |
107 | A "Standard Interface" means an interface that either is an official
108 | standard defined by a recognized standards body, or, in the case of
109 | interfaces specified for a particular programming language, one that
110 | is widely used among developers working in that language.
111 |
112 | The "System Libraries" of an executable work include anything, other
113 | than the work as a whole, that (a) is included in the normal form of
114 | packaging a Major Component, but which is not part of that Major
115 | Component, and (b) serves only to enable use of the work with that
116 | Major Component, or to implement a Standard Interface for which an
117 | implementation is available to the public in source code form. A
118 | "Major Component", in this context, means a major essential component
119 | (kernel, window system, and so on) of the specific operating system
120 | (if any) on which the executable work runs, or a compiler used to
121 | produce the work, or an object code interpreter used to run it.
122 |
123 | The "Corresponding Source" for a work in object code form means all
124 | the source code needed to generate, install, and (for an executable
125 | work) run the object code and to modify the work, including scripts to
126 | control those activities. However, it does not include the work's
127 | System Libraries, or general-purpose tools or generally available free
128 | programs which are used unmodified in performing those activities but
129 | which are not part of the work. For example, Corresponding Source
130 | includes interface definition files associated with source files for
131 | the work, and the source code for shared libraries and dynamically
132 | linked subprograms that the work is specifically designed to require,
133 | such as by intimate data communication or control flow between those
134 | subprograms and other parts of the work.
135 |
136 | The Corresponding Source need not include anything that users
137 | can regenerate automatically from other parts of the Corresponding
138 | Source.
139 |
140 | The Corresponding Source for a work in source code form is that
141 | same work.
142 |
143 | 2. Basic Permissions.
144 |
145 | All rights granted under this License are granted for the term of
146 | copyright on the Program, and are irrevocable provided the stated
147 | conditions are met. This License explicitly affirms your unlimited
148 | permission to run the unmodified Program. The output from running a
149 | covered work is covered by this License only if the output, given its
150 | content, constitutes a covered work. This License acknowledges your
151 | rights of fair use or other equivalent, as provided by copyright law.
152 |
153 | You may make, run and propagate covered works that you do not
154 | convey, without conditions so long as your license otherwise remains
155 | in force. You may convey covered works to others for the sole purpose
156 | of having them make modifications exclusively for you, or provide you
157 | with facilities for running those works, provided that you comply with
158 | the terms of this License in conveying all material for which you do
159 | not control copyright. Those thus making or running the covered works
160 | for you must do so exclusively on your behalf, under your direction
161 | and control, on terms that prohibit them from making any copies of
162 | your copyrighted material outside their relationship with you.
163 |
164 | Conveying under any other circumstances is permitted solely under
165 | the conditions stated below. Sublicensing is not allowed; section 10
166 | makes it unnecessary.
167 |
168 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
169 |
170 | No covered work shall be deemed part of an effective technological
171 | measure under any applicable law fulfilling obligations under article
172 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
173 | similar laws prohibiting or restricting circumvention of such
174 | measures.
175 |
176 | When you convey a covered work, you waive any legal power to forbid
177 | circumvention of technological measures to the extent such circumvention
178 | is effected by exercising rights under this License with respect to
179 | the covered work, and you disclaim any intention to limit operation or
180 | modification of the work as a means of enforcing, against the work's
181 | users, your or third parties' legal rights to forbid circumvention of
182 | technological measures.
183 |
184 | 4. Conveying Verbatim Copies.
185 |
186 | You may convey verbatim copies of the Program's source code as you
187 | receive it, in any medium, provided that you conspicuously and
188 | appropriately publish on each copy an appropriate copyright notice;
189 | keep intact all notices stating that this License and any
190 | non-permissive terms added in accord with section 7 apply to the code;
191 | keep intact all notices of the absence of any warranty; and give all
192 | recipients a copy of this License along with the Program.
193 |
194 | You may charge any price or no price for each copy that you convey,
195 | and you may offer support or warranty protection for a fee.
196 |
197 | 5. Conveying Modified Source Versions.
198 |
199 | You may convey a work based on the Program, or the modifications to
200 | produce it from the Program, in the form of source code under the
201 | terms of section 4, provided that you also meet all of these conditions:
202 |
203 | a) The work must carry prominent notices stating that you modified
204 | it, and giving a relevant date.
205 |
206 | b) The work must carry prominent notices stating that it is
207 | released under this License and any conditions added under section
208 | 7. This requirement modifies the requirement in section 4 to
209 | "keep intact all notices".
210 |
211 | c) You must license the entire work, as a whole, under this
212 | License to anyone who comes into possession of a copy. This
213 | License will therefore apply, along with any applicable section 7
214 | additional terms, to the whole of the work, and all its parts,
215 | regardless of how they are packaged. This License gives no
216 | permission to license the work in any other way, but it does not
217 | invalidate such permission if you have separately received it.
218 |
219 | d) If the work has interactive user interfaces, each must display
220 | Appropriate Legal Notices; however, if the Program has interactive
221 | interfaces that do not display Appropriate Legal Notices, your
222 | work need not make them do so.
223 |
224 | A compilation of a covered work with other separate and independent
225 | works, which are not by their nature extensions of the covered work,
226 | and which are not combined with it such as to form a larger program,
227 | in or on a volume of a storage or distribution medium, is called an
228 | "aggregate" if the compilation and its resulting copyright are not
229 | used to limit the access or legal rights of the compilation's users
230 | beyond what the individual works permit. Inclusion of a covered work
231 | in an aggregate does not cause this License to apply to the other
232 | parts of the aggregate.
233 |
234 | 6. Conveying Non-Source Forms.
235 |
236 | You may convey a covered work in object code form under the terms
237 | of sections 4 and 5, provided that you also convey the
238 | machine-readable Corresponding Source under the terms of this License,
239 | in one of these ways:
240 |
241 | a) Convey the object code in, or embodied in, a physical product
242 | (including a physical distribution medium), accompanied by the
243 | Corresponding Source fixed on a durable physical medium
244 | customarily used for software interchange.
245 |
246 | b) Convey the object code in, or embodied in, a physical product
247 | (including a physical distribution medium), accompanied by a
248 | written offer, valid for at least three years and valid for as
249 | long as you offer spare parts or customer support for that product
250 | model, to give anyone who possesses the object code either (1) a
251 | copy of the Corresponding Source for all the software in the
252 | product that is covered by this License, on a durable physical
253 | medium customarily used for software interchange, for a price no
254 | more than your reasonable cost of physically performing this
255 | conveying of source, or (2) access to copy the
256 | Corresponding Source from a network server at no charge.
257 |
258 | c) Convey individual copies of the object code with a copy of the
259 | written offer to provide the Corresponding Source. This
260 | alternative is allowed only occasionally and noncommercially, and
261 | only if you received the object code with such an offer, in accord
262 | with subsection 6b.
263 |
264 | d) Convey the object code by offering access from a designated
265 | place (gratis or for a charge), and offer equivalent access to the
266 | Corresponding Source in the same way through the same place at no
267 | further charge. You need not require recipients to copy the
268 | Corresponding Source along with the object code. If the place to
269 | copy the object code is a network server, the Corresponding Source
270 | may be on a different server (operated by you or a third party)
271 | that supports equivalent copying facilities, provided you maintain
272 | clear directions next to the object code saying where to find the
273 | Corresponding Source. Regardless of what server hosts the
274 | Corresponding Source, you remain obligated to ensure that it is
275 | available for as long as needed to satisfy these requirements.
276 |
277 | e) Convey the object code using peer-to-peer transmission, provided
278 | you inform other peers where the object code and Corresponding
279 | Source of the work are being offered to the general public at no
280 | charge under subsection 6d.
281 |
282 | A separable portion of the object code, whose source code is excluded
283 | from the Corresponding Source as a System Library, need not be
284 | included in conveying the object code work.
285 |
286 | A "User Product" is either (1) a "consumer product", which means any
287 | tangible personal property which is normally used for personal, family,
288 | or household purposes, or (2) anything designed or sold for incorporation
289 | into a dwelling. In determining whether a product is a consumer product,
290 | doubtful cases shall be resolved in favor of coverage. For a particular
291 | product received by a particular user, "normally used" refers to a
292 | typical or common use of that class of product, regardless of the status
293 | of the particular user or of the way in which the particular user
294 | actually uses, or expects or is expected to use, the product. A product
295 | is a consumer product regardless of whether the product has substantial
296 | commercial, industrial or non-consumer uses, unless such uses represent
297 | the only significant mode of use of the product.
298 |
299 | "Installation Information" for a User Product means any methods,
300 | procedures, authorization keys, or other information required to install
301 | and execute modified versions of a covered work in that User Product from
302 | a modified version of its Corresponding Source. The information must
303 | suffice to ensure that the continued functioning of the modified object
304 | code is in no case prevented or interfered with solely because
305 | modification has been made.
306 |
307 | If you convey an object code work under this section in, or with, or
308 | specifically for use in, a User Product, and the conveying occurs as
309 | part of a transaction in which the right of possession and use of the
310 | User Product is transferred to the recipient in perpetuity or for a
311 | fixed term (regardless of how the transaction is characterized), the
312 | Corresponding Source conveyed under this section must be accompanied
313 | by the Installation Information. But this requirement does not apply
314 | if neither you nor any third party retains the ability to install
315 | modified object code on the User Product (for example, the work has
316 | been installed in ROM).
317 |
318 | The requirement to provide Installation Information does not include a
319 | requirement to continue to provide support service, warranty, or updates
320 | for a work that has been modified or installed by the recipient, or for
321 | the User Product in which it has been modified or installed. Access to a
322 | network may be denied when the modification itself materially and
323 | adversely affects the operation of the network or violates the rules and
324 | protocols for communication across the network.
325 |
326 | Corresponding Source conveyed, and Installation Information provided,
327 | in accord with this section must be in a format that is publicly
328 | documented (and with an implementation available to the public in
329 | source code form), and must require no special password or key for
330 | unpacking, reading or copying.
331 |
332 | 7. Additional Terms.
333 |
334 | "Additional permissions" are terms that supplement the terms of this
335 | License by making exceptions from one or more of its conditions.
336 | Additional permissions that are applicable to the entire Program shall
337 | be treated as though they were included in this License, to the extent
338 | that they are valid under applicable law. If additional permissions
339 | apply only to part of the Program, that part may be used separately
340 | under those permissions, but the entire Program remains governed by
341 | this License without regard to the additional permissions.
342 |
343 | When you convey a copy of a covered work, you may at your option
344 | remove any additional permissions from that copy, or from any part of
345 | it. (Additional permissions may be written to require their own
346 | removal in certain cases when you modify the work.) You may place
347 | additional permissions on material, added by you to a covered work,
348 | for which you have or can give appropriate copyright permission.
349 |
350 | Notwithstanding any other provision of this License, for material you
351 | add to a covered work, you may (if authorized by the copyright holders of
352 | that material) supplement the terms of this License with terms:
353 |
354 | a) Disclaiming warranty or limiting liability differently from the
355 | terms of sections 15 and 16 of this License; or
356 |
357 | b) Requiring preservation of specified reasonable legal notices or
358 | author attributions in that material or in the Appropriate Legal
359 | Notices displayed by works containing it; or
360 |
361 | c) Prohibiting misrepresentation of the origin of that material, or
362 | requiring that modified versions of such material be marked in
363 | reasonable ways as different from the original version; or
364 |
365 | d) Limiting the use for publicity purposes of names of licensors or
366 | authors of the material; or
367 |
368 | e) Declining to grant rights under trademark law for use of some
369 | trade names, trademarks, or service marks; or
370 |
371 | f) Requiring indemnification of licensors and authors of that
372 | material by anyone who conveys the material (or modified versions of
373 | it) with contractual assumptions of liability to the recipient, for
374 | any liability that these contractual assumptions directly impose on
375 | those licensors and authors.
376 |
377 | All other non-permissive additional terms are considered "further
378 | restrictions" within the meaning of section 10. If the Program as you
379 | received it, or any part of it, contains a notice stating that it is
380 | governed by this License along with a term that is a further restriction,
381 | you may remove that term. If a license document contains a further
382 | restriction but permits relicensing or conveying under this License, you
383 | may add to a covered work material governed by the terms of that license
384 | document, provided that the further restriction does not survive such
385 | relicensing or conveying.
386 |
387 | If you add terms to a covered work in accord with this section, you
388 | must place, in the relevant source files, a statement of the
389 | additional terms that apply to those files, or a notice indicating
390 | where to find the applicable terms.
391 |
392 | Additional terms, permissive or non-permissive, may be stated in the
393 | form of a separately written license, or stated as exceptions;
394 | the above requirements apply either way.
395 |
396 | 8. Termination.
397 |
398 | You may not propagate or modify a covered work except as expressly
399 | provided under this License. Any attempt otherwise to propagate or
400 | modify it is void, and will automatically terminate your rights under
401 | this License (including any patent licenses granted under the third
402 | paragraph of section 11).
403 |
404 | However, if you cease all violation of this License, then your
405 | license from a particular copyright holder is reinstated (a)
406 | provisionally, unless and until the copyright holder explicitly and
407 | finally terminates your license, and (b) permanently, if the copyright
408 | holder fails to notify you of the violation by some reasonable means
409 | prior to 60 days after the cessation.
410 |
411 | Moreover, your license from a particular copyright holder is
412 | reinstated permanently if the copyright holder notifies you of the
413 | violation by some reasonable means, this is the first time you have
414 | received notice of violation of this License (for any work) from that
415 | copyright holder, and you cure the violation prior to 30 days after
416 | your receipt of the notice.
417 |
418 | Termination of your rights under this section does not terminate the
419 | licenses of parties who have received copies or rights from you under
420 | this License. If your rights have been terminated and not permanently
421 | reinstated, you do not qualify to receive new licenses for the same
422 | material under section 10.
423 |
424 | 9. Acceptance Not Required for Having Copies.
425 |
426 | You are not required to accept this License in order to receive or
427 | run a copy of the Program. Ancillary propagation of a covered work
428 | occurring solely as a consequence of using peer-to-peer transmission
429 | to receive a copy likewise does not require acceptance. However,
430 | nothing other than this License grants you permission to propagate or
431 | modify any covered work. These actions infringe copyright if you do
432 | not accept this License. Therefore, by modifying or propagating a
433 | covered work, you indicate your acceptance of this License to do so.
434 |
435 | 10. Automatic Licensing of Downstream Recipients.
436 |
437 | Each time you convey a covered work, the recipient automatically
438 | receives a license from the original licensors, to run, modify and
439 | propagate that work, subject to this License. You are not responsible
440 | for enforcing compliance by third parties with this License.
441 |
442 | An "entity transaction" is a transaction transferring control of an
443 | organization, or substantially all assets of one, or subdividing an
444 | organization, or merging organizations. If propagation of a covered
445 | work results from an entity transaction, each party to that
446 | transaction who receives a copy of the work also receives whatever
447 | licenses to the work the party's predecessor in interest had or could
448 | give under the previous paragraph, plus a right to possession of the
449 | Corresponding Source of the work from the predecessor in interest, if
450 | the predecessor has it or can get it with reasonable efforts.
451 |
452 | You may not impose any further restrictions on the exercise of the
453 | rights granted or affirmed under this License. For example, you may
454 | not impose a license fee, royalty, or other charge for exercise of
455 | rights granted under this License, and you may not initiate litigation
456 | (including a cross-claim or counterclaim in a lawsuit) alleging that
457 | any patent claim is infringed by making, using, selling, offering for
458 | sale, or importing the Program or any portion of it.
459 |
460 | 11. Patents.
461 |
462 | A "contributor" is a copyright holder who authorizes use under this
463 | License of the Program or a work on which the Program is based. The
464 | work thus licensed is called the contributor's "contributor version".
465 |
466 | A contributor's "essential patent claims" are all patent claims
467 | owned or controlled by the contributor, whether already acquired or
468 | hereafter acquired, that would be infringed by some manner, permitted
469 | by this License, of making, using, or selling its contributor version,
470 | but do not include claims that would be infringed only as a
471 | consequence of further modification of the contributor version. For
472 | purposes of this definition, "control" includes the right to grant
473 | patent sublicenses in a manner consistent with the requirements of
474 | this License.
475 |
476 | Each contributor grants you a non-exclusive, worldwide, royalty-free
477 | patent license under the contributor's essential patent claims, to
478 | make, use, sell, offer for sale, import and otherwise run, modify and
479 | propagate the contents of its contributor version.
480 |
481 | In the following three paragraphs, a "patent license" is any express
482 | agreement or commitment, however denominated, not to enforce a patent
483 | (such as an express permission to practice a patent or covenant not to
484 | sue for patent infringement). To "grant" such a patent license to a
485 | party means to make such an agreement or commitment not to enforce a
486 | patent against the party.
487 |
488 | If you convey a covered work, knowingly relying on a patent license,
489 | and the Corresponding Source of the work is not available for anyone
490 | to copy, free of charge and under the terms of this License, through a
491 | publicly available network server or other readily accessible means,
492 | then you must either (1) cause the Corresponding Source to be so
493 | available, or (2) arrange to deprive yourself of the benefit of the
494 | patent license for this particular work, or (3) arrange, in a manner
495 | consistent with the requirements of this License, to extend the patent
496 | license to downstream recipients. "Knowingly relying" means you have
497 | actual knowledge that, but for the patent license, your conveying the
498 | covered work in a country, or your recipient's use of the covered work
499 | in a country, would infringe one or more identifiable patents in that
500 | country that you have reason to believe are valid.
501 |
502 | If, pursuant to or in connection with a single transaction or
503 | arrangement, you convey, or propagate by procuring conveyance of, a
504 | covered work, and grant a patent license to some of the parties
505 | receiving the covered work authorizing them to use, propagate, modify
506 | or convey a specific copy of the covered work, then the patent license
507 | you grant is automatically extended to all recipients of the covered
508 | work and works based on it.
509 |
510 | A patent license is "discriminatory" if it does not include within
511 | the scope of its coverage, prohibits the exercise of, or is
512 | conditioned on the non-exercise of one or more of the rights that are
513 | specifically granted under this License. You may not convey a covered
514 | work if you are a party to an arrangement with a third party that is
515 | in the business of distributing software, under which you make payment
516 | to the third party based on the extent of your activity of conveying
517 | the work, and under which the third party grants, to any of the
518 | parties who would receive the covered work from you, a discriminatory
519 | patent license (a) in connection with copies of the covered work
520 | conveyed by you (or copies made from those copies), or (b) primarily
521 | for and in connection with specific products or compilations that
522 | contain the covered work, unless you entered into that arrangement,
523 | or that patent license was granted, prior to 28 March 2007.
524 |
525 | Nothing in this License shall be construed as excluding or limiting
526 | any implied license or other defenses to infringement that may
527 | otherwise be available to you under applicable patent law.
528 |
529 | 12. No Surrender of Others' Freedom.
530 |
531 | If conditions are imposed on you (whether by court order, agreement or
532 | otherwise) that contradict the conditions of this License, they do not
533 | excuse you from the conditions of this License. If you cannot convey a
534 | covered work so as to satisfy simultaneously your obligations under this
535 | License and any other pertinent obligations, then as a consequence you may
536 | not convey it at all. For example, if you agree to terms that obligate you
537 | to collect a royalty for further conveying from those to whom you convey
538 | the Program, the only way you could satisfy both those terms and this
539 | License would be to refrain entirely from conveying the Program.
540 |
541 | 13. Remote Network Interaction; Use with the GNU General Public License.
542 |
543 | Notwithstanding any other provision of this License, if you modify the
544 | Program, your modified version must prominently offer all users
545 | interacting with it remotely through a computer network (if your version
546 | supports such interaction) an opportunity to receive the Corresponding
547 | Source of your version by providing access to the Corresponding Source
548 | from a network server at no charge, through some standard or customary
549 | means of facilitating copying of software. This Corresponding Source
550 | shall include the Corresponding Source for any work covered by version 3
551 | of the GNU General Public License that is incorporated pursuant to the
552 | following paragraph.
553 |
554 | Notwithstanding any other provision of this License, you have permission
555 | to link or combine any covered work with a work licensed under version 3
556 | of the GNU General Public License into a single combined work, and to
557 | convey the resulting work. The terms of this License will continue to
558 | apply to the part which is the covered work, but the work with which it is
559 | combined will remain governed by version 3 of the GNU General Public
560 | License.
561 |
562 | 14. Revised Versions of this License.
563 |
564 | The Free Software Foundation may publish revised and/or new versions of
565 | the GNU Affero General Public License from time to time. Such new
566 | versions will be similar in spirit to the present version, but may differ
567 | in detail to address new problems or concerns.
568 |
569 | Each version is given a distinguishing version number. If the
570 | Program specifies that a certain numbered version of the GNU Affero
571 | General Public License "or any later version" applies to it, you have
572 | the option of following the terms and conditions either of that
573 | numbered version or of any later version published by the Free
574 | Software Foundation. If the Program does not specify a version number
575 | of the GNU Affero General Public License, you may choose any version
576 | ever published by the Free Software Foundation.
577 |
578 | If the Program specifies that a proxy can decide which future
579 | versions of the GNU Affero General Public License can be used, that
580 | proxy's public statement of acceptance of a version permanently
581 | authorizes you to choose that version for the Program.
582 |
583 | Later license versions may give you additional or different
584 | permissions. However, no additional obligations are imposed on any
585 | author or copyright holder as a result of your choosing to follow a
586 | later version.
587 |
588 | 15. Disclaimer of Warranty.
589 |
590 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
591 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
592 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
593 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
594 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
595 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
596 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
597 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
598 |
599 | 16. Limitation of Liability.
600 |
601 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
602 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
603 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
604 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
605 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
606 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
607 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
608 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
609 | SUCH DAMAGES.
610 |
611 | 17. Interpretation of Sections 15 and 16.
612 |
613 | If the disclaimer of warranty and limitation of liability provided
614 | above cannot be given local legal effect according to their terms,
615 | reviewing courts shall apply local law that most closely approximates
616 | an absolute waiver of all civil liability in connection with the
617 | Program, unless a warranty or assumption of liability accompanies a
618 | copy of the Program in return for a fee.
619 |
620 | END OF TERMS AND CONDITIONS
621 |
622 | How to Apply These Terms to Your New Programs
623 |
624 | If you develop a new program, and you want it to be of the greatest
625 | possible use to the public, the best way to achieve this is to make it
626 | free software which everyone can redistribute and change under these terms.
627 |
628 | To do so, attach the following notices to the program. It is safest
629 | to attach them to the start of each source file to most effectively
630 | state the exclusion of warranty; and each file should have at least
631 | the "copyright" line and a pointer to where the full notice is found.
632 |
633 |
634 | Copyright (C)
635 |
636 | This program is free software: you can redistribute it and/or modify
637 | it under the terms of the GNU Affero General Public License as
638 | published by the Free Software Foundation, either version 3 of the
639 | License, or (at your option) any later version.
640 |
641 | This program is distributed in the hope that it will be useful,
642 | but WITHOUT ANY WARRANTY; without even the implied warranty of
643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644 | GNU Affero General Public License for more details.
645 |
646 | You should have received a copy of the GNU Affero General Public License
647 | along with this program. If not, see .
648 |
649 | Also add information on how to contact you by electronic and paper mail.
650 |
651 | If your software can interact with users remotely through a computer
652 | network, you should also make sure that it provides a way for users to
653 | get its source. For example, if your program is a web application, its
654 | interface could display a "Source" link that leads users to an archive
655 | of the code. There are many ways you could offer source, and different
656 | solutions will be better for different programs; see section 13 for the
657 | specific requirements.
658 |
659 | You should also get your employer (if you work as a programmer) or school,
660 | if any, to sign a "copyright disclaimer" for the program, if necessary.
661 | For more information on this, and how to apply and follow the GNU AGPL, see
662 | .
663 |
--------------------------------------------------------------------------------