Fix for issue RestComm#14 - Graceful shutdown feature implementation

ProIDS · Jan 16, 2017 · a5af658 · a5af658
1 parent 3f25106
commit a5af658
Show file tree

Hide file tree

Showing 11 changed files with 262 additions and 121 deletions.
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
@@ -1,9 +1,15 @@
-
-:sectnums!:
-
-[appendix]
-= Revision History
-
-
-
+
+:sectnums!:
+
+[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
@@ -1,51 +1,57 @@
-= User Guide to {this-platform} {this-application} {this-ra} RA {project-version} 
-:doctype: book
-:sectnums:
-:toc: left
-:icons: font
-:experimental:
-:sourcedir: .
-:toclevels: 3
-:sectnumlevels: 4
-
-:leveloffset: 1
-
-include::Book_Info.adoc[]
-
-:leveloffset: 0
-
-:leveloffset: 1
-
-include::Common_Content/Preface.adoc[]
-
-:leveloffset: 0
-
-:leveloffset: 1
-
-include::Chapter-Introduction.adoc[]
-
-:leveloffset: 0
-
-:leveloffset: 1
-
-include::ra-type/Chapter-Resource_Adaptor_Type.adoc[]
-
-:leveloffset: 0
-
-:leveloffset: 1
-
-include::ra/Chapter-Resource_Adaptor.adoc[]
-
-:leveloffset: 0
-
-:leveloffset: 1
-
-include::Chapter-Setup.adoc[]
-
-:leveloffset: 0
-
-:leveloffset: 1
-
-include::Revision_History.adoc[]
-
-:leveloffset: 0
+= User Guide to {this-platform} {this-application} {this-ra} RA {project-version} 
+:doctype: book
+:sectnums:
+:toc: left
+:icons: font
+:experimental:
+:sourcedir: .
+:toclevels: 3
+:sectnumlevels: 4
+
+:leveloffset: 1
+
+include::Book_Info.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
+include::Common_Content/Preface.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
+include::Chapter-Introduction.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
+include::ra-type/Chapter-Resource_Adaptor_Type.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
+include::ra/Chapter-Resource_Adaptor.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
+include::Chapter-Setup.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
+include::Chapter-Graceful_Stop.adoc[]
+
+:leveloffset: 0
+
+:leveloffset: 1
+
+include::Revision_History.adoc[]
+
+:leveloffset: 0
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;]>
+<!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,5 +1,8 @@
 <?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;]>
+<!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>
@@ -18,6 +21,19 @@
 					</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
@@ -1,30 +1,33 @@
-<?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" [
-]>
-
-<book>
-	<xi:include
-		href="Book_Info.xml"
-		xmlns:xi="http://www.w3.org/2001/XInclude" />
-	<xi:include
-		href="common/Preface.xml"
-		xmlns:xi="http://www.w3.org/2001/XInclude" />
-	<xi:include
-		xmlns:xi="http://www.w3.org/2001/XInclude"
-		href="Chapter-Introduction.xml" />
-	<xi:include
-		xmlns:xi="http://www.w3.org/2001/XInclude"
-		href="ra-type/Chapter-Resource_Adaptor_Type.xml" />
-	<xi:include
-		xmlns:xi="http://www.w3.org/2001/XInclude"
-		href="ra/Chapter-Resource_Adaptor.xml" />
-	<xi:include
-		xmlns:xi="http://www.w3.org/2001/XInclude"
-		href="Chapter-Setup.xml" />
-
-	<xi:include
-		href="Revision_History.xml"
-		xmlns:xi="http://www.w3.org/2001/XInclude" />
-	<index />
-</book>
-
+<?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" [
+]>
+
+<book>
+	<xi:include
+		href="Book_Info.xml"
+		xmlns:xi="http://www.w3.org/2001/XInclude" />
+	<xi:include
+		href="common/Preface.xml"
+		xmlns:xi="http://www.w3.org/2001/XInclude" />
+	<xi:include
+		xmlns:xi="http://www.w3.org/2001/XInclude"
+		href="Chapter-Introduction.xml" />
+	<xi:include
+		xmlns:xi="http://www.w3.org/2001/XInclude"
+		href="ra-type/Chapter-Resource_Adaptor_Type.xml" />
+	<xi:include
+		xmlns:xi="http://www.w3.org/2001/XInclude"
+		href="ra/Chapter-Resource_Adaptor.xml" />
+	<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"
+		xmlns:xi="http://www.w3.org/2001/XInclude" />
+	<index />
+</book>
+
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>2.8.0-SNAPSHOT</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>