source: TI12-security/trunk/documentation/epydoc/ndg.security.common.SessionMgr.SessionMgrClient-class.html @ 4245

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI12-security/trunk/documentation/epydoc/ndg.security.common.SessionMgr.SessionMgrClient-class.html@4245
Revision 4245, 52.8 KB checked in by pjkersha, 11 years ago (diff)

Working unit tests for WSGI based Attribute Authority.

  • Altered so that all Attribute Config is picked up from the Paste ini file. Separate cfg or xml based config file is still supported.

TODO:

  • Simplify unit test config for client.
Line 
1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>ndg.security.common.SessionMgr.SessionMgrClient</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8  <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12      alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15       bgcolor="#a0c0ff" cellspacing="0">
16  <tr valign="middle">
17  <!-- Home link -->
18      <th>&nbsp;&nbsp;&nbsp;<a
19        href="ndg-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21  <!-- Tree link -->
22      <th>&nbsp;&nbsp;&nbsp;<a
23        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25  <!-- Index link -->
26      <th>&nbsp;&nbsp;&nbsp;<a
27        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29  <!-- Help link -->
30      <th>&nbsp;&nbsp;&nbsp;<a
31        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33  <!-- Project homepage -->
34      <th class="navbar" align="right" width="100%">
35        <table border="0" cellpadding="0" cellspacing="0">
36          <tr><th class="navbar" align="center"
37            >NDG Security</th>
38          </tr></table></th>
39  </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42  <tr valign="top">
43    <td width="100%">
44      <span class="breadcrumbs">
45        <a href="ndg-module.html">Package&nbsp;ndg</a> ::
46        <a href="ndg.security-module.html">Package&nbsp;security</a> ::
47        <a href="ndg.security.common-module.html">Package&nbsp;common</a> ::
48        <a href="ndg.security.common.SessionMgr-module.html">Package&nbsp;SessionMgr</a> ::
49        Class&nbsp;SessionMgrClient
50      </span>
51    </td>
52    <td>
53      <table cellpadding="0" cellspacing="0">
54        <!-- hide/show private -->
55        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57      </table>
58    </td>
59  </tr>
60</table>
61<!-- ==================== CLASS DESCRIPTION ==================== -->
62<h1 class="epydoc">Class SessionMgrClient</h1><p class="nomargin-top"><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient">source&nbsp;code</a></span></p>
63<center>
64<center>  <map id="uml_class_diagram_for_ndg_secu_59" name="uml_class_diagram_for_ndg_secu_59">
65<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#excepMap" title="map exception strings returned from SOAP fault to client Exception class to call" alt="" coords="17,28,1228,47"/>
66<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#uri" title="ndg.security.common.SessionMgr.SessionMgrClient.uri" alt="" coords="17,47,1228,66"/>
67<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#httpProxyHost" title="ndg.security.common.SessionMgr.SessionMgrClient.httpProxyHost" alt="" coords="17,66,1228,84"/>
68<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#noHttpProxyList" title="ndg.security.common.SessionMgr.SessionMgrClient.noHttpProxyList" alt="" coords="17,84,1228,103"/>
69<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#sslPeerCertCN" title="ndg.security.common.SessionMgr.SessionMgrClient.sslPeerCertCN" alt="" coords="17,103,1228,122"/>
70<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#sslCACertList" title="ndg.security.common.SessionMgr.SessionMgrClient.sslCACertList" alt="" coords="17,122,1228,140"/>
71<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#sslCACertFilePathList" title="ndg.security.common.SessionMgr.SessionMgrClient.sslCACertFilePathList" alt="" coords="17,140,1228,159"/>
72<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#signatureHandler" title="ndg.security.common.SessionMgr.SessionMgrClient.signatureHandler" alt="" coords="17,159,1228,178"/>
73<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,180,1228,199"/>
74<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#initService" title="Set the WS client for the Session Manager" alt="" coords="17,199,1228,218"/>
75<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#connect" title="Request a new user session from the Session Manager" alt="" coords="17,218,1228,236"/>
76<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#disconnect" title="Delete an existing user session from the Session Manager" alt="" coords="17,236,1228,255"/>
77<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#getSessionStatus" title="Check for the existence of a session with a given session ID / user &#160;certificate Distinguished Name" alt="" coords="17,255,1228,274"/>
78<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#getAttCert" title="Request NDG Session Manager Web Service to retrieve an Attribute &#160;Certificate from the given Attribute Authority and cache it in the user&#39;s &#160;credential wallet held by the session manager." alt="" coords="17,274,1228,292"/>
79<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html#getX509Cert" title="Retrieve the public key of the Session Manager" alt="" coords="17,292,1228,311"/>
80<area shape="rect" href="ndg.security.common.SessionMgr.SessionMgrClient&#45;class.html" title="Client interface to Session Manager Web Service" alt="" coords="16,11,1229,312"/>
81</map>
82  <img src="uml_class_diagram_for_ndg_secu_59.gif" alt='' usemap="#uml_class_diagram_for_ndg_secu_59" ismap="ismap" class="graph-without-title" />
83</center>
84</center>
85<hr />
86<p>Client interface to Session Manager Web Service</p>
87
88<!-- ==================== INSTANCE METHODS ==================== -->
89<a name="section-InstanceMethods"></a>
90<table class="summary" border="1" cellpadding="3"
91       cellspacing="0" width="100%" bgcolor="white">
92<tr bgcolor="#70b0f0" class="table-header">
93  <td colspan="2" class="table-header">
94    <table border="0" cellpadding="0" cellspacing="0" width="100%">
95      <tr valign="top">
96        <td align="left"><span class="table-header">Instance Methods</span></td>
97        <td align="right" valign="top"
98         ><span class="options">[<a href="#section-InstanceMethods"
99         class="privatelink" onclick="toggle_private();"
100         >hide private</a>]</span></td>
101      </tr>
102    </table>
103  </td>
104</tr>
105<tr>
106    <td width="15%" align="right" valign="top" class="summary">
107      <span class="summary-type">&nbsp;</span>
108    </td><td class="summary">
109      <table width="100%" cellpadding="0" cellspacing="0" border="0">
110        <tr>
111          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
112        <span class="summary-sig-arg">uri</span>=<span class="summary-sig-default">None</span>,
113        <span class="summary-sig-arg">tracefile</span>=<span class="summary-sig-default">None</span>,
114        <span class="summary-sig-arg">httpProxyHost</span>=<span class="summary-sig-default">None</span>,
115        <span class="summary-sig-arg">noHttpProxyList</span>=<span class="summary-sig-default">False</span>,
116        <span class="summary-sig-arg">sslCACertList</span>=<span class="summary-sig-default">[]</span>,
117        <span class="summary-sig-arg">sslCACertFilePathList</span>=<span class="summary-sig-default">[]</span>,
118        <span class="summary-sig-arg">sslPeerCertCN</span>=<span class="summary-sig-default">None</span>,
119        <span class="summary-sig-arg">setSignatureHandler</span>=<span class="summary-sig-default">True</span>,
120        <span class="summary-sig-arg">**signatureHandlerKw</span>)</span><br />
121      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
122          <td align="right" valign="top">
123            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__init__">source&nbsp;code</a></span>
124           
125          </td>
126        </tr>
127      </table>
128     
129    </td>
130  </tr>
131<tr class="private">
132    <td width="15%" align="right" valign="top" class="summary">
133      <span class="summary-type">&nbsp;</span>
134    </td><td class="summary">
135      <table width="100%" cellpadding="0" cellspacing="0" border="0">
136        <tr>
137          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#__setURI" class="summary-sig-name" onclick="show_private();">__setURI</a>(<span class="summary-sig-arg">self</span>,
138        <span class="summary-sig-arg">uri</span>)</span><br />
139      Set URI for service</td>
140          <td align="right" valign="top">
141            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setURI">source&nbsp;code</a></span>
142           
143          </td>
144        </tr>
145      </table>
146     
147    </td>
148  </tr>
149<tr class="private">
150    <td width="15%" align="right" valign="top" class="summary">
151      <span class="summary-type">string</span>
152    </td><td class="summary">
153      <table width="100%" cellpadding="0" cellspacing="0" border="0">
154        <tr>
155          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#__getURI" class="summary-sig-name" onclick="show_private();">__getURI</a>(<span class="summary-sig-arg">self</span>)</span><br />
156      Get URI for service</td>
157          <td align="right" valign="top">
158            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__getURI">source&nbsp;code</a></span>
159           
160          </td>
161        </tr>
162      </table>
163     
164    </td>
165  </tr>
166<tr class="private">
167    <td width="15%" align="right" valign="top" class="summary">
168      <span class="summary-type">&nbsp;</span>
169    </td><td class="summary">
170      <table width="100%" cellpadding="0" cellspacing="0" border="0">
171        <tr>
172          <td><span class="summary-sig"><a name="__setHTTPProxyHost"></a><span class="summary-sig-name">__setHTTPProxyHost</span>(<span class="summary-sig-arg">self</span>,
173        <span class="summary-sig-arg">val</span>)</span><br />
174      Set a HTTP Proxy host overriding any http_proxy environment variable
175      setting</td>
176          <td align="right" valign="top">
177            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setHTTPProxyHost">source&nbsp;code</a></span>
178           
179          </td>
180        </tr>
181      </table>
182     
183    </td>
184  </tr>
185<tr class="private">
186    <td width="15%" align="right" valign="top" class="summary">
187      <span class="summary-type">&nbsp;</span>
188    </td><td class="summary">
189      <table width="100%" cellpadding="0" cellspacing="0" border="0">
190        <tr>
191          <td><span class="summary-sig"><a name="__setNoHttpProxyList"></a><span class="summary-sig-name">__setNoHttpProxyList</span>(<span class="summary-sig-arg">self</span>,
192        <span class="summary-sig-arg">val</span>)</span><br />
193      Set to list of hosts for which to ignore the HTTP Proxy setting</td>
194          <td align="right" valign="top">
195            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setNoHttpProxyList">source&nbsp;code</a></span>
196           
197          </td>
198        </tr>
199      </table>
200     
201    </td>
202  </tr>
203<tr class="private">
204    <td width="15%" align="right" valign="top" class="summary">
205      <span class="summary-type">&nbsp;</span>
206    </td><td class="summary">
207      <table width="100%" cellpadding="0" cellspacing="0" border="0">
208        <tr>
209          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#__setSSLPeerCertCN" class="summary-sig-name" onclick="show_private();">__setSSLPeerCertCN</a>(<span class="summary-sig-arg">self</span>,
210        <span class="summary-sig-arg">cn</span>)</span><br />
211      For use with HTTPS connections only.</td>
212          <td align="right" valign="top">
213            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setSSLPeerCertCN">source&nbsp;code</a></span>
214           
215          </td>
216        </tr>
217      </table>
218     
219    </td>
220  </tr>
221<tr class="private">
222    <td width="15%" align="right" valign="top" class="summary">
223      <span class="summary-type">&nbsp;</span>
224    </td><td class="summary">
225      <table width="100%" cellpadding="0" cellspacing="0" border="0">
226        <tr>
227          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#__setSSLCACertList" class="summary-sig-name" onclick="show_private();">__setSSLCACertList</a>(<span class="summary-sig-arg">self</span>,
228        <span class="summary-sig-arg">caCertList</span>)</span><br />
229      For use with HTTPS connections only.</td>
230          <td align="right" valign="top">
231            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setSSLCACertList">source&nbsp;code</a></span>
232           
233          </td>
234        </tr>
235      </table>
236     
237    </td>
238  </tr>
239<tr class="private">
240    <td width="15%" align="right" valign="top" class="summary">
241      <span class="summary-type">&nbsp;</span>
242    </td><td class="summary">
243      <table width="100%" cellpadding="0" cellspacing="0" border="0">
244        <tr>
245          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#__setSSLCACertFilePathList" class="summary-sig-name" onclick="show_private();">__setSSLCACertFilePathList</a>(<span class="summary-sig-arg">self</span>,
246        <span class="summary-sig-arg">caCertFilePathList</span>)</span><br />
247      For use with HTTPS connections only.</td>
248          <td align="right" valign="top">
249            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setSSLCACertFilePathList">source&nbsp;code</a></span>
250           
251          </td>
252        </tr>
253      </table>
254     
255    </td>
256  </tr>
257<tr class="private">
258    <td width="15%" align="right" valign="top" class="summary">
259      <span class="summary-type">&nbsp;</span>
260    </td><td class="summary">
261      <table width="100%" cellpadding="0" cellspacing="0" border="0">
262        <tr>
263          <td><span class="summary-sig"><a name="__setSignatureHandler"></a><span class="summary-sig-name">__setSignatureHandler</span>(<span class="summary-sig-arg">self</span>,
264        <span class="summary-sig-arg">signatureHandler</span>)</span><br />
265      Set SignatureHandler object property method - set to None to for no
266      digital signature and verification</td>
267          <td align="right" valign="top">
268            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setSignatureHandler">source&nbsp;code</a></span>
269           
270          </td>
271        </tr>
272      </table>
273     
274    </td>
275  </tr>
276<tr class="private">
277    <td width="15%" align="right" valign="top" class="summary">
278      <span class="summary-type">&nbsp;</span>
279    </td><td class="summary">
280      <table width="100%" cellpadding="0" cellspacing="0" border="0">
281        <tr>
282          <td><span class="summary-sig"><a name="__getSignatureHandler"></a><span class="summary-sig-name">__getSignatureHandler</span>(<span class="summary-sig-arg">self</span>)</span><br />
283      Get SignatureHandler object property method</td>
284          <td align="right" valign="top">
285            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__getSignatureHandler">source&nbsp;code</a></span>
286           
287          </td>
288        </tr>
289      </table>
290     
291    </td>
292  </tr>
293<tr>
294    <td width="15%" align="right" valign="top" class="summary">
295      <span class="summary-type">&nbsp;</span>
296    </td><td class="summary">
297      <table width="100%" cellpadding="0" cellspacing="0" border="0">
298        <tr>
299          <td><span class="summary-sig"><a name="initService"></a><span class="summary-sig-name">initService</span>(<span class="summary-sig-arg">self</span>,
300        <span class="summary-sig-arg">uri</span>=<span class="summary-sig-default">None</span>)</span><br />
301      Set the WS client for the Session Manager</td>
302          <td align="right" valign="top">
303            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.initService">source&nbsp;code</a></span>
304           
305          </td>
306        </tr>
307      </table>
308     
309    </td>
310  </tr>
311<tr>
312    <td width="15%" align="right" valign="top" class="summary">
313      <span class="summary-type">tuple @return user cert, user private key, issuing cert and sessID
314      all as strings but sessID will be None if the createServerSess
315      keyword is False</span>
316    </td><td class="summary">
317      <table width="100%" cellpadding="0" cellspacing="0" border="0">
318        <tr>
319          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
320        <span class="summary-sig-arg">username</span>,
321        <span class="summary-sig-arg">passphrase</span>=<span class="summary-sig-default">None</span>,
322        <span class="summary-sig-arg">passphraseFilePath</span>=<span class="summary-sig-default">None</span>,
323        <span class="summary-sig-arg">createServerSess</span>=<span class="summary-sig-default">True</span>)</span><br />
324      Request a new user session from the Session Manager</td>
325          <td align="right" valign="top">
326            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.connect">source&nbsp;code</a></span>
327           
328          </td>
329        </tr>
330      </table>
331     
332    </td>
333  </tr>
334<tr>
335    <td width="15%" align="right" valign="top" class="summary">
336      <span class="summary-type">&nbsp;</span>
337    </td><td class="summary">
338      <table width="100%" cellpadding="0" cellspacing="0" border="0">
339        <tr>
340          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>,
341        <span class="summary-sig-arg">userCert</span>=<span class="summary-sig-default">None</span>,
342        <span class="summary-sig-arg">sessID</span>=<span class="summary-sig-default">None</span>)</span><br />
343      Delete an existing user session from the Session Manager</td>
344          <td align="right" valign="top">
345            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.disconnect">source&nbsp;code</a></span>
346           
347          </td>
348        </tr>
349      </table>
350     
351    </td>
352  </tr>
353<tr>
354    <td width="15%" align="right" valign="top" class="summary">
355      <span class="summary-type">&nbsp;</span>
356    </td><td class="summary">
357      <table width="100%" cellpadding="0" cellspacing="0" border="0">
358        <tr>
359          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#getSessionStatus" class="summary-sig-name">getSessionStatus</a>(<span class="summary-sig-arg">self</span>,
360        <span class="summary-sig-arg">userDN</span>=<span class="summary-sig-default">None</span>,
361        <span class="summary-sig-arg">sessID</span>=<span class="summary-sig-default">None</span>)</span><br />
362      Check for the existence of a session with a given session ID / user
363      certificate Distinguished Name</td>
364          <td align="right" valign="top">
365            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.getSessionStatus">source&nbsp;code</a></span>
366           
367          </td>
368        </tr>
369      </table>
370     
371    </td>
372  </tr>
373<tr>
374    <td width="15%" align="right" valign="top" class="summary">
375      <span class="summary-type">ndg.security.common.AttCert.AttCert</span>
376    </td><td class="summary">
377      <table width="100%" cellpadding="0" cellspacing="0" border="0">
378        <tr>
379          <td><span class="summary-sig"><a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#getAttCert" class="summary-sig-name">getAttCert</a>(<span class="summary-sig-arg">self</span>,
380        <span class="summary-sig-arg">userCert</span>=<span class="summary-sig-default">None</span>,
381        <span class="summary-sig-arg">sessID</span>=<span class="summary-sig-default">None</span>,
382        <span class="summary-sig-arg">attAuthorityURI</span>=<span class="summary-sig-default">None</span>,
383        <span class="summary-sig-arg">attAuthorityCert</span>=<span class="summary-sig-default">None</span>,
384        <span class="summary-sig-arg">reqRole</span>=<span class="summary-sig-default">None</span>,
385        <span class="summary-sig-arg">mapFromTrustedHosts</span>=<span class="summary-sig-default">True</span>,
386        <span class="summary-sig-arg">rtnExtAttCertList</span>=<span class="summary-sig-default">False</span>,
387        <span class="summary-sig-arg">extAttCertList</span>=<span class="summary-sig-default">[]</span>,
388        <span class="summary-sig-arg">extTrustedHostList</span>=<span class="summary-sig-default">[]</span>)</span><br />
389      Request NDG Session Manager Web Service to retrieve an Attribute
390      Certificate from the given Attribute Authority and cache it in the
391      user's credential wallet held by the session manager.</td>
392          <td align="right" valign="top">
393            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.getAttCert">source&nbsp;code</a></span>
394           
395          </td>
396        </tr>
397      </table>
398     
399    </td>
400  </tr>
401<tr>
402    <td width="15%" align="right" valign="top" class="summary">
403      <span class="summary-type">&nbsp;</span>
404    </td><td class="summary">
405      <table width="100%" cellpadding="0" cellspacing="0" border="0">
406        <tr>
407          <td><span class="summary-sig"><a name="getX509Cert"></a><span class="summary-sig-name">getX509Cert</span>(<span class="summary-sig-arg">self</span>)</span><br />
408      Retrieve the public key of the Session Manager</td>
409          <td align="right" valign="top">
410            <span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.getX509Cert">source&nbsp;code</a></span>
411           
412          </td>
413        </tr>
414      </table>
415     
416    </td>
417  </tr>
418  <tr>
419    <td colspan="2" class="summary">
420    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
421      <code>__delattr__</code>,
422      <code>__getattribute__</code>,
423      <code>__hash__</code>,
424      <code>__new__</code>,
425      <code>__reduce__</code>,
426      <code>__reduce_ex__</code>,
427      <code>__repr__</code>,
428      <code>__setattr__</code>,
429      <code>__str__</code>
430      </p>
431    </td>
432  </tr>
433</table>
434<!-- ==================== CLASS VARIABLES ==================== -->
435<a name="section-ClassVariables"></a>
436<table class="summary" border="1" cellpadding="3"
437       cellspacing="0" width="100%" bgcolor="white">
438<tr bgcolor="#70b0f0" class="table-header">
439  <td colspan="2" class="table-header">
440    <table border="0" cellpadding="0" cellspacing="0" width="100%">
441      <tr valign="top">
442        <td align="left"><span class="table-header">Class Variables</span></td>
443        <td align="right" valign="top"
444         ><span class="options">[<a href="#section-ClassVariables"
445         class="privatelink" onclick="toggle_private();"
446         >hide private</a>]</span></td>
447      </tr>
448    </table>
449  </td>
450</tr>
451<tr>
452    <td width="15%" align="right" valign="top" class="summary">
453      <span class="summary-type">dict</span>
454    </td><td class="summary">
455        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#excepMap" class="summary-name">excepMap</a> = <code title="{'SessionNotFound': SessionNotFound, 'UserSessionX509CertNotBeforeTime\
456Error': SessionCertTimeError, 'UserSessionExpired': SessionExpired, 'I\
457nvalidUserSession': InvalidSession}">{'SessionNotFound': SessionNotFound, 'UserSessionX5<code class="variable-ellipsis">...</code></code><br />
458      map exception strings returned from SOAP fault to client Exception
459      class to call
460    </td>
461  </tr>
462<tr>
463    <td width="15%" align="right" valign="top" class="summary">
464      <span class="summary-type">&nbsp;</span>
465    </td><td class="summary">
466        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#uri" class="summary-name">uri</a> = <code title="property(fset= __setURI, fget= __getURI, doc= &quot;Session Manager URI&quot;)">property(fset= __setURI, fget= __getURI, doc= &quot;Session M<code class="variable-ellipsis">...</code></code>
467    </td>
468  </tr>
469<tr>
470    <td width="15%" align="right" valign="top" class="summary">
471      <span class="summary-type">&nbsp;</span>
472    </td><td class="summary">
473        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#httpProxyHost" class="summary-name">httpProxyHost</a> = <code title="property(fset= __setHTTPProxyHost, doc= &quot;HTTP Proxy hostname - overrid\
474es any http_proxy env var setting&quot;)">property(fset= __setHTTPProxyHost, doc= &quot;HTTP <code class="variable-ellipsis">...</code></code>
475    </td>
476  </tr>
477<tr>
478    <td width="15%" align="right" valign="top" class="summary">
479      <span class="summary-type">&nbsp;</span>
480    </td><td class="summary">
481        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#noHttpProxyList" class="summary-name">noHttpProxyList</a> = <code title="property(fset= __setNoHttpProxyList, doc= &quot;Set to list of hosts for wh\
482ich to ignore the HTTP Proxy setting&quot;)">property(fset= __setNoHttpProxyList, doc= &quot;S<code class="variable-ellipsis">...</code></code>
483    </td>
484  </tr>
485<tr>
486    <td width="15%" align="right" valign="top" class="summary">
487      <span class="summary-type">&nbsp;</span>
488    </td><td class="summary">
489        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#sslPeerCertCN" class="summary-name">sslPeerCertCN</a> = <code title="property(fset= __setSSLPeerCertCN, doc= &quot;for https connections, set CN\
490 of peer cert if other than peer hostname&quot;)">property(fset= __setSSLPeerCertCN, doc= &quot;for h<code class="variable-ellipsis">...</code></code>
491    </td>
492  </tr>
493<tr>
494    <td width="15%" align="right" valign="top" class="summary">
495      <span class="summary-type">&nbsp;</span>
496    </td><td class="summary">
497        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#sslCACertList" class="summary-name">sslCACertList</a> = <code title="property(fset= __setSSLCACertList, doc= &quot;for https connections, set li\
498st of CA certs from which to verify peer cert&quot;)">property(fset= __setSSLCACertList, doc= &quot;for h<code class="variable-ellipsis">...</code></code>
499    </td>
500  </tr>
501<tr>
502    <td width="15%" align="right" valign="top" class="summary">
503      <span class="summary-type">&nbsp;</span>
504    </td><td class="summary">
505        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#sslCACertFilePathList" class="summary-name">sslCACertFilePathList</a> = <code title="property(fset= __setSSLCACertFilePathList, doc= &quot;for https connections\
506, set list of CA cert files from which to verify peer cert&quot;)">property(fset= __setSSLCACertFilePathL<code class="variable-ellipsis">...</code></code>
507    </td>
508  </tr>
509<tr>
510    <td width="15%" align="right" valign="top" class="summary">
511      <span class="summary-type">&nbsp;</span>
512    </td><td class="summary">
513        <a href="ndg.security.common.SessionMgr.SessionMgrClient-class.html#signatureHandler" class="summary-name">signatureHandler</a> = <code title="property(fget= __getSignatureHandler, fset= __setSignatureHandler, doc\
514= &quot;SignatureHandler object&quot;)">property(fget= __getSignatureHandler, fset=<code class="variable-ellipsis">...</code></code>
515    </td>
516  </tr>
517</table>
518<!-- ==================== PROPERTIES ==================== -->
519<a name="section-Properties"></a>
520<table class="summary" border="1" cellpadding="3"
521       cellspacing="0" width="100%" bgcolor="white">
522<tr bgcolor="#70b0f0" class="table-header">
523  <td colspan="2" class="table-header">
524    <table border="0" cellpadding="0" cellspacing="0" width="100%">
525      <tr valign="top">
526        <td align="left"><span class="table-header">Properties</span></td>
527        <td align="right" valign="top"
528         ><span class="options">[<a href="#section-Properties"
529         class="privatelink" onclick="toggle_private();"
530         >hide private</a>]</span></td>
531      </tr>
532    </table>
533  </td>
534</tr>
535  <tr>
536    <td colspan="2" class="summary">
537    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
538      <code>__class__</code>
539      </p>
540    </td>
541  </tr>
542</table>
543<!-- ==================== METHOD DETAILS ==================== -->
544<a name="section-MethodDetails"></a>
545<table class="details" border="1" cellpadding="3"
546       cellspacing="0" width="100%" bgcolor="white">
547<tr bgcolor="#70b0f0" class="table-header">
548  <td colspan="2" class="table-header">
549    <table border="0" cellpadding="0" cellspacing="0" width="100%">
550      <tr valign="top">
551        <td align="left"><span class="table-header">Method Details</span></td>
552        <td align="right" valign="top"
553         ><span class="options">[<a href="#section-MethodDetails"
554         class="privatelink" onclick="toggle_private();"
555         >hide private</a>]</span></td>
556      </tr>
557    </table>
558  </td>
559</tr>
560</table>
561<a name="__init__"></a>
562<div>
563<table class="details" border="1" cellpadding="3"
564       cellspacing="0" width="100%" bgcolor="white">
565<tr><td>
566  <table width="100%" cellpadding="0" cellspacing="0" border="0">
567  <tr valign="top"><td>
568  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
569        <span class="sig-arg">uri</span>=<span class="sig-default">None</span>,
570        <span class="sig-arg">tracefile</span>=<span class="sig-default">None</span>,
571        <span class="sig-arg">httpProxyHost</span>=<span class="sig-default">None</span>,
572        <span class="sig-arg">noHttpProxyList</span>=<span class="sig-default">False</span>,
573        <span class="sig-arg">sslCACertList</span>=<span class="sig-default">[]</span>,
574        <span class="sig-arg">sslCACertFilePathList</span>=<span class="sig-default">[]</span>,
575        <span class="sig-arg">sslPeerCertCN</span>=<span class="sig-default">None</span>,
576        <span class="sig-arg">setSignatureHandler</span>=<span class="sig-default">True</span>,
577        <span class="sig-arg">**signatureHandlerKw</span>)</span>
578    <br /><em class="fname">(Constructor)</em>
579  </h3>
580  </td><td align="right" valign="top"
581    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__init__">source&nbsp;code</a></span>&nbsp;
582    </td>
583  </tr></table>
584 
585  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for
586  signature</p>
587  <dl class="fields">
588    <dt>Parameters:</dt>
589    <dd><ul class="nomargin-top">
590        <li><strong class="pname"><code>uri</code></strong> (string) - URI for Session Manager WS.  Setting it will set the Service user</li>
591        <li><strong class="pname"><code>tracefile</code></strong> (file stream type) - set to file object such as sys.stderr to give extra WS debug
592          information</li>
593        <li><strong class="pname"><code>sslCACertList</code></strong> (list) - This keyword is for use with SSL connections only.  Set a list of
594          one or more CA certificates.  The peer cert. must verify against
595          at least one of these otherwise the connection is dropped.</li>
596        <li><strong class="pname"><code>sslCACertFilePathList</code></strong> (list) - the same as the above except CA certs can be passed as a list of
597          file paths to read from</li>
598        <li><strong class="pname"><code>sslPeerCertCN</code></strong> (string) - set an alternate CommonName to match with peer cert.  This
599          keyword is for use with SSL connections only.</li>
600        <li><strong class="pname"><code>setSignatureHandler</code></strong> (bool) - flag to determine whether to apply WS-Security Signature Handler
601          or not</li>
602        <li><strong class="pname"><code>signatureHandlerKw</code></strong> (dict) - keywords to configure signature handler</li>
603    </ul></dd>
604    <dt>Overrides:
605        object.__init__
606    </dt>
607  </dl>
608</td></tr></table>
609</div>
610<a name="__setURI"></a>
611<div class="private">
612<table class="details" border="1" cellpadding="3"
613       cellspacing="0" width="100%" bgcolor="white">
614<tr><td>
615  <table width="100%" cellpadding="0" cellspacing="0" border="0">
616  <tr valign="top"><td>
617  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setURI</span>(<span class="sig-arg">self</span>,
618        <span class="sig-arg">uri</span>)</span>
619  </h3>
620  </td><td align="right" valign="top"
621    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setURI">source&nbsp;code</a></span>&nbsp;
622    </td>
623  </tr></table>
624 
625  <p>Set URI for service</p>
626  <dl class="fields">
627    <dt>Parameters:</dt>
628    <dd><ul class="nomargin-top">
629        <li><strong class="pname"><code>uri</code></strong> (string) - URI for service to connect to</li>
630    </ul></dd>
631  </dl>
632</td></tr></table>
633</div>
634<a name="__getURI"></a>
635<div class="private">
636<table class="details" border="1" cellpadding="3"
637       cellspacing="0" width="100%" bgcolor="white">
638<tr><td>
639  <table width="100%" cellpadding="0" cellspacing="0" border="0">
640  <tr valign="top"><td>
641  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getURI</span>(<span class="sig-arg">self</span>)</span>
642  </h3>
643  </td><td align="right" valign="top"
644    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__getURI">source&nbsp;code</a></span>&nbsp;
645    </td>
646  </tr></table>
647 
648  <p>Get URI for service</p>
649  <dl class="fields">
650    <dt>Returns: string</dt>
651        <dd>uri for service to be invoked</dd>
652  </dl>
653</td></tr></table>
654</div>
655<a name="__setSSLPeerCertCN"></a>
656<div class="private">
657<table class="details" border="1" cellpadding="3"
658       cellspacing="0" width="100%" bgcolor="white">
659<tr><td>
660  <table width="100%" cellpadding="0" cellspacing="0" border="0">
661  <tr valign="top"><td>
662  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setSSLPeerCertCN</span>(<span class="sig-arg">self</span>,
663        <span class="sig-arg">cn</span>)</span>
664  </h3>
665  </td><td align="right" valign="top"
666    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setSSLPeerCertCN">source&nbsp;code</a></span>&nbsp;
667    </td>
668  </tr></table>
669 
670  <p>For use with HTTPS connections only.  Specify the Common Name to match
671  with Common Name of the peer certificate.  This is not needed if the peer
672  cert CN = peer hostname</p>
673  <dl class="fields">
674  </dl>
675</td></tr></table>
676</div>
677<a name="__setSSLCACertList"></a>
678<div class="private">
679<table class="details" border="1" cellpadding="3"
680       cellspacing="0" width="100%" bgcolor="white">
681<tr><td>
682  <table width="100%" cellpadding="0" cellspacing="0" border="0">
683  <tr valign="top"><td>
684  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setSSLCACertList</span>(<span class="sig-arg">self</span>,
685        <span class="sig-arg">caCertList</span>)</span>
686  </h3>
687  </td><td align="right" valign="top"
688    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setSSLCACertList">source&nbsp;code</a></span>&nbsp;
689    </td>
690  </tr></table>
691 
692  <p>For use with HTTPS connections only.  Specify CA certs to one of which
693  the peer cert must verify its signature against</p>
694  <dl class="fields">
695  </dl>
696</td></tr></table>
697</div>
698<a name="__setSSLCACertFilePathList"></a>
699<div class="private">
700<table class="details" border="1" cellpadding="3"
701       cellspacing="0" width="100%" bgcolor="white">
702<tr><td>
703  <table width="100%" cellpadding="0" cellspacing="0" border="0">
704  <tr valign="top"><td>
705  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setSSLCACertFilePathList</span>(<span class="sig-arg">self</span>,
706        <span class="sig-arg">caCertFilePathList</span>)</span>
707  </h3>
708  </td><td align="right" valign="top"
709    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.__setSSLCACertFilePathList">source&nbsp;code</a></span>&nbsp;
710    </td>
711  </tr></table>
712 
713  <p>For use with HTTPS connections only.  Specify CA certs to one of which
714  the peer cert must verify its signature against</p>
715  <dl class="fields">
716  </dl>
717</td></tr></table>
718</div>
719<a name="connect"></a>
720<div>
721<table class="details" border="1" cellpadding="3"
722       cellspacing="0" width="100%" bgcolor="white">
723<tr><td>
724  <table width="100%" cellpadding="0" cellspacing="0" border="0">
725  <tr valign="top"><td>
726  <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
727        <span class="sig-arg">username</span>,
728        <span class="sig-arg">passphrase</span>=<span class="sig-default">None</span>,
729        <span class="sig-arg">passphraseFilePath</span>=<span class="sig-default">None</span>,
730        <span class="sig-arg">createServerSess</span>=<span class="sig-default">True</span>)</span>
731  </h3>
732  </td><td align="right" valign="top"
733    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.connect">source&nbsp;code</a></span>&nbsp;
734    </td>
735  </tr></table>
736 
737  <p>Request a new user session from the Session Manager</p>
738  <dl class="fields">
739    <dt>Parameters:</dt>
740    <dd><ul class="nomargin-top">
741        <li><strong class="pname"><code>username</code></strong> (string) - the username of the user to connect</li>
742        <li><strong class="pname"><code>passphrase</code></strong> (string) - user's pass-phrase</li>
743        <li><strong class="pname"><code>passphraseFilePath</code></strong> (string) - a file containing the user's pass-phrase. Use this as an
744          alternative to passphrase keyword.</li>
745        <li><strong class="pname"><code>createServerSess</code></strong> (bool) - If set to True, the SessionMgr will create and manage a session
746          for the user.  For non-browser client case, it's possible to
747          choose to have a client or server side session using this
748          keyword.  If set to False sessID returned will be None</li>
749    </ul></dd>
750    <dt>Returns: tuple @return user cert, user private key, issuing cert and sessID
751      all as strings but sessID will be None if the createServerSess
752      keyword is False</dt>
753  </dl>
754</td></tr></table>
755</div>
756<a name="disconnect"></a>
757<div>
758<table class="details" border="1" cellpadding="3"
759       cellspacing="0" width="100%" bgcolor="white">
760<tr><td>
761  <table width="100%" cellpadding="0" cellspacing="0" border="0">
762  <tr valign="top"><td>
763  <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>,
764        <span class="sig-arg">userCert</span>=<span class="sig-default">None</span>,
765        <span class="sig-arg">sessID</span>=<span class="sig-default">None</span>)</span>
766  </h3>
767  </td><td align="right" valign="top"
768    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.disconnect">source&nbsp;code</a></span>&nbsp;
769    </td>
770  </tr></table>
771 
772  <p>Delete an existing user session from the Session Manager</p>
773  <p>disconnect([userCert=c]|[sessID=i])</p>
774  <dl class="fields">
775    <dt>Parameters:</dt>
776    <dd><ul class="nomargin-top">
777        <li><strong class="pname"><code>userCert</code></strong> (string) - user's certificate used to identifier which session to
778          disconnect.  This arg is not needed if the message is signed with
779          the user cert or if sessID is set.</li>
780        <li><strong class="pname"><code>sessID</code></strong> (string) - session ID.  Input this as an alternative to userCert This arg is
781          not needed if the message is signed with the user cert or if
782          userCert keyword is.</li>
783    </ul></dd>
784  </dl>
785</td></tr></table>
786</div>
787<a name="getSessionStatus"></a>
788<div>
789<table class="details" border="1" cellpadding="3"
790       cellspacing="0" width="100%" bgcolor="white">
791<tr><td>
792  <table width="100%" cellpadding="0" cellspacing="0" border="0">
793  <tr valign="top"><td>
794  <h3 class="epydoc"><span class="sig"><span class="sig-name">getSessionStatus</span>(<span class="sig-arg">self</span>,
795        <span class="sig-arg">userDN</span>=<span class="sig-default">None</span>,
796        <span class="sig-arg">sessID</span>=<span class="sig-default">None</span>)</span>
797  </h3>
798  </td><td align="right" valign="top"
799    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.getSessionStatus">source&nbsp;code</a></span>&nbsp;
800    </td>
801  </tr></table>
802 
803  <p>Check for the existence of a session with a given session ID / user
804  certificate Distinguished Name</p>
805  <p>disconnect([sessID=id]|[userDN=dn])</p>
806  <dl class="fields">
807    <dt>Parameters:</dt>
808    <dd><ul class="nomargin-top">
809        <li><strong class="pname"><code>userCert</code></strong> (string) - user's certificate used to identifier which session to
810          disconnect.  This arg is not needed if the message is signed with
811          the user cert or if sessID is set.</li>
812        <li><strong class="pname"><code>sessID</code></strong> (string) - session ID.  Input this as an alternative to userCert This arg is
813          not needed if the message is signed with the user cert or if
814          userCert keyword is.</li>
815    </ul></dd>
816  </dl>
817</td></tr></table>
818</div>
819<a name="getAttCert"></a>
820<div>
821<table class="details" border="1" cellpadding="3"
822       cellspacing="0" width="100%" bgcolor="white">
823<tr><td>
824  <table width="100%" cellpadding="0" cellspacing="0" border="0">
825  <tr valign="top"><td>
826  <h3 class="epydoc"><span class="sig"><span class="sig-name">getAttCert</span>(<span class="sig-arg">self</span>,
827        <span class="sig-arg">userCert</span>=<span class="sig-default">None</span>,
828        <span class="sig-arg">sessID</span>=<span class="sig-default">None</span>,
829        <span class="sig-arg">attAuthorityURI</span>=<span class="sig-default">None</span>,
830        <span class="sig-arg">attAuthorityCert</span>=<span class="sig-default">None</span>,
831        <span class="sig-arg">reqRole</span>=<span class="sig-default">None</span>,
832        <span class="sig-arg">mapFromTrustedHosts</span>=<span class="sig-default">True</span>,
833        <span class="sig-arg">rtnExtAttCertList</span>=<span class="sig-default">False</span>,
834        <span class="sig-arg">extAttCertList</span>=<span class="sig-default">[]</span>,
835        <span class="sig-arg">extTrustedHostList</span>=<span class="sig-default">[]</span>)</span>
836  </h3>
837  </td><td align="right" valign="top"
838    ><span class="codelink"><a href="ndg.security.common.SessionMgr-pysrc.html#SessionMgrClient.getAttCert">source&nbsp;code</a></span>&nbsp;
839    </td>
840  </tr></table>
841 
842  <p>Request NDG Session Manager Web Service to retrieve an Attribute
843  Certificate from the given Attribute Authority and cache it in the user's
844  credential wallet held by the session manager.</p>
845  <p>ac = getAttCert([sessID=i]|[userCert=p][key=arg, ...])</p>
846  <dl class="fields">
847    <dt>Parameters:</dt>
848    <dd><ul class="nomargin-top">
849        <li><strong class="pname"><code>userCert</code></strong> (string) - user certificate - use as ID instead of session ID.  This can be
850          omitted if the message is signed with a user certificate.  In
851          this case the user certificate is passed in the
852          BinarySecurityToken of the WS-Security header</li>
853        <li><strong class="pname"><code>sessID</code></strong> (string) - session ID.  Input this as an alternative to userCert in the case
854          of a browser client.</li>
855        <li><strong class="pname"><code>attAuthorityURI</code></strong> (string) - URI for Attribute Authority WS.</li>
856        <li><strong class="pname"><code>attAuthorityCert</code></strong> (string) - The Session Manager uses the Public key of the Attribute
857          Authority to encrypt requests to it.</li>
858        <li><strong class="pname"><code>reqRole</code></strong> (string) - The required role for access to a data set.  This can be left out
859          in which case the Attribute Authority just returns whatever
860          Attribute Certificate it has for the user</li>
861        <li><strong class="pname"><code>mapFromTrustedHosts</code></strong> (bool) - Allow a mapped Attribute Certificate to be created from a user
862          certificate from another trusted host.</li>
863        <li><strong class="pname"><code>rtnExtAttCertList</code></strong> (bool) - Set this flag True so that if the attribute request is denied, a
864          list of potential attribute certificates for mapping may be
865          returned.</li>
866        <li><strong class="pname"><code>extAttCertList</code></strong> (list) - A list of Attribute Certificates from other trusted hosts from
867          which the target Attribute Authority can make a mapped
868          certificate</li>
869        <li><strong class="pname"><code>extTrustedHostList</code></strong> (list) - A list of trusted hosts that can be used to get Attribute
870          Certificates for making a mapped AC.</li>
871    </ul></dd>
872    <dt>Returns: ndg.security.common.AttCert.AttCert</dt>
873        <dd>if successful, an attribute certificate.</dd>
874    <dt>Raises:</dt>
875    <dd><ul class="nomargin-top">
876        <li><code><strong class='fraise'><a href="ndg.security.common.SessionMgr.AttributeRequestDenied-class.html" onclick="show_private();">AttributeRequestDenied</a></strong></code> - this is raised if the request is denied because the user is not
877        registered with the Attribute Authority.  In this case, a list of
878        candidate attribute certificates may be returned which could be
879        used to retry with a request for a mapped AC.  These are assigned
880        to the raised exception's extAttCertList attribute</li>
881    </ul></dd>
882  </dl>
883</td></tr></table>
884</div>
885<br />
886<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
887<a name="section-ClassVariableDetails"></a>
888<table class="details" border="1" cellpadding="3"
889       cellspacing="0" width="100%" bgcolor="white">
890<tr bgcolor="#70b0f0" class="table-header">
891  <td colspan="2" class="table-header">
892    <table border="0" cellpadding="0" cellspacing="0" width="100%">
893      <tr valign="top">
894        <td align="left"><span class="table-header">Class Variable Details</span></td>
895        <td align="right" valign="top"
896         ><span class="options">[<a href="#section-ClassVariableDetails"
897         class="privatelink" onclick="toggle_private();"
898         >hide private</a>]</span></td>
899      </tr>
900    </table>
901  </td>
902</tr>
903</table>
904<a name="excepMap"></a>
905<div>
906<table class="details" border="1" cellpadding="3"
907       cellspacing="0" width="100%" bgcolor="white">
908<tr><td>
909  <h3 class="epydoc">excepMap</h3>
910  map exception strings returned from SOAP fault to client Exception class
911  to call
912  <dl class="fields">
913    <dt>Type:</dt>
914      <dd>dict</dd>
915  </dl>
916  <dl class="fields">
917    <dt>Value:</dt>
918      <dd><table><tr><td><pre class="variable">
919{'SessionNotFound': SessionNotFound, 'UserSessionX509CertNotBeforeTime<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
920Error': SessionCertTimeError, 'UserSessionExpired': SessionExpired, 'I<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
921nvalidUserSession': InvalidSession}
922</pre></td></tr></table>
923</dd>
924  </dl>
925</td></tr></table>
926</div>
927<a name="uri"></a>
928<div>
929<table class="details" border="1" cellpadding="3"
930       cellspacing="0" width="100%" bgcolor="white">
931<tr><td>
932  <h3 class="epydoc">uri</h3>
933 
934  <dl class="fields">
935  </dl>
936  <dl class="fields">
937    <dt>Value:</dt>
938      <dd><table><tr><td><pre class="variable">
939property(fset= __setURI, fget= __getURI, doc= &quot;Session Manager URI&quot;)
940</pre></td></tr></table>
941</dd>
942  </dl>
943</td></tr></table>
944</div>
945<a name="httpProxyHost"></a>
946<div>
947<table class="details" border="1" cellpadding="3"
948       cellspacing="0" width="100%" bgcolor="white">
949<tr><td>
950  <h3 class="epydoc">httpProxyHost</h3>
951 
952  <dl class="fields">
953  </dl>
954  <dl class="fields">
955    <dt>Value:</dt>
956      <dd><table><tr><td><pre class="variable">
957property(fset= __setHTTPProxyHost, doc= &quot;HTTP Proxy hostname - overrid<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
958es any http_proxy env var setting&quot;)
959</pre></td></tr></table>
960</dd>
961  </dl>
962</td></tr></table>
963</div>
964<a name="noHttpProxyList"></a>
965<div>
966<table class="details" border="1" cellpadding="3"
967       cellspacing="0" width="100%" bgcolor="white">
968<tr><td>
969  <h3 class="epydoc">noHttpProxyList</h3>
970 
971  <dl class="fields">
972  </dl>
973  <dl class="fields">
974    <dt>Value:</dt>
975      <dd><table><tr><td><pre class="variable">
976property(fset= __setNoHttpProxyList, doc= &quot;Set to list of hosts for wh<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
977ich to ignore the HTTP Proxy setting&quot;)
978</pre></td></tr></table>
979</dd>
980  </dl>
981</td></tr></table>
982</div>
983<a name="sslPeerCertCN"></a>
984<div>
985<table class="details" border="1" cellpadding="3"
986       cellspacing="0" width="100%" bgcolor="white">
987<tr><td>
988  <h3 class="epydoc">sslPeerCertCN</h3>
989 
990  <dl class="fields">
991  </dl>
992  <dl class="fields">
993    <dt>Value:</dt>
994      <dd><table><tr><td><pre class="variable">
995property(fset= __setSSLPeerCertCN, doc= &quot;for https connections, set CN<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
996 of peer cert if other than peer hostname&quot;)
997</pre></td></tr></table>
998</dd>
999  </dl>
1000</td></tr></table>
1001</div>
1002<a name="sslCACertList"></a>
1003<div>
1004<table class="details" border="1" cellpadding="3"
1005       cellspacing="0" width="100%" bgcolor="white">
1006<tr><td>
1007  <h3 class="epydoc">sslCACertList</h3>
1008 
1009  <dl class="fields">
1010  </dl>
1011  <dl class="fields">
1012    <dt>Value:</dt>
1013      <dd><table><tr><td><pre class="variable">
1014property(fset= __setSSLCACertList, doc= &quot;for https connections, set li<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1015st of CA certs from which to verify peer cert&quot;)
1016</pre></td></tr></table>
1017</dd>
1018  </dl>
1019</td></tr></table>
1020</div>
1021<a name="sslCACertFilePathList"></a>
1022<div>
1023<table class="details" border="1" cellpadding="3"
1024       cellspacing="0" width="100%" bgcolor="white">
1025<tr><td>
1026  <h3 class="epydoc">sslCACertFilePathList</h3>
1027 
1028  <dl class="fields">
1029  </dl>
1030  <dl class="fields">
1031    <dt>Value:</dt>
1032      <dd><table><tr><td><pre class="variable">
1033property(fset= __setSSLCACertFilePathList, doc= &quot;for https connections<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1034, set list of CA cert files from which to verify peer cert&quot;)
1035</pre></td></tr></table>
1036</dd>
1037  </dl>
1038</td></tr></table>
1039</div>
1040<a name="signatureHandler"></a>
1041<div>
1042<table class="details" border="1" cellpadding="3"
1043       cellspacing="0" width="100%" bgcolor="white">
1044<tr><td>
1045  <h3 class="epydoc">signatureHandler</h3>
1046 
1047  <dl class="fields">
1048  </dl>
1049  <dl class="fields">
1050    <dt>Value:</dt>
1051      <dd><table><tr><td><pre class="variable">
1052property(fget= __getSignatureHandler, fset= __setSignatureHandler, doc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1053= &quot;SignatureHandler object&quot;)
1054</pre></td></tr></table>
1055</dd>
1056  </dl>
1057</td></tr></table>
1058</div>
1059<br />
1060<!-- ==================== NAVIGATION BAR ==================== -->
1061<table class="navbar" border="0" width="100%" cellpadding="0"
1062       bgcolor="#a0c0ff" cellspacing="0">
1063  <tr valign="middle">
1064  <!-- Home link -->
1065      <th>&nbsp;&nbsp;&nbsp;<a
1066        href="ndg-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1067
1068  <!-- Tree link -->
1069      <th>&nbsp;&nbsp;&nbsp;<a
1070        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1071
1072  <!-- Index link -->
1073      <th>&nbsp;&nbsp;&nbsp;<a
1074        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1075
1076  <!-- Help link -->
1077      <th>&nbsp;&nbsp;&nbsp;<a
1078        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1079
1080  <!-- Project homepage -->
1081      <th class="navbar" align="right" width="100%">
1082        <table border="0" cellpadding="0" cellspacing="0">
1083          <tr><th class="navbar" align="center"
1084            >NDG Security</th>
1085          </tr></table></th>
1086  </tr>
1087</table>
1088<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1089  <tr>
1090    <td align="left" class="footer">
1091    <a href="epydoc-log.html">Generated by Epydoc
1092    3.0.1 on Thu Sep  4 09:37:43 2008</a>
1093    </td>
1094    <td align="right" class="footer">
1095      <a target="mainFrame" href="http://epydoc.sourceforge.net"
1096        >http://epydoc.sourceforge.net</a>
1097    </td>
1098  </tr>
1099</table>
1100
1101<script type="text/javascript">
1102  <!--
1103  // Private objects are initially displayed (because if
1104  // javascript is turned off then we want them to be
1105  // visible); but by default, we want to hide them.  So hide
1106  // them unless we have a cookie that says to show them.
1107  checkCookie();
1108  // -->
1109</script>
1110</body>
1111</html>
Note: See TracBrowser for help on using the repository browser.