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 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: DSIGKeyInfoList Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>DSIGKeyInfoList Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGKeyInfoList_8hpp-source.html">DSIGKeyInfoList.hpp</a>></code>
<p>
Collaboration diagram for DSIGKeyInfoList:<p><center><img src="classDSIGKeyInfoList__coll__graph.png" border="0" usemap="#DSIGKeyInfoList__coll__map" alt="Collaboration graph"></center>
<map name="DSIGKeyInfoList__coll__map">
<area href="classXSECEnv.html" shape="rect" coords="184,281,266,305" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="8,190,189,214" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="85,9,168,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="176,99,293,123" alt="">
<area href="classXSECURIResolver.html" shape="rect" coords="213,190,349,214" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDSIGKeyInfoList-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Container class for KeyInfo elements.
<p>
The library stores KeyInfo lists using this class.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#w0">KeyInfoListVectorType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#w1">size_type</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z3_0">DSIGKeyInfoList</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Main constructor. <a href="#z3_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z3_1">~DSIGKeyInfoList</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z3_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public (API) functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z4_0">getSize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get size of list. <a href="#z4_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z4_1">item</a> (<a class="el" href="classDSIGKeyInfoList.html#w1">size_type</a> index)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulate the List</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_0">addKeyInfo</a> (<a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> *ref)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an already created KeyInfo. <a href="#z5_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_1">addAndInsertKeyInfo</a> (<a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> *ref)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an already created KeyInfo. <a href="#z5_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_2">addXMLKeyInfo</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *ki)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read from DOM and create. <a href="#z5_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_3">loadListFromXML</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read full list from DOM. <a href="#z5_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_4">removeKeyInfo</a> (<a class="el" href="classDSIGKeyInfoList.html#w1">size_type</a> index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_5">setEnvironment</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the overarching environment. <a href="#z5_5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_6">empty</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear out the list. <a href="#z5_6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z5_7">isEmpty</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the list empty? <a href="#z5_7"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Create new KeyInfo elements</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_0">createKeyInfo</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create basic KeyInfo element. <a href="#z6_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_1">appendDSAKeyValue</a> (const XMLCh *P, const XMLCh *Q, const XMLCh *G, const XMLCh *Y)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a DSA KeyValue element. <a href="#z6_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_2">appendRSAKeyValue</a> (const XMLCh *modulus, const XMLCh *exponent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a RSA KeyValue element. <a href="#z6_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfoX509.html">DSIGKeyInfoX509</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_3">appendX509Data</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a X509Data element. <a href="#z6_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfoName.html">DSIGKeyInfoName</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_4">appendKeyName</a> (const XMLCh *name, bool isDName=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a KeyName element. <a href="#z6_4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfoPGPData.html">DSIGKeyInfoPGPData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_5">appendPGPData</a> (const XMLCh *id, const XMLCh *packet)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a PGPData element. <a href="#z6_5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfoSPKIData.html">DSIGKeyInfoSPKIData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_6">appendSPKIData</a> (const XMLCh *sexp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a SPKIData element. <a href="#z6_6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGKeyInfoMgmtData.html">DSIGKeyInfoMgmtData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoList.html#z6_7">appendMgmtData</a> (const XMLCh *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a MgmtData element. <a href="#z6_7"></a><br></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="DSIGKeyInfoList::KeyInfoListVectorType"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef std::vector<<a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> *> <a class="el" href="classDSIGKeyInfoList.html#w0">DSIGKeyInfoList::KeyInfoListVectorType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="w1" doxytag="DSIGKeyInfoList::size_type"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef size_t <a class="el" href="classDSIGKeyInfoList.html#w1">DSIGKeyInfoList::size_type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z3_0" doxytag="DSIGKeyInfoList::DSIGKeyInfoList"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DSIGKeyInfoList::DSIGKeyInfoList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>env</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Main constructor.
<p>
Main constructor called by <a class="el" href="classDSIGSignature.html">DSIGSignature</a><p>
<dl compact><dt><b>Note:</b></dt><dd>Should only ever be created by a Signature or Cipher class.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>The environment the KeyInfo is operating within </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z3_1" doxytag="DSIGKeyInfoList::~DSIGKeyInfoList"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DSIGKeyInfoList::~DSIGKeyInfoList </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z5_1" doxytag="DSIGKeyInfoList::addAndInsertKeyInfo"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGKeyInfoList::addAndInsertKeyInfo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>ref</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add an already created KeyInfo.
<p>
Adds a KeyInfo element that has already been built into the list.<p>
<dl compact><dt><b>Note:</b></dt><dd>This method finds the DOM node of the KeyInfo and inserts it into the <KeyInfo/> list in the DOM. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ref</em> </td><td>The KeyInfo to add </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z5_0" doxytag="DSIGKeyInfoList::addKeyInfo"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGKeyInfoList::addKeyInfo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>ref</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add an already created KeyInfo.
<p>
Adds a KeyInfo element that has already been built into the list.<p>
<dl compact><dt><b>Note:</b></dt><dd>This method does <b>not</b> insert the KeyInfo into the DOM structure - it assumes it is already there and just adds to the list. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ref</em> </td><td>The KeyInfo to add </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z5_2" doxytag="DSIGKeyInfoList::addXMLKeyInfo"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool DSIGKeyInfoList::addXMLKeyInfo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname1" valign="top" nowrap> <em>ki</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Read from DOM and create.
<p>
Uses a DOMNode pointing to the start of the KeyInfo element to build a new KeyInfo and then add it to the list<p>
<dl compact><dt><b>Note:</b></dt><dd>This is an internal function and should not be called directly</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ki</em> </td><td>Head of DOM structure with the KeyInfo </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if successfully loaded </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_1" doxytag="DSIGKeyInfoList::appendDSAKeyValue"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a>* DSIGKeyInfoList::appendDSAKeyValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>P</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>Q</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>G</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>Y</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a DSA KeyValue element.
<p>
Add a new KeyInfo element for a DSA Value<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>P</em> </td><td>Base64 encoded value of P </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Q</em> </td><td>Base64 encoded value of Q </td></tr>
<tr><td valign="top"></td><td valign="top"><em>G</em> </td><td>Base64 encoded value of G </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Y</em> </td><td>Base64 encoded value of Y </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_4" doxytag="DSIGKeyInfoList::appendKeyName"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoName.html">DSIGKeyInfoName</a>* DSIGKeyInfoList::appendKeyName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>isDName</em> = <code>false</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a KeyName element.
<p>
Add a new KeyInfo element for a key name.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the key to set in the XML </td></tr>
<tr><td valign="top"></td><td valign="top"><em>isDName</em> </td><td>Treat the name as a Distinguished name and encode accordingly </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_7" doxytag="DSIGKeyInfoList::appendMgmtData"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoMgmtData.html">DSIGKeyInfoMgmtData</a>* DSIGKeyInfoList::appendMgmtData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a MgmtData element.
<p>
Add a new KeyInfo element for Management Data<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The string to set in the MgmtData element </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_5" doxytag="DSIGKeyInfoList::appendPGPData"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoPGPData.html">DSIGKeyInfoPGPData</a>* DSIGKeyInfoList::appendPGPData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>packet</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a PGPData element.
<p>
Add a new KeyInfo element for a PGP key.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The ID of the key to set in the XML (base64 encoded - NULL if none) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>The Packet information to set in the XML (base64 encoded - NULL if none) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_2" doxytag="DSIGKeyInfoList::appendRSAKeyValue"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a>* DSIGKeyInfoList::appendRSAKeyValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>modulus</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>exponent</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a RSA KeyValue element.
<p>
Add a new KeyInfo element for a RSA Value<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>modulus</em> </td><td>Base64 encoded value of the modulus </td></tr>
<tr><td valign="top"></td><td valign="top"><em>exponent</em> </td><td>Base64 encoded value of exponent </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_6" doxytag="DSIGKeyInfoList::appendSPKIData"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoSPKIData.html">DSIGKeyInfoSPKIData</a>* DSIGKeyInfoList::appendSPKIData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>sexp</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a SPKIData element.
<p>
Add a new KeyInfo element for a set of SPKI S-expressions<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sexp</em> </td><td>The initial S-expression to set in the SPKIData element </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_3" doxytag="DSIGKeyInfoList::appendX509Data"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoX509.html">DSIGKeyInfoX509</a>* DSIGKeyInfoList::appendX509Data </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a X509Data element.
<p>
Add a new KeyInfo element for X509 data.<p>
<dl compact><dt><b>Note:</b></dt><dd>The added element is empty. The caller must make use of the returned object to set the required values.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z6_0" doxytag="DSIGKeyInfoList::createKeyInfo"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGKeyInfoList::createKeyInfo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create basic KeyInfo element.
<p>
Creates the basic KeyInfo node that can then be used to embed specific KeyInfo types </td>
</tr>
</table>
<a class="anchor" name="z5_6" doxytag="DSIGKeyInfoList::empty"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGKeyInfoList::empty </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Clear out the list.
<p>
Removes all elements from the list<p>
<dl compact><dt><b>Note:</b></dt><dd>Deletes the items themselves as well as clearing the list. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z4_0" doxytag="DSIGKeyInfoList::getSize"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">size_t DSIGKeyInfoList::getSize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get size of list.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the number of elements in the list </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z5_7" doxytag="DSIGKeyInfoList::isEmpty"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool DSIGKeyInfoList::isEmpty </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Is the list empty?
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true Iff there are no elements in the list </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z4_1" doxytag="DSIGKeyInfoList::item"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a>* DSIGKeyInfoList::item </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoList.html#w1">size_type</a> </td>
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="z5_3" doxytag="DSIGKeyInfoList::loadListFromXML"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool DSIGKeyInfoList::loadListFromXML </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname1" valign="top" nowrap> <em>node</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Read full list from DOM.
<p>
Will take the starting node of a KeyInfo list and read into the list structure. This is a bit different from other "load" functions, in that it takes a node as a parameter.<p>
<dl compact><dt><b>Note:</b></dt><dd>This is an internal functions and should not be called directly</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>The <KeyInfo> element node to read from </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z5_4" doxytag="DSIGKeyInfoList::removeKeyInfo"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfo.html">DSIGKeyInfo</a>* DSIGKeyInfoList::removeKeyInfo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoList.html#w1">size_type</a> </td>
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="z5_5" doxytag="DSIGKeyInfoList::setEnvironment"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGKeyInfoList::setEnvironment </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>env</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the overarching environment.
<p>
Sets the environment this list is operating within<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Operating environment </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DSIGKeyInfoList_8hpp-source.html">DSIGKeyInfoList.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:40:49 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|