| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>OAuthRequestInterceptor (Apache CXF JavaDoc 3.4.5 API)</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="OAuthRequestInterceptor (Apache CXF JavaDoc 3.4.5 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="class-use/OAuthRequestInterceptor.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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthScopesFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html" target="_top">Frames</a></li> |
| <li><a href="OAuthRequestInterceptor.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="#fields.inherited.from.class.org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.cxf.rs.security.oauth2.filters</div> |
| <h2 title="Class OAuthRequestInterceptor" class="title">Class OAuthRequestInterceptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html" title="class in org.apache.cxf.rs.security.oauth2.services">org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters">org.apache.cxf.rs.security.oauth2.filters.OAuthRequestFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cxf.rs.security.oauth2.filters.OAuthRequestInterceptor</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>javax.ws.rs.container.ContainerRequestFilter, <a href="../../../../../../../org/apache/cxf/interceptor/Interceptor.html" title="interface in org.apache.cxf.interceptor">Interceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>>, <a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">OAuthRequestInterceptor</span> |
| extends <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters">OAuthRequestFilter</a> |
| implements <a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></pre> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cxf.rs.security.oauth2.services.<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html" title="class in org.apache.cxf.rs.security.oauth2.services">AbstractAccessTokenValidator</a></h3> |
| <code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#realm">realm</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#supportedSchemes">supportedSchemes</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#OAuthRequestInterceptor--">OAuthRequestInterceptor</a></span>()</code> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><? extends <a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#getAdditionalInterceptors--">getAdditionalInterceptors</a></span>()</code> |
| <div class="block">Returns a collection of Interceptors that should be added to the chain |
| whenever this interceptor is added.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#getAfter--">getAfter</a></span>()</code> |
| <div class="block">Returns a set containing the IDs of the interceptors that should be |
| executed before this interceptor.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#getAuthorizationParts-org.apache.cxf.message.Message-">getAuthorizationParts</a></span>(<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#getBefore--">getBefore</a></span>()</code> |
| <div class="block">Returns a set containing the IDs of the interceptors that should be |
| executed after this interceptor.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#getId--">getId</a></span>()</code> |
| <div class="block">Returns the ID of this interceptor.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#getPhase--">getPhase</a></span>()</code> |
| <div class="block">Returns the phase in which this interceptor is excecuted.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#handleFault-org.apache.cxf.message.Message-">handleFault</a></span>(<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message)</code> |
| <div class="block">Called for all interceptors (in reverse order) on which handleMessage |
| had been successfully invoked, when normal execution of the chain was |
| aborted for some reason.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html#handleMessage-org.apache.cxf.message.Message-">handleMessage</a></span>(<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message)</code> |
| <div class="block">Intercepts a message.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cxf.rs.security.oauth2.filters.OAuthRequestFilter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cxf.rs.security.oauth2.filters.<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters">OAuthRequestFilter</a></h3> |
| <code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#checkHttpVerb-javax.servlet.http.HttpServletRequest-java.util.List-">checkHttpVerb</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#checkRequestURI-javax.servlet.http.HttpServletRequest-java.util.List-org.apache.cxf.message.Message-">checkRequestURI</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#checkScopeProperty-java.lang.String-">checkScopeProperty</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#createSecurityContext-javax.servlet.http.HttpServletRequest-org.apache.cxf.rs.security.oauth2.common.AccessTokenValidation-">createSecurityContext</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#filter-javax.ws.rs.container.ContainerRequestContext-">filter</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#getAudience--">getAudience</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#getTokenFromFormData-org.apache.cxf.message.Message-">getTokenFromFormData</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#isCompleteAudienceMatch--">isCompleteAudienceMatch</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#isCorsRequest-org.apache.cxf.message.Message-">isCorsRequest</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setAllPermissionsMatch-boolean-">setAllPermissionsMatch</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setAudience-java.lang.String-">setAudience</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setAudienceIsEndpointAddress-boolean-">setAudienceIsEndpointAddress</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setBlockPublicClients-boolean-">setBlockPublicClients</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setCheckFormData-boolean-">setCheckFormData</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setCompleteAudienceMatch-boolean-">setCompleteAudienceMatch</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setIssuer-java.lang.String-">setIssuer</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setRequiredScopes-java.util.List-">setRequiredScopes</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setTokenSubjectAuthenticationMethod-org.apache.cxf.rs.security.oauth2.common.AuthenticationMethod-">setTokenSubjectAuthenticationMethod</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#setUseUserSubject-boolean-">setUseUserSubject</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#validateAudiences-java.util.List-">validateAudiences</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#validateRequest-org.apache.cxf.message.Message-">validateRequest</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cxf.rs.security.oauth2.services.<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html" title="class in org.apache.cxf.rs.security.oauth2.services">AbstractAccessTokenValidator</a></h3> |
| <code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#findTokenValidator-java.lang.String-">findTokenValidator</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#getAccessTokenValidation-java.lang.String-java.lang.String-javax.ws.rs.core.MultivaluedMap-">getAccessTokenValidation</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#getJwtTokenConsumer--">getJwtTokenConsumer</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#getMessageContext--">getMessageContext</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#isPersistJwtEncoding--">isPersistJwtEncoding</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#removeAccessToken-org.apache.cxf.rs.security.oauth2.common.ServerAccessToken-">removeAccessToken</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setDataProvider-org.apache.cxf.rs.security.oauth2.provider.OAuthDataProvider-">setDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setJwtTokenConsumer-org.apache.cxf.rs.security.jose.jwt.JoseJwtConsumer-">setJwtTokenConsumer</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setMaxValidationDataCacheSize-int-">setMaxValidationDataCacheSize</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setMessageContext-org.apache.cxf.jaxrs.ext.MessageContext-">setMessageContext</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setPersistJwtEncoding-boolean-">setPersistJwtEncoding</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setRealm-java.lang.String-">setRealm</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setTokenValidator-org.apache.cxf.rs.security.oauth2.provider.AccessTokenValidator-">setTokenValidator</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/services/AbstractAccessTokenValidator.html#setTokenValidators-java.util.List-">setTokenValidators</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="OAuthRequestInterceptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>OAuthRequestInterceptor</h4> |
| <pre>public OAuthRequestInterceptor()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="handleMessage-org.apache.cxf.message.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleMessage</h4> |
| <pre>public void handleMessage(<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message) |
| throws <a href="../../../../../../../org/apache/cxf/interceptor/Fault.html" title="class in org.apache.cxf.interceptor">Fault</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/interceptor/Interceptor.html#handleMessage-T-">Interceptor</a></code></span></div> |
| <div class="block">Intercepts a message. |
| Interceptors should NOT invoke handleMessage or handleFault |
| on the next interceptor - the interceptor chain will |
| take care of this.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/interceptor/Interceptor.html#handleMessage-T-">handleMessage</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/interceptor/Interceptor.html" title="interface in org.apache.cxf.interceptor">Interceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/interceptor/Fault.html" title="class in org.apache.cxf.interceptor">Fault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthorizationParts-org.apache.cxf.message.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthorizationParts</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getAuthorizationParts(<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html#getAuthorizationParts-org.apache.cxf.message.Message-">getAuthorizationParts</a></code> in class <code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters">OAuthRequestFilter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAdditionalInterceptors--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdditionalInterceptors</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><? extends <a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>>> getAdditionalInterceptors()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getAdditionalInterceptors--">PhaseInterceptor</a></code></span></div> |
| <div class="block">Returns a collection of Interceptors that should be added to the chain |
| whenever this interceptor is added. May return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getAdditionalInterceptors--">getAdditionalInterceptors</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the collection of interceptors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAfter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAfter</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getAfter()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getAfter--">PhaseInterceptor</a></code></span></div> |
| <div class="block">Returns a set containing the IDs of the interceptors that should be |
| executed before this interceptor. This interceptor will be placed |
| in the chain after the interceptors in the set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getAfter--">getAfter</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the IDs of the interceptors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBefore--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBefore</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getBefore()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getBefore--">PhaseInterceptor</a></code></span></div> |
| <div class="block">Returns a set containing the IDs of the interceptors that should be |
| executed after this interceptor. This interceptor will be placed in |
| the inteceptor chain before the interceptors in the set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getBefore--">getBefore</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ids of the interceptors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getId()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getId--">PhaseInterceptor</a></code></span></div> |
| <div class="block">Returns the ID of this interceptor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getId--">getId</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ID</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPhase--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPhase</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPhase()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getPhase--">PhaseInterceptor</a></code></span></div> |
| <div class="block">Returns the phase in which this interceptor is excecuted.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html#getPhase--">getPhase</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/phase/PhaseInterceptor.html" title="interface in org.apache.cxf.phase">PhaseInterceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the phase</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleFault-org.apache.cxf.message.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>handleFault</h4> |
| <pre>public void handleFault(<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/interceptor/Interceptor.html#handleFault-T-">Interceptor</a></code></span></div> |
| <div class="block">Called for all interceptors (in reverse order) on which handleMessage |
| had been successfully invoked, when normal execution of the chain was |
| aborted for some reason.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/interceptor/Interceptor.html#handleFault-T-">handleFault</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/interceptor/Interceptor.html" title="interface in org.apache.cxf.interceptor">Interceptor</a><<a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>></code></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="class-use/OAuthRequestInterceptor.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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthRequestFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/filters/OAuthScopesFilter.html" title="class in org.apache.cxf.rs.security.oauth2.filters"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/filters/OAuthRequestInterceptor.html" target="_top">Frames</a></li> |
| <li><a href="OAuthRequestInterceptor.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="#fields.inherited.from.class.org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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>Apache CXF</small></p> |
| </body> |
| </html> |