/usr/share/doc/ice34-slice/reference/Glacier2/Router.html is in ice34-slice 3.4.2-4ubuntu1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>
Glacier2::Router
</title>
<style type="text/css">
body {
font-family: Arial, Helvetica, sans-serif;
}
.Page {
width: 850px;
margin-left: auto;
margin-right: auto;
}
.Symbol {
font-family: "Courier New", Courier, mono;
}
.Synopsis {
font-family: "Courier New", Courier, mono;
font-weight: bold;
}
.Deprecated {
font-style: italic;
}
.Warning {
font-style: italic;
}
.Note {
font-style: italic;
}
.HeaderFooter {
width: 100%;
}
.Logo {
border-style: none;
}
.LogoTable {
}
.Button {
border-style: none;
}
.ButtonGrey {
border-style: none;
cursor: default;
}
</style>
</head>
<body>
<div class="Page">
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html"><img class="Button" src="../images/home.gif" alt="Home"></a></td>
<td><a href="PermissionsVerifier.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Glacier2.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="SSLInfo.html"><img class="Button" src="../images/next.gif" alt="Next"></a></td>
<td><a href="../_sindex.html"><img class="Button" src="../images/index.gif" alt="Index"></a></td>
</tr>
</table>
</td>
<td align="center">
<table>
<tr>
<td>
<form method="get" action="/cgi-bin/swish.cgi" enctype="application/x-www-form-urlencoded" class="form">
<div>
<input maxlength="100" value="" type="text" name="query">
<input type="submit" value="Search" name="submit"></div>
</form></td>
</tr>
</table>
</td>
<td align="right">
<table class="LogoTable">
<tr>
<td><a href="http://www.zeroc.com"><img class="Logo" src="../images/logo.gif" alt="Logo"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<!-- SwishCommand index -->
<hr>
<h1 class="Symbol">Glacier2::Router</h1>
<h2>Overview</h2>
<h3 class="Synopsis">interface Router extends <a class="Symbol" href="../Ice/Router.html#Router">::Ice::Router</a></h3>
<p>
The Glacier2 specialization of the <a class="Symbol" href="../Ice/Router.html">::Ice::Router</a>
interface.</p>
<h2>Operation Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="#getCategoryForClient">getCategoryForClient</a></dt>
<dd>
This category must be used in the identities of all of the client's
callback objects.</dd>
<dt class="Symbol"><a class="Symbol" href="#createSession">createSession</a></dt>
<dd>
Create a per-client session with the router.</dd>
<dt class="Symbol"><a class="Symbol" href="#createSessionFromSecureConnection">createSessionFromSecureConnection</a></dt>
<dd>
Create a per-client session with the router.</dd>
<dt class="Symbol"><a class="Symbol" href="#refreshSession">refreshSession</a></dt>
<dd>
Keep the calling client's session with this router alive.</dd>
<dt class="Symbol"><a class="Symbol" href="#destroySession">destroySession</a></dt>
<dd>
Destroy the calling client's session with this router.</dd>
<dt class="Symbol"><a class="Symbol" href="#getSessionTimeout">getSessionTimeout</a></dt>
<dd>
Get the value of the session timeout.</dd>
</dl>
<h2>Operations</h2>
<h3 class="Synopsis">string <a class="Symbol" name="getCategoryForClient">getCategoryForClient</a>()</h3>
<p>
This category must be used in the identities of all of the client's
callback objects. This is necessary in order for the router to
forward callback requests to the intended client. If the Glacier2
server endpoints are not set, the returned category is an empty
string.</p>
<h4>Return Value</h4>
<p>The category.</p>
<h3 class="Synopsis"><a class="Symbol" href="Session.html">Session</a>* <a class="Symbol" name="createSession">createSession</a>(string userId, string password) throws <a class="Symbol" href="PermissionDeniedException.html">PermissionDeniedException</a>, <a class="Symbol" href="CannotCreateSessionException.html">CannotCreateSessionException</a></h3>
<p>
Create a per-client session with the router. If a
<a class="Symbol" href="SessionManager.html">SessionManager</a> has been installed, a proxy to a <a class="Symbol" href="Session.html">Session</a>
object is returned to the client. Otherwise, null is returned
and only an internal session (i.e., not visible to the client)
is created.
If a session proxy is returned, it must be configured to route
through the router that created it. This will happen automatically
if the router is configured as the client's default router at the
time the session proxy is created in the client process, otherwise
the client must configure the session proxy explicitly.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">userId</dt>
<dd>
The user id for which to check the password.</dd>
<dt class="Symbol">password</dt>
<dd>
The password for the given user id.</dd>
</dl>
<h4>Return Value</h4>
<p>A proxy for the newly created session, or null if no
<a class="Symbol" href="SessionManager.html">SessionManager</a> has been installed.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="PermissionDeniedException.html">PermissionDeniedException</a></dt>
<dd>
Raised if the password for
the given user id is not correct, or if the user is not allowed
access.</dd>
<dt class="Symbol"><a class="Symbol" href="CannotCreateSessionException.html">CannotCreateSessionException</a></dt>
<dd>
Raised if the session
cannot be created.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Session.html">Session</a></dt>
<dt class="Symbol"><a class="Symbol" href="SessionManager.html">SessionManager</a></dt>
<dt class="Symbol"><a class="Symbol" href="PermissionsVerifier.html">PermissionsVerifier</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="Session.html">Session</a>* <a class="Symbol" name="createSessionFromSecureConnection">createSessionFromSecureConnection</a>() throws <a class="Symbol" href="PermissionDeniedException.html">PermissionDeniedException</a>, <a class="Symbol" href="CannotCreateSessionException.html">CannotCreateSessionException</a></h3>
<p>
Create a per-client session with the router. The user is
authenticated through the SSL certificates that have been
associated with the connection. If a <a class="Symbol" href="SessionManager.html">SessionManager</a> has been
installed, a proxy to a <a class="Symbol" href="Session.html">Session</a> object is returned to the
client. Otherwise, null is returned and only an internal
session (i.e., not visible to the client) is created.
If a session proxy is returned, it must be configured to route
through the router that created it. This will happen automatically
if the router is configured as the client's default router at the
time the session proxy is created in the client process, otherwise
the client must configure the session proxy explicitly.</p>
<h4>Return Value</h4>
<p>A proxy for the newly created session, or null if no
<a class="Symbol" href="SessionManager.html">SessionManager</a> has been installed.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="PermissionDeniedException.html">PermissionDeniedException</a></dt>
<dd>
Raised if the user cannot be
authenticated or if the user is not allowed access.</dd>
<dt class="Symbol"><a class="Symbol" href="CannotCreateSessionException.html">CannotCreateSessionException</a></dt>
<dd>
Raised if the session
cannot be created.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Session.html">Session</a></dt>
<dt class="Symbol"><a class="Symbol" href="SessionManager.html">SessionManager</a></dt>
<dt class="Symbol"><a class="Symbol" href="PermissionsVerifier.html">PermissionsVerifier</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="refreshSession">refreshSession</a>() throws <a class="Symbol" href="SessionNotExistException.html">SessionNotExistException</a></h3>
<p>
Keep the calling client's session with this router alive.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="SessionNotExistException.html">SessionNotExistException</a></dt>
<dd>
Raised if no session exists
for the calling client.</dd>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="destroySession">destroySession</a>() throws <a class="Symbol" href="SessionNotExistException.html">SessionNotExistException</a></h3>
<p>
Destroy the calling client's session with this router.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="SessionNotExistException.html">SessionNotExistException</a></dt>
<dd>
Raised if no session exists
for the calling client.</dd>
</dl>
<h3 class="Synopsis">long <a class="Symbol" name="getSessionTimeout">getSessionTimeout</a>()</h3>
<p>
Get the value of the session timeout. Sessions are destroyed
if they see no activity for this period of time.</p>
<h4>Return Value</h4>
<p>The timeout (in seconds).</p>
<hr>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html"><img class="Button" src="../images/home.gif" alt="Home"></a></td>
<td><a href="PermissionsVerifier.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Glacier2.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="SSLInfo.html"><img class="Button" src="../images/next.gif" alt="Next"></a></td>
<td><a href="../_sindex.html"><img class="Button" src="../images/index.gif" alt="Index"></a></td>
</tr>
</table>
</td>
<td align="center">
<table>
<tr>
<td>
<form method="get" action="/cgi-bin/swish.cgi" enctype="application/x-www-form-urlencoded" class="form">
<div>
<input maxlength="100" value="" type="text" name="query">
<input type="submit" value="Search" name="submit"></div>
</form></td>
</tr>
</table>
</td>
<td align="right">
<table class="LogoTable">
<tr>
<td><a href="http://www.zeroc.com"><img class="Logo" src="../images/logo.gif" alt="Logo"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<!-- SwishCommand index -->
</div>
</body>
</html>
|