| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Mon Jul 01 12:09:15 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>WebConsoleSecurityProvider2 (Apache Felix Web Management Console 3.1.6 API)</title> |
| <meta name="date" content="2013-07-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebConsoleSecurityProvider2 (Apache Felix Web Management Console 3.1.6 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../org/apache/felix/webconsole/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebConsoleSecurityProvider2.html">Use</a></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><a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/WebConsoleUtil.html" title="class in org.apache.felix.webconsole"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/webconsole/WebConsoleSecurityProvider2.html" target="_top">Frames</a></li> |
| <li><a href="WebConsoleSecurityProvider2.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.apache.felix.webconsole</div> |
| <h2 title="Interface WebConsoleSecurityProvider2" class="title">Interface WebConsoleSecurityProvider2</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html" title="interface in org.apache.felix.webconsole">WebConsoleSecurityProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">WebConsoleSecurityProvider2</span> |
| extends <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html" title="interface in org.apache.felix.webconsole">WebConsoleSecurityProvider</a></pre> |
| <div class="block">The <code>WebConsoleSecurityProvider2</code> extends the |
| <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html" title="interface in org.apache.felix.webconsole"><code>WebConsoleSecurityProvider</code></a> interface allowing for full control of |
| the authentication process to access the Web Console. |
| <p> |
| If a registered <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html" title="interface in org.apache.felix.webconsole"><code>WebConsoleSecurityProvider</code></a> service implements this |
| interface the <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider2.html#authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><code>authenticate(HttpServletRequest, HttpServletResponse)</code></a> |
| method is called instead of the |
| <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html#authenticate(java.lang.String, java.lang.String)"><code>WebConsoleSecurityProvider.authenticate(String, String)</code></a> method.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1.2; Web Console Bundle 3.1.4</dd></dl> |
| </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="overviewSummary" 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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider2.html#USER_ATTRIBUTE">USER_ATTRIBUTE</a></strong></code> |
| <div class="block">The name of the request attribute providing the object representing 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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider2.html#authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">authenticate</a></strong>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> |
| <div class="block">Authenticates the given request or asks the client for credentials.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.webconsole.WebConsoleSecurityProvider"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.felix.webconsole.<a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html" title="interface in org.apache.felix.webconsole">WebConsoleSecurityProvider</a></h3> |
| <code><a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html#authenticate(java.lang.String, java.lang.String)">authenticate</a>, <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html#authorize(java.lang.Object, java.lang.String)">authorize</a></code></li> |
| </ul> |
| </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="USER_ATTRIBUTE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>USER_ATTRIBUTE</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> USER_ATTRIBUTE</pre> |
| <div class="block">The name of the request attribute providing the object representing the |
| authenticated user. This object is used to call the |
| <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html#authorize(java.lang.Object, java.lang.String)"><code>WebConsoleSecurityProvider.authorize(Object, String)</code></a> to |
| authorize access for certain roles.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleSecurityProvider2.USER_ATTRIBUTE">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="authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>authenticate</h4> |
| <pre>boolean authenticate(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</pre> |
| <div class="block">Authenticates the given request or asks the client for credentials. |
| <p> |
| Implementations of this method are expected to respect and implement |
| the semantics of the <code>HttpContext.handleSecurity</code> method |
| as specified in the OSGi HTTP Service specification. |
| <p> |
| If this method returns <code>true</code> it is assumed the request |
| provided valid credentials identifying the user as accepted to access |
| the web console. In addition, the <a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider2.html#USER_ATTRIBUTE"><code>USER_ATTRIBUTE</code></a> request |
| attribute must be set to a non-<code>null</code> object reference |
| identifying the authenticated user. |
| <p> |
| If this method returns <code>false</code> the request to the web console |
| is terminated without any more response sent back to the client. That is |
| the implementation is expected to have informed the client in case of |
| non-granted access.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - The request object</dd><dd><code>response</code> - The response object</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> If the request provided valid credentials.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../org/apache/felix/webconsole/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebConsoleSecurityProvider2.html">Use</a></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><a href="../../../../org/apache/felix/webconsole/WebConsoleSecurityProvider.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/WebConsoleUtil.html" title="class in org.apache.felix.webconsole"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/webconsole/WebConsoleSecurityProvider2.html" target="_top">Frames</a></li> |
| <li><a href="WebConsoleSecurityProvider2.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
