libshibsp-doc 2.5.3+dfsg-2.1build1 / usr / share / doc / libshibsp-doc / html / a00019.html

This file is indexed.

/usr/share/doc/libshibsp-doc/html/a00019.html is in libshibsp-doc 2.5.3+dfsg-2.1build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>shibboleth-2.5.3: shibsp::DOMPropertySet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">shibboleth-2.5.3
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00019.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="a00155.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">shibsp::DOMPropertySet Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>DOM-based property set implementation.  
 <a href="a00019.html#details">More...</a></p>

<p><code>#include &lt;shibsp/util/DOMPropertySet.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shibsp::DOMPropertySet:</div>
<div class="dyncontent">
 <div class="center">
  <img src="a00019.png" usemap="#shibsp::DOMPropertySet_map" alt=""/>
  <map id="shibsp::DOMPropertySet_map" name="shibsp::DOMPropertySet_map">
<area href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. " alt="shibsp::PropertySet" shape="rect" coords="109,0,317,24"/>
<area href="a00001.html" title="Base class for handlers based on a DOMPropertySet. " alt="shibsp::AbstractHandler" shape="rect" coords="109,112,317,136"/>
<area href="a00006.html" title="Base class for handlers that create sessions by consuming SSO protocol responses. ..." alt="shibsp::AssertionConsumerService" shape="rect" coords="0,168,208,192"/>
<area href="a00041.html" title="Pluggable runtime functionality that is protected by simple access control. " alt="shibsp::SecuredHandler" shape="rect" coords="218,168,426,192"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aae28fecd0bf90bb64e7b09278bd03530"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00034.html">PropertySet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#aae28fecd0bf90bb64e7b09278bd03530">getParent</a> () const </td></tr>
<tr class="memdesc:aae28fecd0bf90bb64e7b09278bd03530"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns parent of this <a class="el" href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. ">PropertySet</a>, if any.  <a href="#aae28fecd0bf90bb64e7b09278bd03530">More...</a><br /></td></tr>
<tr class="separator:aae28fecd0bf90bb64e7b09278bd03530"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac063c2a9bc5b5881fd87c4bf09f46f08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ac063c2a9bc5b5881fd87c4bf09f46f08">setParent</a> (const <a class="el" href="a00034.html">PropertySet</a> *parent)</td></tr>
<tr class="memdesc:ac063c2a9bc5b5881fd87c4bf09f46f08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Establishes a "parent" <a class="el" href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. ">PropertySet</a> to supply inherited settings.  <a href="#ac063c2a9bc5b5881fd87c4bf09f46f08">More...</a><br /></td></tr>
<tr class="separator:ac063c2a9bc5b5881fd87c4bf09f46f08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac30b948087b77030bdba76389516c6f2"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ac30b948087b77030bdba76389516c6f2">getBool</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:ac30b948087b77030bdba76389516c6f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a boolean-valued property.  <a href="#ac30b948087b77030bdba76389516c6f2">More...</a><br /></td></tr>
<tr class="separator:ac30b948087b77030bdba76389516c6f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab017fc985e21496e2781823c98167f7b"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, const char * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ab017fc985e21496e2781823c98167f7b">getString</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:ab017fc985e21496e2781823c98167f7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string-valued property.  <a href="#ab017fc985e21496e2781823c98167f7b">More...</a><br /></td></tr>
<tr class="separator:ab017fc985e21496e2781823c98167f7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8cd5d48936c7fee3014c93deabede79"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, const XMLCh * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ab8cd5d48936c7fee3014c93deabede79">getXMLString</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:ab8cd5d48936c7fee3014c93deabede79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a Unicode string-valued property.  <a href="#ab8cd5d48936c7fee3014c93deabede79">More...</a><br /></td></tr>
<tr class="separator:ab8cd5d48936c7fee3014c93deabede79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27399d5e63b0b268de1dee6ff7e0dd74"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, unsigned int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a27399d5e63b0b268de1dee6ff7e0dd74">getUnsignedInt</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:a27399d5e63b0b268de1dee6ff7e0dd74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an unsigned integer-valued property.  <a href="#a27399d5e63b0b268de1dee6ff7e0dd74">More...</a><br /></td></tr>
<tr class="separator:a27399d5e63b0b268de1dee6ff7e0dd74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a567b00639c7053f271ae814485f9066a"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a567b00639c7053f271ae814485f9066a">getInt</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:a567b00639c7053f271ae814485f9066a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an integer-valued property.  <a href="#a567b00639c7053f271ae814485f9066a">More...</a><br /></td></tr>
<tr class="separator:a567b00639c7053f271ae814485f9066a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06c3d7aa85892b6535133ed67154522c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a06c3d7aa85892b6535133ed67154522c">getAll</a> (std::map&lt; std::string, const char * &gt; &amp;properties) const </td></tr>
<tr class="memdesc:a06c3d7aa85892b6535133ed67154522c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a map of all known properties in string form.  <a href="#a06c3d7aa85892b6535133ed67154522c">More...</a><br /></td></tr>
<tr class="separator:a06c3d7aa85892b6535133ed67154522c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad28dddc643f538829f0ebdcbdc81d4e1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00034.html">PropertySet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ad28dddc643f538829f0ebdcbdc81d4e1">getPropertySet</a> (const char *name, const char *ns=<a class="el" href="a00128.html#a7c430d9a2b402fafe37a49e23b941d27">shibspconstants::ASCII_SHIB2SPCONFIG_NS</a>) const </td></tr>
<tr class="memdesc:ad28dddc643f538829f0ebdcbdc81d4e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a nested property set.  <a href="#ad28dddc643f538829f0ebdcbdc81d4e1">More...</a><br /></td></tr>
<tr class="separator:ad28dddc643f538829f0ebdcbdc81d4e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b6c11add2a74af7e20c4fa05f07a075"><td class="memItemLeft" align="right" valign="top">const xercesc::DOMElement *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a2b6c11add2a74af7e20c4fa05f07a075">getElement</a> () const </td></tr>
<tr class="memdesc:a2b6c11add2a74af7e20c4fa05f07a075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a DOM element representing the property container, if any.  <a href="#a2b6c11add2a74af7e20c4fa05f07a075">More...</a><br /></td></tr>
<tr class="separator:a2b6c11add2a74af7e20c4fa05f07a075"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53b982f9480a15786eecdf6b3ed4a527"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a53b982f9480a15786eecdf6b3ed4a527">load</a> (const xercesc::DOMElement *e, xmltooling::logging::Category *log=nullptr, xercesc::DOMNodeFilter *filter=nullptr, const std::map&lt; std::string, std::string &gt; *remapper=nullptr)</td></tr>
<tr class="memdesc:a53b982f9480a15786eecdf6b3ed4a527"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads the property set from a DOM element.  <a href="#a53b982f9480a15786eecdf6b3ed4a527">More...</a><br /></td></tr>
<tr class="separator:a53b982f9480a15786eecdf6b3ed4a527"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:adba99745c1aeaa1adda4d9db78eaca6e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#adba99745c1aeaa1adda4d9db78eaca6e">setProperty</a> (const char *name, const char *val, const char *ns=nullptr)</td></tr>
<tr class="memdesc:adba99745c1aeaa1adda4d9db78eaca6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Post-load injection of a property, for use by subclasses.  <a href="#adba99745c1aeaa1adda4d9db78eaca6e">More...</a><br /></td></tr>
<tr class="separator:adba99745c1aeaa1adda4d9db78eaca6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>DOM-based property set implementation. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a06c3d7aa85892b6535133ed67154522c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shibsp::DOMPropertySet::getAll </td>
          <td>(</td>
          <td class="paramtype">std::map&lt; std::string, const char * &gt; &amp;&#160;</td>
          <td class="paramname"><em>properties</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a map of all known properties in string form. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">properties</td><td>map to populate </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="a00034.html#ab1c7223aeb0b8c5807e01e3a7b9af675">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="ac30b948087b77030bdba76389516c6f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::pair&lt;bool,bool&gt; shibsp::DOMPropertySet::getBool </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a boolean-valued property. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>property name </td></tr>
    <tr><td class="paramname">ns</td><td>property namespace, or nullptr </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a nullptr indicator and the property value iff the indicator is true </dd></dl>

<p>Implements <a class="el" href="a00034.html#a5fa9ef95c537376d142dd9ecb6257fd6">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="a2b6c11add2a74af7e20c4fa05f07a075"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const xercesc::DOMElement* shibsp::DOMPropertySet::getElement </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a DOM element representing the property container, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>a DOM element, or nullptr </dd></dl>

<p>Implements <a class="el" href="a00034.html#aea08e3882c71bc1f076e39a05bf4074f">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="a567b00639c7053f271ae814485f9066a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::pair&lt;bool,int&gt; shibsp::DOMPropertySet::getInt </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns an integer-valued property. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>property name </td></tr>
    <tr><td class="paramname">ns</td><td>property namespace, or nullptr </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a nullptr indicator and the property value iff the indicator is true </dd></dl>

<p>Implements <a class="el" href="a00034.html#a15d6436d954de445d15b7fa6f9bdedfe">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="aae28fecd0bf90bb64e7b09278bd03530"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00034.html">PropertySet</a>* shibsp::DOMPropertySet::getParent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns parent of this <a class="el" href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. ">PropertySet</a>, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>the parent object, or nullptr </dd></dl>

<p>Implements <a class="el" href="a00034.html#aba91040e2ae0ab4467da7fc2dcaf794e">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="ad28dddc643f538829f0ebdcbdc81d4e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00034.html">PropertySet</a>* shibsp::DOMPropertySet::getPropertySet </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns</em> = <code><a class="el" href="a00128.html#a7c430d9a2b402fafe37a49e23b941d27">shibspconstants::ASCII_SHIB2SPCONFIG_NS</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a nested property set. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>nested property set name </td></tr>
    <tr><td class="paramname">ns</td><td>nested property set namespace, or nullptr </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the nested property set, or nullptr </dd></dl>

<p>Implements <a class="el" href="a00034.html#a310b178d0b4793f00bec232b9c732ac2">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="ab017fc985e21496e2781823c98167f7b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::pair&lt;bool,const char*&gt; shibsp::DOMPropertySet::getString </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a string-valued property. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>property name </td></tr>
    <tr><td class="paramname">ns</td><td>property namespace, or nullptr </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a nullptr indicator and the property value iff the indicator is true </dd></dl>

<p>Implements <a class="el" href="a00034.html#aeacf648ec83214db5a3500c4806156de">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="a27399d5e63b0b268de1dee6ff7e0dd74"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::pair&lt;bool,unsigned int&gt; shibsp::DOMPropertySet::getUnsignedInt </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns an unsigned integer-valued property. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>property name </td></tr>
    <tr><td class="paramname">ns</td><td>property namespace, or nullptr </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a nullptr indicator and the property value iff the indicator is true </dd></dl>

<p>Implements <a class="el" href="a00034.html#ae71597d828024ddc39bc56b7f80e0d9f">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="ab8cd5d48936c7fee3014c93deabede79"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::pair&lt;bool,const XMLCh*&gt; shibsp::DOMPropertySet::getXMLString </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a Unicode string-valued property. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>property name </td></tr>
    <tr><td class="paramname">ns</td><td>property namespace, or nullptr </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a nullptr indicator and the property value iff the indicator is true </dd></dl>

<p>Implements <a class="el" href="a00034.html#ac57b03fc46ad8c3bddadef1018aa3754">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="a53b982f9480a15786eecdf6b3ed4a527"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void shibsp::DOMPropertySet::load </td>
          <td>(</td>
          <td class="paramtype">const xercesc::DOMElement *&#160;</td>
          <td class="paramname"><em>e</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xmltooling::logging::Category *&#160;</td>
          <td class="paramname"><em>log</em> = <code>nullptr</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xercesc::DOMNodeFilter *&#160;</td>
          <td class="paramname"><em>filter</em> = <code>nullptr</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::map&lt; std::string, std::string &gt; *&#160;</td>
          <td class="paramname"><em>remapper</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Loads the property set from a DOM element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">e</td><td>root element of property set </td></tr>
    <tr><td class="paramname">log</td><td>optional log object for tracing </td></tr>
    <tr><td class="paramname">filter</td><td>optional filter controls what child elements to include as nested PropertySets </td></tr>
    <tr><td class="paramname">remapper</td><td>optional map of property rename rules for legacy property support </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac063c2a9bc5b5881fd87c4bf09f46f08"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shibsp::DOMPropertySet::setParent </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00034.html">PropertySet</a> *&#160;</td>
          <td class="paramname"><em>parent</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Establishes a "parent" <a class="el" href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. ">PropertySet</a> to supply inherited settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">parent</td><td>the parent <a class="el" href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. ">PropertySet</a> to use </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="a00034.html#aaaddca0d6eaa5db1b38108041386c5e7">shibsp::PropertySet</a>.</p>

</div>
</div>
<a class="anchor" id="adba99745c1aeaa1adda4d9db78eaca6e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool shibsp::DOMPropertySet::setProperty </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>val</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Post-load injection of a property, for use by subclasses. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>property name </td></tr>
    <tr><td class="paramname">val</td><td>property value </td></tr>
    <tr><td class="paramname">ns</td><td>property namespace </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the property was successfully set </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>shibsp/util/<a class="el" href="a00114.html">DOMPropertySet.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="a00127.html">shibsp</a></li><li class="navelem"><a class="el" href="a00019.html">DOMPropertySet</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
  </ul>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.