File: soapservices.html

package info (click to toggle)
lemonldap-ng 1.9.7-3%2Bdeb9u2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 39,024 kB
  • sloc: perl: 37,552; makefile: 922; sh: 472; sql: 5
file content (145 lines) | stat: -rw-r--r-- 7,619 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
  <meta charset="utf-8" />
  <title>documentation:1.9:soapservices</title>
<meta name="generator" content="DokuWiki"/>
<meta name="robots" content="index,follow"/>
<meta name="keywords" content="documentation,1.9,soapservices"/>
<link rel="search" type="application/opensearchdescription+xml" href="lib/exe/opensearch.html" title="LemonLDAP::NG"/>
<link rel="start" href="soapservices.html"/>
<link rel="contents" href="soapservices.html" title="Sitemap"/>
<link rel="stylesheet" type="text/css" href="lib/exe/css.php.t.bootstrap3.css"/>
<!-- //if:usedebianlibs
  <link rel="stylesheet" type="text/css" href="/javascript/bootstrap/css/bootstrap.min.css" />
//elsif:useexternallibs
  <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"></script>
//elsif:cssminified
  <link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.min.css" />
//else -->
  <link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.css" />
<!-- //endif -->
<script type="text/javascript">/*<![CDATA[*/var NS='documentation:1.9';var JSINFO = {"id":"documentation:1.9:soapservices","namespace":"documentation:1.9"};
/*!]]>*/</script>
<script type="text/javascript" charset="utf-8" src="lib/exe/js.php.t.bootstrap3.js"></script>
<!-- //if:usedebianlibs
<script type="text/javascript" src="/javascript/jquery/jquery.min.js"></script>
//elsif:useexternallibs
<script type="text/javascript" src="http://code.jquery.com/jquery-2.2.0.min.js"></script>
//elsif:jsminified
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.min.js"></script>
//else -->
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.js"></script>
<!-- //endif -->
<!-- //if:usedebianlibs
  <script type="text/javascript" src="/javascript/jquery-ui/jquery-ui.min.js"></script>
//elsif:useexternallibs
  <script type="text/javascript" src="http://code.jquery.com/ui/1.10.4/jquery-ui.min.js"></script>
//elsif:jsminified
  <script type="text/javascript" src="/lib/scripts/jquery-ui.min.js"></script>
//else -->
  <script type="text/javascript" src="/lib/scripts/jquery-ui.js"></script>
<!-- //endif -->
</head>
<body>
<div class="dokuwiki export container">

<h1 class="sectionedit1" id="soap_services">SOAP services</h1>
<div class="level1">

<p>
Lemonldap::NG provides 2 SOAP servers :
</p>
<ul>
<li class="level1"><div class="li"> the <a href="portal.html" class="wikilink1" title="documentation:1.9:portal">portal</a></div>
</li>
<li class="level1"><div class="li"> the manager (for internal use only)</div>
</li>
</ul>

</div>
<!-- EDIT1 SECTION "SOAP services" [1-129] -->
<h2 class="sectionedit2" id="portal_soap_services">Portal SOAP services</h2>
<div class="level2">

<p>
SOAP functions are not accessible by network by default. SOAP functions are protected by Apache, you can change this in <a href="configlocation.html#portal" class="wikilink1" title="documentation:1.9:configlocation">Apache portal configuration</a>:
</p>
<pre class="code file apache">    <span class="co1"># SOAP functions for sessions management (disabled by default)</span>
    &lt;<span class="kw3">Location</span> /index.pl/adminSessions&gt;
        <span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span>
        <span class="kw1">Allow</span> from <span class="kw2">all</span>
    &lt;/<span class="kw3">Location</span>&gt;
&nbsp;
    <span class="co1"># SOAP functions for sessions access (disabled by default)</span>
    &lt;<span class="kw3">Location</span> /index.pl/sessions&gt;
        <span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span>
        <span class="kw1">Allow</span> from <span class="kw2">all</span>
    &lt;/<span class="kw3">Location</span>&gt;
&nbsp;
    <span class="co1"># SOAP functions for configuration access (disabled by default)</span>
    &lt;<span class="kw3">Location</span> /index.pl/config&gt;
        <span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span>
        <span class="kw1">Allow</span> from <span class="kw2">all</span>
    &lt;/<span class="kw3">Location</span>&gt;
&nbsp;
    <span class="co1"># SOAP functions for notification insertion (disabled by default)</span>
    &lt;<span class="kw3">Location</span> /index.pl/notification&gt;
        <span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span>
        <span class="kw1">Allow</span> from <span class="kw2">all</span>
    &lt;/<span class="kw3">Location</span>&gt;</pre>
<div class="notetip">You can create a SOAP only portal by setting “soapOnly = 1” in lemonldap-ng.ini (section PORTAL)
</div><ul>
<li class="level1"><div class="li"> Read-only functions (index.pl/sessions or index.pl/adminSessions paths):</div>
<ul>
<li class="level2"><div class="li"> <strong>getCookies(user,password)</strong>: authentication system. Returns cookie(s) name and values</div>
</li>
<li class="level2"><div class="li"> <strong>getAttributes(cookieValue)</strong>: get elements stored in session</div>
</li>
<li class="level2"><div class="li"> <strong>isAuthorizedURI(cookieValue,url)</strong>: check if user is granted to access to the function</div>
</li>
<li class="level2"><div class="li"> <strong>getMenuApplications(cookieValue)</strong>: return a list of authorizated applications (based on menu calculation)</div>
</li>
</ul>
</li>
<li class="level1"><div class="li"> Read/Write functions (index.pl/adminSessions paths):</div>
<ul>
<li class="level2"><div class="li"> <strong>setAttributes(cookieValue,hashtable)</strong>: update a session</div>
</li>
<li class="level2"><div class="li"> <strong>newSession</strong>: create a session (return attributes)</div>
</li>
<li class="level2"><div class="li"> <strong>deleteSession</strong>: delete a session</div>
</li>
<li class="level2"><div class="li"> <strong>get_key_from_all_sessions</strong>: list all sessions and return asked keys</div>
</li>
</ul>
</li>
<li class="level1"><div class="li"> Notification send function (index.pl/notification):</div>
<ul>
<li class="level2"><div class="li"> <strong>newNotification(xmlString)</strong>: insert a notification for a user (see <a href="notifications.html" class="wikilink1" title="documentation:1.9:notifications">Notifications system</a> for more)</div>
</li>
</ul>
</li>
<li class="level1"><div class="li"> Notification delete function:</div>
<ul>
<li class="level2"><div class="li"> <strong>deleteNotification</strong>: delete notification(s) for a user (see <a href="notifications.html" class="wikilink1" title="documentation:1.9:notifications">Notifications system</a> for more)</div>
</li>
</ul>
</li>
</ul>
<div class="noteimportant">When you use <a href="soapsessionbackend.html" class="wikilink1" title="documentation:1.9:soapsessionbackend">SOAP sessions backend</a>, it is recommended to use read-only <abbr title="Uniform Resource Locator">URL</abbr> (<a href="http://portal/index.pl/sessions" class="urlextern" title="http://portal/index.pl/sessions"  rel="nofollow">http://portal/index.pl/sessions</a>). Write session path is needed only if you use a remote session explorer or a remote portal

</div>
</div>
<!-- EDIT2 SECTION "Portal SOAP services" [130-2479] -->
<h2 class="sectionedit3" id="wsdl_file">WSDL file</h2>
<div class="level2">

<p>
When portal is installed, a file named portal.wsdl is created. It can be upgraded using buildPortalWSDL script.
</p>

</div>
<!-- EDIT3 SECTION "WSDL file" [2480-] --></div>
</body>
</html>