Initial OpenECOMP Portal SDK commit

Change-Id: I66a3491600a4b9ea241128dc29267eed6a78ed76
Signed-off-by: talasila <talasila@research.att.com>

1 files changed, 23 insertions, 0 deletions

diff --git a/ecomp-sdk/thirdparty/README.md b/ecomp-sdk/thirdparty/README.md
new file mode 100644
index 00000000..f916e99f
--- /dev/null
+++ b/ecomp-sdk/thirdparty/README.md
@@ -0,0 +1,23 @@
+ECOMP Portal SDK Framework
+==========================
+
+This is the Maven project for the ECOMP Portal SDK Framework,
+which is distributed as ecompFW-nnn.jar.  This library 
+(formerly called third-party onboarding) provides features to 
+partner applications that use a J2EE Servlet 3.0 container
+as Apache Tomcat.  These features include:
+- REST endpoint for use by the ECOMP Portal aplication. This endpoint 
+  answers queries about roles, users and user-role assignments. 
+  The endpoint methods are defined by the Java interface class 
+  IPortalRestAPIService. Application developers must provide a 
+  class that implements this interface, and publish the name of 
+  that class in the properties file as discussed below.
+- A session listener that updates a collection with current user sessions 
+  as sessions are created and destroyed. This information is used to maintain 
+  and extend user session timeouts across applications that are on-boarded to 
+  the ECOMP portal.
+- Communication with the ECOMP Portal to fetch a user-specific functional menu, either
+  via REST or UEB.
+  
+Unlike the other ECOMP SDK libraries, this library does NOT require Hibernate, 
+nor does it require Spring.
\ No newline at end of file