File: interfaceauth_1_1AuthManager.html

package info (click to toggle)
raritan-json-rpc-sdk 3.6.1%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 41,748 kB
  • sloc: cs: 162,629; perl: 85,818; python: 24,275; javascript: 5,937; makefile: 21
file content (155 lines) | stat: -rw-r--r-- 7,753 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: auth::AuthManager Interface 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Raritan PX2/PX3 JSON-RPC API
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceauth.html">auth</a></li><li class="navelem"><a class="el" href="interfaceauth_1_1AuthManager.html">AuthManager</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="interfaceauth_1_1AuthManager-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">auth::AuthManager Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Authentication manager interface.  
 <a href="interfaceauth_1_1AuthManager.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="AuthManager_8idl_source.html">AuthManager.idl</a>&quot;;</code></p>
<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:a18b95a4421942bda4481e7063ade103a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structauth_1_1Policy.html">Policy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1AuthManager.html#a18b95a4421942bda4481e7063ade103a">getPolicy</a> ()</td></tr>
<tr class="memdesc:a18b95a4421942bda4481e7063ade103a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a policy.  <a href="#a18b95a4421942bda4481e7063ade103a">More...</a><br /></td></tr>
<tr class="separator:a18b95a4421942bda4481e7063ade103a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a624ed99646e5999261235ed633f6dff0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1AuthManager.html#a624ed99646e5999261235ed633f6dff0">setPolicy</a> (in <a class="el" href="structauth_1_1Policy.html">Policy</a> p)</td></tr>
<tr class="memdesc:a624ed99646e5999261235ed633f6dff0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a policy.  <a href="#a624ed99646e5999261235ed633f6dff0">More...</a><br /></td></tr>
<tr class="separator:a624ed99646e5999261235ed633f6dff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a517104b59a395779ec32f588e1db49d4"><td class="memItemLeft" align="right" valign="top"><a id="a517104b59a395779ec32f588e1db49d4"></a>
constant int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1AuthManager.html#a517104b59a395779ec32f588e1db49d4">ERR_UNSUPPORTED_TYPE</a> = 1</td></tr>
<tr class="memdesc:a517104b59a395779ec32f588e1db49d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsupported authentication type. <br /></td></tr>
<tr class="separator:a517104b59a395779ec32f588e1db49d4"><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>Authentication manager interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a18b95a4421942bda4481e7063ade103a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18b95a4421942bda4481e7063ade103a">&#9670;&nbsp;</a></span>getPolicy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structauth_1_1Policy.html">Policy</a> auth::AuthManager::getPolicy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets a policy. </p>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="structauth_1_1Policy.html" title="Authentication policy. ">Policy</a> object </dd></dl>

</div>
</div>
<a id="a624ed99646e5999261235ed633f6dff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a624ed99646e5999261235ed633f6dff0">&#9670;&nbsp;</a></span>setPolicy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int auth::AuthManager::setPolicy </td>
          <td>(</td>
          <td class="paramtype">in <a class="el" href="structauth_1_1Policy.html">Policy</a>&#160;</td>
          <td class="paramname"><em>p</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets a policy. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd>
<dd>
1 in case authentication type is not supported </dd></dl>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="AuthManager_8idl_source.html">AuthManager.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>