| <!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>RESTSecurityTokenService (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="RESTSecurityTokenService (Apache CXF JavaDoc 3.4.5 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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="class-use/RESTSecurityTokenService.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>Prev Class</li> |
| <li><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.Action.html" title="enum in org.apache.cxf.sts.rest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cxf/sts/rest/RESTSecurityTokenService.html" target="_top">Frames</a></li> |
| <li><a href="RESTSecurityTokenService.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.cxf.sts.rest</div> |
| <h2 title="Interface RESTSecurityTokenService" class="title">Interface RESTSecurityTokenService</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenServiceImpl.html" title="class in org.apache.cxf.sts.rest">RESTSecurityTokenServiceImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@Path(value="/token") |
| public interface <span class="typeNameLabel">RESTSecurityTokenService</span></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.Action.html" title="enum in org.apache.cxf.sts.rest">RESTSecurityTokenService.Action</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="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>javax.ws.rs.core.Response</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#getJSONToken-java.lang.String-java.lang.String-java.util.List-java.lang.String-">getJSONToken</a></span>(<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> tokenType, |
| <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> keyType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> requestedClaims, |
| <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> appliesTo)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#getKeyExchangeToken-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-">getKeyExchangeToken</a></span>(<a href="../../../../../org/apache/cxf/ws/security/sts/provider/model/RequestSecurityTokenType.html" title="class in org.apache.cxf.ws.security.sts.provider.model">RequestSecurityTokenType</a> request)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#getPlainToken-java.lang.String-java.lang.String-java.util.List-java.lang.String-">getPlainToken</a></span>(<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> tokenType, |
| <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> keyType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> requestedClaims, |
| <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> appliesTo)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#getToken-org.apache.cxf.sts.rest.RESTSecurityTokenService.Action-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-">getToken</a></span>(<a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.Action.html" title="enum in org.apache.cxf.sts.rest">RESTSecurityTokenService.Action</a> action, |
| <a href="../../../../../org/apache/cxf/ws/security/sts/provider/model/RequestSecurityTokenType.html" title="class in org.apache.cxf.ws.security.sts.provider.model">RequestSecurityTokenType</a> request)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#getXMLToken-java.lang.String-java.lang.String-java.util.List-java.lang.String-boolean-">getXMLToken</a></span>(<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> tokenType, |
| <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> keyType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> requestedClaims, |
| <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> appliesTo, |
| boolean wstrustResponse)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#removeToken-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-">removeToken</a></span>(<a href="../../../../../org/apache/cxf/ws/security/sts/provider/model/RequestSecurityTokenType.html" title="class in org.apache.cxf.ws.security.sts.provider.model">RequestSecurityTokenType</a> request)</code> |
| <div class="block">Same as <a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#getToken-org.apache.cxf.sts.rest.RESTSecurityTokenService.Action-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-"><code>getToken(Action, RequestSecurityTokenType)</code></a> with 'cancel' action.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getXMLToken-java.lang.String-java.lang.String-java.util.List-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLToken</h4> |
| <pre>@GET |
| @Path(value="{tokenType}") |
| @Produces(value="application/xml") |
| javax.ws.rs.core.Response getXMLToken(@PathParam(value="tokenType") |
| <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> tokenType, |
| @QueryParam(value="keyType") |
| <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> keyType, |
| @QueryParam(value="claim") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> requestedClaims, |
| @QueryParam(value="appliesTo") |
| <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> appliesTo, |
| @QueryParam(value="wstrustResponse") @DefaultValue(value="false") |
| boolean wstrustResponse)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Issues required token type with default token settings.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJSONToken-java.lang.String-java.lang.String-java.util.List-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJSONToken</h4> |
| <pre>@GET |
| @Path(value="{tokenType}") |
| @Produces(value="application/json;qs=0.8") |
| javax.ws.rs.core.Response getJSONToken(@PathParam(value="tokenType") @DefaultValue(value="jwt") |
| <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> tokenType, |
| @QueryParam(value="keyType") |
| <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> keyType, |
| @QueryParam(value="claim") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> requestedClaims, |
| @QueryParam(value="appliesTo") |
| <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> appliesTo)</pre> |
| </li> |
| </ul> |
| <a name="getPlainToken-java.lang.String-java.lang.String-java.util.List-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPlainToken</h4> |
| <pre>@GET |
| @Path(value="{tokenType}") |
| @Produces(value="text/plain;qs=0.9") |
| javax.ws.rs.core.Response getPlainToken(@PathParam(value="tokenType") |
| <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> tokenType, |
| @QueryParam(value="keyType") |
| <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> keyType, |
| @QueryParam(value="claim") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> requestedClaims, |
| @QueryParam(value="appliesTo") |
| <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> appliesTo)</pre> |
| </li> |
| </ul> |
| <a name="getToken-org.apache.cxf.sts.rest.RESTSecurityTokenService.Action-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getToken</h4> |
| <pre>@POST |
| @Produces(value={"application/xml","application/json"}) |
| javax.ws.rs.core.Response getToken(@QueryParam(value="action") @DefaultValue(value="issue") |
| <a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.Action.html" title="enum in org.apache.cxf.sts.rest">RESTSecurityTokenService.Action</a> action, |
| <a href="../../../../../org/apache/cxf/ws/security/sts/provider/model/RequestSecurityTokenType.html" title="class in org.apache.cxf.ws.security.sts.provider.model">RequestSecurityTokenType</a> request)</pre> |
| </li> |
| </ul> |
| <a name="removeToken-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeToken</h4> |
| <pre>@DELETE |
| @Path(value="/") |
| @Produces(value={"application/xml","application/json"}) |
| javax.ws.rs.core.Response removeToken(<a href="../../../../../org/apache/cxf/ws/security/sts/provider/model/RequestSecurityTokenType.html" title="class in org.apache.cxf.ws.security.sts.provider.model">RequestSecurityTokenType</a> request)</pre> |
| <div class="block">Same as <a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.html#getToken-org.apache.cxf.sts.rest.RESTSecurityTokenService.Action-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-"><code>getToken(Action, RequestSecurityTokenType)</code></a> with 'cancel' action.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKeyExchangeToken-org.apache.cxf.ws.security.sts.provider.model.RequestSecurityTokenType-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getKeyExchangeToken</h4> |
| <pre>@POST |
| @Path(value="KeyExchangeToken") |
| @Produces(value={"application/xml","application/json"}) |
| javax.ws.rs.core.Response getKeyExchangeToken(<a href="../../../../../org/apache/cxf/ws/security/sts/provider/model/RequestSecurityTokenType.html" title="class in org.apache.cxf.ws.security.sts.provider.model">RequestSecurityTokenType</a> request)</pre> |
| </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/RESTSecurityTokenService.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>Prev Class</li> |
| <li><a href="../../../../../org/apache/cxf/sts/rest/RESTSecurityTokenService.Action.html" title="enum in org.apache.cxf.sts.rest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cxf/sts/rest/RESTSecurityTokenService.html" target="_top">Frames</a></li> |
| <li><a href="RESTSecurityTokenService.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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>Apache CXF</small></p> |
| </body> |
| </html> |
