IVIS-46: - Add chapter use API methods. - Fix Quick start chapter.

imCodePartnerAB · Nov 2, 2016 · 31d63dc · 31d63dc
1 parent 846fe2d
commit 31d63dc
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 9 deletions.
diff --git a/docs/quick_start/index.rst b/docs/quick_start/index.rst
@@ -6,4 +6,4 @@
 
    walkthrough_install_ivis_server
    walkthrough_ivis_server_conf
-   walkthrough_create_ivis_server_client_application
+   walkthrough_install_ivis_server_client_application
diff --git a/docs/quick_start/walkthrough_install_ivis_server.rst b/docs/quick_start/walkthrough_install_ivis_server.rst
@@ -87,9 +87,11 @@ In the Terminal (Ctrl+ALt+T) execute following commands:
 
 Go to project folder (/home/../iVIS/ivis-server/target).
 
-Find there file iVIS.war, rename to ivis.war.
+Find there file iVIS.war, rename to ROOT.war.
 
-Copy file to directory where you download Tomcat (/home/../apache-tomcat-{version}/webapps).
+Delete ROOT directory in Tomcat (/home/../apache-tomcat-{version}/webapps/ROOT)
+
+Copy file (ROOT.war) to directory where you download Tomcat (/home/../apache-tomcat-{version}/webapps).
 
 If you have process on port 8080 you must kill it by executing following command in the Terminal:
 

diff --git a/...create_ivis_server_client_application.rst → ...nstall_ivis_server_client_application.rst b/...create_ivis_server_client_application.rst → ...nstall_ivis_server_client_application.rst
@@ -1,5 +1,5 @@
-Walkthrough: Create iVIS Server Client Application
-==================================================
+Walkthrough: Install iVIS Server Client Application
+===================================================
 
 Prerequisites
 -------------

diff --git a/docs/sdk/routines.rst b/docs/sdk/routines.rst
@@ -10,4 +10,5 @@ And as conclusion we will create simple web application which calls iVIS API. So
     routines/configuration
     routines/login
     routines/tokens_flow
-    routines/access_to_protected_resources
+    routines/access_to_protected_resources
+    routines/use_api_methods
diff --git a/docs/sdk/routines/tokens_flow.rst b/docs/sdk/routines/tokens_flow.rst
@@ -15,18 +15,18 @@ And also refresh token value from access token object put in cookie.
 
 .. important::
 
-    Cookie has expiration time defined. It is defined by value refresh token validity seconds,
+    Cookie has expiration time. It is defined by value refresh token validity seconds,
     contact system administrator to know that.
 
 So tokens flow looks like
 
-    #. Client app login user (access token -> session, refresh token -> cookie with with expiration time).
+    #. Client app login user (access token -> session, refresh token -> cookie with expiration time).
     #. If token is expired (IvisOAuth2Utils.isTokenGood(httpServletRequest) -> exchange refresh token from cookie (cookie key "refreshToken") to access token.
     #. If cookie does not exist -> login user again.
 
 Let's see how it looks like.
 
-In IvisAuthorizationController.java for last two points let's defined method that will define what need to do with unauthorized users.
+In IvisAuthorizationController.java for last two points let's define method that will work with unauthorized users.
 
 :download:`IvisAuthorizationController.java </sdk/routines/code/IvisAuthorizationController.java>`
 
@@ -36,6 +36,8 @@ In IvisAuthorizationController.java for last two points let's defined method tha
     :lineno-start: 61
     :lines: 61-80
 
+As you can see this method also logout user from iVIS.
+
 .. note::
 
     Don't forget write information about error page in web.xml.

diff --git a/docs/sdk/routines/use_api_methods.rst b/docs/sdk/routines/use_api_methods.rst
@@ -0,0 +1,38 @@
+Use api methods
+===============
+
+.. important::
+
+    You can use API method only if admin check permission for that method for client and user (result it is a cross of permissions).
+
+First you need get iVIS service factory from request.
+
+.. code-block:: java
+
+    HttpServletRequest request = ... ; // get HttpServletRequest
+    IvisServiceFactory ivisServiceFactory = IvisOAuth2Utils.getServiceFactory(request);
+
+.. note::
+
+    If service factory invokes first time it wil create service factory in user session context.
+
+Next uses exist IvisServiceFactory instance need get service for specific entity.
+
+.. code-block:: java
+
+    //for example you need ApplicationService
+    ApplicationService applicationService = ivisServiceFactory.getService(ApplicationService.class);
+
+And then just invoke API methods like Java methods.
+
+.. code-block:: java
+
+    List<Application> allApplications = applicationService.findAll();
+
+.. tip::
+
+    How to know what concrete method needs? Just see service interface methods: name, in parameters and return type.
+
+
+
+