/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/http/HttpService.html is in libosgi-compendium-java-doc 4.3.0-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Mon Nov 21 22:05:29 UTC 2011 -->
<TITLE>
HttpService
</TITLE>
<META NAME="date" CONTENT="2011-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpService";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/http/NamespaceException.html" title="class in org.osgi.service.http"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/http/HttpService.html" target="_top"><B>FRAMES</B></A>
<A HREF="HttpService.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.osgi.service.http</FONT>
<BR>
Interface HttpService</H2>
<HR>
<DL>
<DT><PRE>public interface <B>HttpService</B></DL>
</PRE>
<P>
The Http Service allows other bundles in the OSGi environment to dynamically
register resources and servlets into the URI namespace of Http Service. A
bundle may later unregister its resources or servlets.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http"><CODE>HttpContext</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http">HttpContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/http/HttpService.html#createDefaultHttpContext()">createDefaultHttpContext</A></B>()</CODE>
<BR>
Creates a default <code>HttpContext</code> for registering servlets or
resources with the HttpService, a new <code>HttpContext</code> object is
created each time this method is called.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/http/HttpService.html#registerResources(java.lang.String, java.lang.String, org.osgi.service.http.HttpContext)">registerResources</A></B>(java.lang.String alias,
java.lang.String name,
<A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http">HttpContext</A> context)</CODE>
<BR>
Registers resources into the URI namespace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/http/HttpService.html#registerServlet(java.lang.String, javax.servlet.Servlet, java.util.Dictionary, org.osgi.service.http.HttpContext)">registerServlet</A></B>(java.lang.String alias,
javax.servlet.Servlet servlet,
java.util.Dictionary initparams,
<A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http">HttpContext</A> context)</CODE>
<BR>
Registers a servlet into the URI namespace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/http/HttpService.html#unregister(java.lang.String)">unregister</A></B>(java.lang.String alias)</CODE>
<BR>
Unregisters a previous registration done by <code>registerServlet</code> or
<code>registerResources</code> methods.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="registerServlet(java.lang.String, javax.servlet.Servlet, java.util.Dictionary, org.osgi.service.http.HttpContext)"><!-- --></A><H3>
registerServlet</H3>
<PRE>
void <B>registerServlet</B>(java.lang.String alias,
javax.servlet.Servlet servlet,
java.util.Dictionary initparams,
<A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http">HttpContext</A> context)
throws javax.servlet.ServletException,
<A HREF="../../../../org/osgi/service/http/NamespaceException.html" title="class in org.osgi.service.http">NamespaceException</A></PRE>
<DL>
<DD>Registers a servlet into the URI namespace.
<p>
The alias is the name in the URI namespace of the Http Service at which
the registration will be mapped.
<p>
An alias must begin with slash ('/') and must not end with slash ('/'),
with the exception that an alias of the form "/" is used to
denote the root alias. See the specification text for details on how HTTP
requests are mapped to servlet and resource registrations.
<p>
The Http Service will call the servlet's <code>init</code> method before
returning.
<pre>
httpService.registerServlet("/myservlet", servlet, initparams, context);
</pre>
<p>
Servlets registered with the same <code>HttpContext</code> object will share
the same <code>ServletContext</code>. The Http Service will call the
<code>context</code> argument to support the <code>ServletContext</code> methods
<code>getResource</code>,<code>getResourceAsStream</code> and <code>getMimeType</code>,
and to handle security for requests. If the <code>context</code> argument is
<code>null</code>, a default <code>HttpContext</code> object is used (see
<A HREF="../../../../org/osgi/service/http/HttpService.html#createDefaultHttpContext()"><CODE>createDefaultHttpContext()</CODE></A>).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>alias</CODE> - name in the URI namespace at which the servlet is registered<DD><CODE>servlet</CODE> - the servlet object to register<DD><CODE>initparams</CODE> - initialization arguments for the servlet or
<code>null</code> if there are none. This argument is used by the
servlet's <code>ServletConfig</code> object.<DD><CODE>context</CODE> - the <code>HttpContext</code> object for the registered servlet,
or <code>null</code> if a default <code>HttpContext</code> is to be created
and used.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/osgi/service/http/NamespaceException.html" title="class in org.osgi.service.http">NamespaceException</A></CODE> - if the registration fails because the alias is
already in use.
<DD><CODE>javax.servlet.ServletException</CODE> - if the servlet's <code>init</code>
method throws an exception, or the given servlet object has
already been registered at a different alias.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if any of the arguments are
invalid</DL>
</DD>
</DL>
<HR>
<A NAME="registerResources(java.lang.String, java.lang.String, org.osgi.service.http.HttpContext)"><!-- --></A><H3>
registerResources</H3>
<PRE>
void <B>registerResources</B>(java.lang.String alias,
java.lang.String name,
<A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http">HttpContext</A> context)
throws <A HREF="../../../../org/osgi/service/http/NamespaceException.html" title="class in org.osgi.service.http">NamespaceException</A></PRE>
<DL>
<DD>Registers resources into the URI namespace.
<p>
The alias is the name in the URI namespace of the Http Service at which
the registration will be mapped. An alias must begin with slash ('/') and
must not end with slash ('/'), with the exception that an alias of the
form "/" is used to denote the root alias. The name parameter
must also not end with slash ('/') with the exception that a name of the
form "/" is used to denote the root of the bundle. See the
specification text for details on how HTTP requests are mapped to servlet
and resource registrations.
<p>
For example, suppose the resource name /tmp is registered to the alias
/files. A request for /files/foo.txt will map to the resource name
/tmp/foo.txt.
<pre>
httpservice.registerResources("/files", "/tmp", context);
</pre>
The Http Service will call the <code>HttpContext</code> argument to map
resource names to URLs and MIME types and to handle security for
requests. If the <code>HttpContext</code> argument is <code>null</code>, a default
<code>HttpContext</code> is used (see <A HREF="../../../../org/osgi/service/http/HttpService.html#createDefaultHttpContext()"><CODE>createDefaultHttpContext()</CODE></A>).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>alias</CODE> - name in the URI namespace at which the resources are
registered<DD><CODE>name</CODE> - the base name of the resources that will be registered<DD><CODE>context</CODE> - the <code>HttpContext</code> object for the registered
resources, or <code>null</code> if a default <code>HttpContext</code> is to
be created and used.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/osgi/service/http/NamespaceException.html" title="class in org.osgi.service.http">NamespaceException</A></CODE> - if the registration fails because the alias is
already in use.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if any of the parameters are
invalid</DL>
</DD>
</DL>
<HR>
<A NAME="unregister(java.lang.String)"><!-- --></A><H3>
unregister</H3>
<PRE>
void <B>unregister</B>(java.lang.String alias)</PRE>
<DL>
<DD>Unregisters a previous registration done by <code>registerServlet</code> or
<code>registerResources</code> methods.
<p>
After this call, the registered alias in the URI name-space will no
longer be available. If the registration was for a servlet, the Http
Service must call the <code>destroy</code> method of the servlet before
returning.
<p>
If the bundle which performed the registration is stopped or otherwise
"unget"s the Http Service without calling <A HREF="../../../../org/osgi/service/http/HttpService.html#unregister(java.lang.String)"><CODE>unregister(String)</CODE></A>
then Http Service must automatically unregister the registration.
However, if the registration was for a servlet, the <code>destroy</code>
method of the servlet will not be called in this case since the bundle
may be stopped. <A HREF="../../../../org/osgi/service/http/HttpService.html#unregister(java.lang.String)"><CODE>unregister(String)</CODE></A> must be explicitly called to
cause the <code>destroy</code> method of the servlet to be called. This can be
done in the <code>BundleActivator.stop</code> method of the bundle registering
the servlet.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>alias</CODE> - name in the URI name-space of the registration to unregister
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if there is no registration
for the alias or the calling bundle was not the bundle which
registered the alias.</DL>
</DD>
</DL>
<HR>
<A NAME="createDefaultHttpContext()"><!-- --></A><H3>
createDefaultHttpContext</H3>
<PRE>
<A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http">HttpContext</A> <B>createDefaultHttpContext</B>()</PRE>
<DL>
<DD>Creates a default <code>HttpContext</code> for registering servlets or
resources with the HttpService, a new <code>HttpContext</code> object is
created each time this method is called.
<p>
The behavior of the methods on the default <code>HttpContext</code> is
defined as follows:
<ul>
<li><code>getMimeType</code>- Does not define any customized MIME types
for the Content-Type header in the response, and always returns
<code>null</code>.
<li><code>handleSecurity</code>- Performs implementation-defined
authentication on the request.
<li><code>getResource</code>- Assumes the named resource is in the
context bundle; this method calls the context bundle's
<code>Bundle.getResource</code> method, and returns the appropriate URL to
access the resource. On a Java runtime environment that supports
permissions, the Http Service needs to be granted
<code>org.osgi.framework.AdminPermission[*,RESOURCE]</code>.
</ul>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a default <code>HttpContext</code> object.<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/osgi/service/http/HttpContext.html" title="interface in org.osgi.service.http"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/http/NamespaceException.html" title="class in org.osgi.service.http"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/http/HttpService.html" target="_top"><B>FRAMES</B></A>
<A HREF="HttpService.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|