RestComm · bkrok · Aug 17, 2017 · Aug 17, 2017
diff --git a/.gitignore b/.gitignore
@@ -35,3 +35,4 @@ resources/tcap/docs/sources-restcomm/src/
 
 # temp files
 *~
+*.iml
diff --git a/resources/cap/docs/sources-asciidoc/src/main/asciidoc/Author_Group.adoc b/resources/cap/docs/sources-asciidoc/src/main/asciidoc/Author_Group.adoc
@@ -0,0 +1,6 @@
+[[_author_group]]
+= Authors
+
+	Amit Bhayani  {author-email-amit}
+
+	Grzegorz Figiel ProIDS www.pro-ids.com grzegorz.figiel (at) pro-ids.com
diff --git a/resources/cap/docs/sources-asciidoc/src/main/asciidoc/Chapter-Graceful_Stop.adoc b/resources/cap/docs/sources-asciidoc/src/main/asciidoc/Chapter-Graceful_Stop.adoc
@@ -0,0 +1,13 @@
+[[_ra_graceful_stop]]
+= Graceful Stop
+
+[[_ra_graceful_stop_support]]
+== Graceful Stop support
+
+The RA supports Graceful container stop feature. In Graceful Stop state the RA rejects incoming initial events - it rejects new activities creation.
+
+[[_ra_graceful_stop_response]]
+== Graceful Stop reject support
+
+When the RA is in Graceful Stopping mode the `TC_ABORT` is send as a response for every new `TC_BEGIN` TCAP message.
+`CAP-U-ABORT-REASON: no-reason-given (1)` is used as a u-abort-reason parameter value.
diff --git a/resources/cap/docs/sources-asciidoc/src/main/asciidoc/Revision_History.adoc b/resources/cap/docs/sources-asciidoc/src/main/asciidoc/Revision_History.adoc
@@ -4,6 +4,12 @@
 [appendix]
 = Revision History
 
-
+.Revision History
+[cols="1,1,1,1", frame="all", options="header"]
+|===
+| Revision number | Date | Author | Description
+| 1.0 | 2012-01-21 | Amit Bhayani | Creation of the {this-platform} JAIN SLEE CAP RA User Guide..
+| 1.1 | 2016-09-29 | Grzegorz Figiel | Graceful Stop feature chapter added.
+|===
 
 :sectnums:
diff --git a/resources/cap/docs/sources-asciidoc/src/main/asciidoc/User_Guide.adoc b/resources/cap/docs/sources-asciidoc/src/main/asciidoc/User_Guide.adoc
@@ -46,6 +46,12 @@ include::Chapter-Setup.adoc[]
 
 :leveloffset: 1
 
+include::Chapter-Graceful_Stop.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
 include::Revision_History.adoc[]
 
 :leveloffset: 0
diff --git a/...urces/cap/docs/sources-asciidoc/src/main/asciidoc/ra/Section-Configuration.adoc b/...urces/cap/docs/sources-asciidoc/src/main/asciidoc/ra/Section-Configuration.adoc
@@ -10,6 +10,11 @@ It supports following properties:
 |===
 | Property Name | Description | Property Type | Default Value
 | mapJndi | JNDI name of CAP stack | java.lang.String | java:/mobicents/ss7/cap
+| defaultActiveSessionsThreshold | This property defines container default Active Sessions Threshold (AST) value in graceful shutdown resource adaptor mode.
+| java.lang.Integer | 30
+| defaultGracefulShutdownWaitTime | This property defines the maximum time period when the container is waiting for finishing existing sessions/activities in
+graceful shutdown resource adaptor mode.
+| java.lang.Long | 300 |
 |===
 
-IMPORTANT: JAIN SLEE 1.1 Specification requires values set for properties without a default value,  which means the configuration for those properties are mandatory,  otherwise the Resource Adaptor Entity creation will fail! 
+IMPORTANT: JAIN SLEE 1.1 Specification requires values set for properties without a default value,  which means the configuration for those properties are mandatory,  otherwise the Resource Adaptor Entity creation will fail!
diff --git a/resources/cap/docs/sources-asciidoc/src/main/asciidoc/ra/Section-Configuration.xml b/resources/cap/docs/sources-asciidoc/src/main/asciidoc/ra/Section-Configuration.xml
@@ -10,7 +10,7 @@
 	<title>Configuration</title>
 
 	<para>The Resource Adaptor supports configuration only at Resource Adaptor Entity creation time. It supports following properties:</para>
-	
+
 	<table frame="all" pgwide="1">
 		<title>Resource Adaptor's Configuration Properties - cap-default-ra.properties</title>
 		<tgroup colsep="1" cols="4">
@@ -33,20 +33,33 @@
 			   	    <entry>java.lang.String</entry>
 			   	    <entry>java:/mobicents/ss7/cap</entry>
 			    </row>
+				<row>
+					<entry>defaultActiveSessionsThreshold</entry>
+					<entry>This property defines container default Active Sessions Threshold (AST) value in graceful shutdown resource adaptor mode.</entry>
+					<entry>java.lang.Integer</entry>
+					<entry>30</entry>
+				</row>
+				<row>
+					<entry>defaultGracefulShutdownWaitTime</entry>
+					<entry>This property defines the maximum time period when the container is waiting for finishing existing sessions/activities in
+						graceful shutdown resource adaptor mode.</entry>
+					<entry>java.lang.Long</entry>
+					<entry>300</entry>
+				</row>
 			</tbody>
 	 	</tgroup>
-	</table>		
+	</table>
+
 
 
-
 
 
 	<important>
 		<para>
-			JAIN SLEE 1.1 Specification requires values set for properties without a default value, 
-			which means the configuration for those properties are mandatory, 
+			JAIN SLEE 1.1 Specification requires values set for properties without a default value,
+			which means the configuration for those properties are mandatory,
 			otherwise the Resource Adaptor Entity creation will fail!
 		</para>
 	</important>
-		
+
 </section>
diff --git a/resources/cap/docs/sources/src/main/resources/en-US/Author_Group.xml b/resources/cap/docs/sources/src/main/resources/en-US/Author_Group.xml
@@ -1,11 +1,20 @@
-<?xml version='1.0'?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">%BOOK_ENTITIES;]>
-<authorgroup
-	id="authors">
-	<author>
-		<firstname>Amit</firstname>
-		<surname>Bhayani</surname>
-		<email>&AUTHOR.EMAIL.AMIT;</email>
-	</author>
-
-</authorgroup>
+<?xml version='1.0'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<authorgroup
+	id="authors">
+	<author>
+		<firstname>Amit</firstname>
+		<surname>Bhayani</surname>
+		<email>&AUTHOR.EMAIL.AMIT;</email>
+	</author>
+	<author>
+		<firstname>Grzegorz</firstname>
+		<surname>Figiel</surname>
+		<affiliation>ProIDS www.pro-ids.com</affiliation>
+		<email>grzegorz.figiel (at) pro-ids.com</email>
+	</author>
+
+</authorgroup>
diff --git a/resources/cap/docs/sources/src/main/resources/en-US/Chapter-Graceful_Stop.xml b/resources/cap/docs/sources/src/main/resources/en-US/Chapter-Graceful_Stop.xml
@@ -0,0 +1,18 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="ra_graceful_stop">
+  <title>Graceful Stop</title>
+  <section id="ra_graceful_stop">
+    <title>Graceful Stop support</title>
+    <para>The RA supports Graceful container stop feature. In Graceful Stop state the RA rejects incoming initial events - it rejects new activities creation.</para>
+  </section>
+  <section id="ra_graceful_stop_response">
+    <title>Graceful Stop reject support</title>
+    <para>When the RA is in Graceful Stopping mode the <literal>TC_ABORT</literal> is send as a response for every new <literal>TC_BEGIN</literal> TCAP message.
+      <literal>CAP-U-ABORT-REASON: no-reason-given (1)</literal> is used as a u-abort-reason parameter value.
+    </para>
+  </section>
+</chapter>
diff --git a/resources/cap/docs/sources/src/main/resources/en-US/Revision_History.xml b/resources/cap/docs/sources/src/main/resources/en-US/Revision_History.xml
@@ -1,23 +1,39 @@
-<?xml version='1.0'?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">%BOOK_ENTITIES;]>
-<appendix
-	id="revision_history">
-	<title>Revision History</title>
-	<simpara>
-		<revhistory>		
-			<revision>
-				<revnumber>1.0</revnumber>
-				<date>Mon Jan 21 2012</date>
-				<author>
-					<firstname>Amit</firstname>
-					<surname>Bhayani</surname>
-				</author>
-				<revdescription>
-					<simplelist>
-						<member>Creation of the &THIS.PLATFORM; JAIN SLEE CAP RA User Guide.</member>
-					</simplelist>
-				</revdescription>
-			</revision>
-		</revhistory>
-	</simpara>
-</appendix>
+<?xml version='1.0'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<appendix
+	id="revision_history">
+	<title>Revision History</title>
+	<simpara>
+		<revhistory>		
+			<revision>
+				<revnumber>1.0</revnumber>
+				<date>Mon Jan 21 2012</date>
+				<author>
+					<firstname>Amit</firstname>
+					<surname>Bhayani</surname>
+				</author>
+				<revdescription>
+					<simplelist>
+						<member>Creation of the &THIS.PLATFORM; JAIN SLEE CAP RA User Guide.</member>
+					</simplelist>
+				</revdescription>
+			</revision>
+			<revision>
+				<revnumber>1.1</revnumber>
+				<date>2016-09-29</date>
+				<author>
+					<firstname>Grzegorz</firstname>
+					<surname>Figiel</surname>
+				</author>
+				<revdescription>
+					<simplelist>
+						<member>Graceful Stop feature chapter added</member>
+					</simplelist>
+				</revdescription>
+			</revision>
+		</revhistory>
+	</simpara>
+</appendix>
diff --git a/resources/cap/docs/sources/src/main/resources/en-US/User_Guide.xml b/resources/cap/docs/sources/src/main/resources/en-US/User_Guide.xml
@@ -21,6 +21,9 @@
 	<xi:include
 		xmlns:xi="http://www.w3.org/2001/XInclude"
 		href="Chapter-Setup.xml" />
+	<xi:include
+			xmlns:xi="http://www.w3.org/2001/XInclude"
+			href="Chapter-Graceful_Stop.xml" />
 
 	<xi:include
 		href="Revision_History.xml"

diff --git a/resources/cap/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml b/resources/cap/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
@@ -10,7 +10,7 @@
 	<title>Configuration</title>
 
 	<para>The Resource Adaptor supports configuration only at Resource Adaptor Entity creation time. It supports following properties:</para>
-	
+
 	<table frame="all" pgwide="1">
 		<title>Resource Adaptor's Configuration Properties - cap-default-ra.properties</title>
 		<tgroup colsep="1" cols="4">
@@ -33,20 +33,33 @@
 			   	    <entry>java.lang.String</entry>
 			   	    <entry>java:/mobicents/ss7/cap</entry>
 			    </row>
+				<row>
+					<entry>defaultActiveSessionsThreshold</entry>
+					<entry>This property defines container default Active Sessions Threshold (AST) value in graceful shutdown resource adaptor mode.</entry>
+					<entry>java.lang.Integer</entry>
+					<entry>30</entry>
+				</row>
+				<row>
+					<entry>defaultGracefulShutdownWaitTime</entry>
+					<entry>This property defines the maximum time period when the container is waiting for finishing existing sessions/activities in
+						graceful shutdown resource adaptor mode.</entry>
+					<entry>java.lang.Long</entry>
+					<entry>300</entry>
+				</row>
 			</tbody>
 	 	</tgroup>
-	</table>		
+	</table>
+
 
 
-
 
 
 	<important>
 		<para>
-			JAIN SLEE 1.1 Specification requires values set for properties without a default value, 
-			which means the configuration for those properties are mandatory, 
+			JAIN SLEE 1.1 Specification requires values set for properties without a default value,
+			which means the configuration for those properties are mandatory,
 			otherwise the Resource Adaptor Entity creation will fail!
 		</para>
 	</important>
-		
+
 </section>
diff --git a/resources/cap/ra/pom.xml b/resources/cap/ra/pom.xml
@@ -1,5 +1,17 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<configuration>
+					<source>1.7</source>
+					<target>1.7</target>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
 
 	<parent>
 		<artifactId>restcomm-slee-ra-cap</artifactId>
@@ -9,6 +21,11 @@
 
 	<artifactId>restcomm-slee-ra-cap-ra</artifactId>
 
+    <!-- TODO: update to version implementing GracefullyStopableRa interface -->
+	<properties>
+		<restcomm.jain.slee.version>proids-2.8.0</restcomm.jain.slee.version>
+	</properties>
+
 	<dependencies>
 		<dependency>
 			<groupId>${project.groupId}</groupId>
@@ -20,6 +37,11 @@
 			<artifactId>javolution</artifactId>
 			<version>${javolution.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.mobicents.servers.jainslee.core</groupId>
+			<artifactId>spi</artifactId>
+			<version>${restcomm.jain.slee.version}</version>
+		</dependency>
 	</dependencies>
 
 </project>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,3 +35,4 @@ resources/tcap/docs/sources-restcomm/src/

		# temp files
		*~
		*.iml