/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/http/HttpContext.html is in libosgi-compendium-java-doc 5.0.0-5.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>HttpContext</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpContext";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/osgi/service/http/HttpService.html" title="interface in org.osgi.service.http"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/http/HttpContext.html" target="_top">Frames</a></li>
<li><a href="HttpContext.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.osgi.service.http</div>
<h2 title="Interface HttpContext" class="title">Interface HttpContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">HttpContext</span></pre>
<div class="block">This interface defines methods that the Http Service may call to get
information about a registration.
<p>
Servlets and resources may be registered with an <code>HttpContext</code> object;
if no <code>HttpContext</code> object is specified, a default <code>HttpContext</code>
object is used. Servlets that are registered using the same
<code>HttpContext</code> object will share the same <code>ServletContext</code> object.
<p>
This interface is implemented by users of the <code>HttpService</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/http/HttpContext.html#AUTHENTICATION_TYPE">AUTHENTICATION_TYPE</a></span></code>
<div class="block"><code>HttpServletRequest</code> attribute specifying the scheme used in
authentication.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/http/HttpContext.html#AUTHORIZATION">AUTHORIZATION</a></span></code>
<div class="block"><code>HttpServletRequest</code> attribute specifying the <code>Authorization</code>
object obtained from the <code>org.osgi.service.useradmin.UserAdmin</code>
service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/http/HttpContext.html#REMOTE_USER">REMOTE_USER</a></span></code>
<div class="block"><code>HttpServletRequest</code> attribute specifying the name of the
authenticated user.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/http/HttpContext.html#getMimeType-java.lang.String-">getMimeType</a></span>(java.lang.String name)</code>
<div class="block">Maps a name to a MIME type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.net.URL</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/http/HttpContext.html#getResource-java.lang.String-">getResource</a></span>(java.lang.String name)</code>
<div class="block">Maps a resource name to a URL.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/http/HttpContext.html#handleSecurity-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">handleSecurity</a></span>(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)</code>
<div class="block">Handles security for the specified request.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="REMOTE_USER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REMOTE_USER</h4>
<pre>static final java.lang.String REMOTE_USER</pre>
<div class="block"><code>HttpServletRequest</code> attribute specifying the name of the
authenticated user. The value of the attribute can be retrieved by
<code>HttpServletRequest.getRemoteUser</code>. This attribute name is
<code>org.osgi.service.http.authentication.remote.user</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.http.HttpContext.REMOTE_USER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="AUTHENTICATION_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AUTHENTICATION_TYPE</h4>
<pre>static final java.lang.String AUTHENTICATION_TYPE</pre>
<div class="block"><code>HttpServletRequest</code> attribute specifying the scheme used in
authentication. The value of the attribute can be retrieved by
<code>HttpServletRequest.getAuthType</code>. This attribute name is
<code>org.osgi.service.http.authentication.type</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.http.HttpContext.AUTHENTICATION_TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="AUTHORIZATION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AUTHORIZATION</h4>
<pre>static final java.lang.String AUTHORIZATION</pre>
<div class="block"><code>HttpServletRequest</code> attribute specifying the <code>Authorization</code>
object obtained from the <code>org.osgi.service.useradmin.UserAdmin</code>
service. The value of the attribute can be retrieved by
<code>HttpServletRequest.getAttribute(HttpContext.AUTHORIZATION)</code>. This
attribute name is <code>org.osgi.service.useradmin.authorization</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.http.HttpContext.AUTHORIZATION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="handleSecurity-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleSecurity</h4>
<pre>boolean handleSecurity(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.io.IOException</pre>
<div class="block">Handles security for the specified request.
<p>
The Http Service calls this method prior to servicing the specified
request. This method controls whether the request is processed in the
normal manner or an error is returned.
<p>
If the request requires authentication and the Authorization header in
the request is missing or not acceptable, then this method should set the
WWW-Authenticate header in the response object, set the status in the
response object to Unauthorized(401) and return <code>false</code>. See also
RFC 2617: <i>HTTP Authentication: Basic and Digest Access Authentication
</i> (available at http://www.ietf.org/rfc/rfc2617.txt).
<p>
If the request requires a secure connection and the <code>getScheme</code>
method in the request does not return 'https' or some other acceptable
secure protocol, then this method should set the status in the response
object to Forbidden(403) and return <code>false</code>.
<p>
When this method returns <code>false</code>, the Http Service will send the
response back to the client, thereby completing the request. When this
method returns <code>true</code>, the Http Service will proceed with servicing
the request.
<p>
If the specified request has been authenticated, this method must set the
<a href="../../../../org/osgi/service/http/HttpContext.html#AUTHENTICATION_TYPE"><code>AUTHENTICATION_TYPE</code></a> request attribute to the type of
authentication used, and the <a href="../../../../org/osgi/service/http/HttpContext.html#REMOTE_USER"><code>REMOTE_USER</code></a> request attribute to
the remote user (request attributes are set using the
<code>setAttribute</code> method on the request). If this method does not
perform any authentication, it must not set these attributes.
<p>
If the authenticated user is also authorized to access certain resources,
this method must set the <a href="../../../../org/osgi/service/http/HttpContext.html#AUTHORIZATION"><code>AUTHORIZATION</code></a> request attribute to the
<code>Authorization</code> object obtained from the
<code>org.osgi.service.useradmin.UserAdmin</code> service.
<p>
The servlet responsible for servicing the specified request determines
the authentication type and remote user by calling the
<code>getAuthType</code> and <code>getRemoteUser</code> methods, respectively, on
the request.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the HTTP request</dd>
<dd><code>response</code> - the HTTP response</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the request should be serviced, <code>false</code> if
the request should not be serviced and Http Service will send the
response back to the client.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - may be thrown by this method. If this occurs,
the Http Service will terminate the request and close the socket.</dd>
</dl>
</li>
</ul>
<a name="getResource-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResource</h4>
<pre>java.net.URL getResource(java.lang.String name)</pre>
<div class="block">Maps a resource name to a URL.
<p>
Called by the Http Service to map a resource name to a URL. For servlet
registrations, Http Service will call this method to support the
<code>ServletContext</code> methods <code>getResource</code> and
<code>getResourceAsStream</code>. For resource registrations, Http Service
will call this method to locate the named resource. The context can
control from where resources come. For example, the resource can be
mapped to a file in the bundle's persistent storage area via
<code>bundleContext.getDataFile(name).toURL()</code> or to a resource in the
context's bundle via <code>getClass().getResource(name)</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the requested resource</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL that Http Service can use to read the resource or
<code>null</code> if the resource does not exist.</dd>
</dl>
</li>
</ul>
<a name="getMimeType-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMimeType</h4>
<pre>java.lang.String getMimeType(java.lang.String name)</pre>
<div class="block">Maps a name to a MIME type.
Called by the Http Service to determine the MIME type for the name. For
servlet registrations, the Http Service will call this method to support
the <code>ServletContext</code> method <code>getMimeType</code>. For resource
registrations, the Http Service will call this method to determine the
MIME type for the Content-Type header in the response.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - determine the MIME type for this name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MIME type (e.g. text/html) of the name or <code>null</code> to
indicate that the Http Service should determine the MIME type
itself.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/osgi/service/http/HttpService.html" title="interface in org.osgi.service.http"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/http/HttpContext.html" target="_top">Frames</a></li>
<li><a href="HttpContext.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|