| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>SecurityScheme (Apache Juneau 9.0.0)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.juneau.dto.swagger, class: SecurityScheme"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.juneau.dto.swagger</a></div> |
| <h1 title="Class SecurityScheme" class="title">Class SecurityScheme</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">org.apache.juneau.dto.swagger.SwaggerElement</a> |
| <div class="inheritance">org.apache.juneau.dto.swagger.SecurityScheme</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../../annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../annotation/Bean.html#properties()">properties</a>="type,description,name,in,flow,authorizationUrl,tokenUrl,scopes,*") |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-64">SecurityScheme</a></span> |
| <span class="extends-implements">extends <a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></span></div> |
| <div class="block">Allows the definition of a security scheme that can be used by the operations. |
| |
| <p> |
| Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's |
| common flows (implicit, password, application and access code). |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bjson'> |
| <jc>// Basic authentication sample</jc> |
| { |
| <js>"type"</js>: <js>"basic"</js> |
| } |
| |
| <jc>// API key sample</jc> |
| { |
| <js>"type"</js>: <js>"apiKey"</js>, |
| <js>"name"</js>: <js>"api_key"</js>, |
| <js>"in"</js>: <js>"header"</js> |
| } |
| |
| <jc>// Implicit OAuth2 sample</jc> |
| { |
| <js>"type"</js>: <js>"oauth2"</js>, |
| <js>"authorizationUrl"</js>: <js>"http://swagger.io/api/oauth/dialog"</js>, |
| <js>"flow"</js>: <js>"implicit"</js>, |
| <js>"scopes"</js>: { |
| <js>"write:pets"</js>: <js>"modify pets in your account"</js>, |
| <js>"read:pets"</js>: <js>"read your pets"</js> |
| } |
| } |
| </p> |
| |
| <h5 class='section'>See Also:</h5><ul> |
| <li class='link'><a class="doclink" href="../../../../../index.html#jrs.Swagger">Overview > juneau-rest-server > Swagger</a> |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SecurityScheme</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Default constructor.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.juneau.dto.swagger.SecurityScheme)" class="member-name-link">SecurityScheme</a><wbr>(<a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a> copyFrom)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Copy constructor.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addScope(java.lang.String,java.lang.String)" class="member-name-link">addScope</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property appender: <property>scopes</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Make a deep copy of this object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.String,java.lang.Class)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Generic property getter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAuthorizationUrl()" class="member-name-link">getAuthorizationUrl</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>authorizationUrl</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDescription()" class="member-name-link">getDescription</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>description</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFlow()" class="member-name-link">getFlow</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>flow</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIn()" class="member-name-link">getIn</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>in</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>name</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScopes()" class="member-name-link">getScopes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>scopes</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTokenUrl()" class="member-name-link">getTokenUrl</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>tokenUrl</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()" class="member-name-link">getType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property getter: <property>type</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keySet()" class="member-name-link">keySet</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns all the keys on this element.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(java.lang.String,java.lang.Object)" class="member-name-link">set</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Generic property setter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAuthorizationUrl(java.lang.String)" class="member-name-link">setAuthorizationUrl</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>authorizationUrl</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDescription(java.lang.String)" class="member-name-link">setDescription</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>description</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFlow(java.lang.String)" class="member-name-link">setFlow</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>flow</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIn(java.lang.String)" class="member-name-link">setIn</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>in</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setName(java.lang.String)" class="member-name-link">setName</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>name</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setScopes(java.util.Map)" class="member-name-link">setScopes</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>scopes</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTokenUrl(java.lang.String)" class="member-name-link">setTokenUrl</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>tokenUrl</property>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setType(java.lang.String)" class="member-name-link">setType</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Bean property setter: <property>type</property>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#strict()" class="member-name-link">strict</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets strict mode on this bean.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.juneau.dto.swagger.SwaggerElement">Methods inherited from class org.apache.juneau.dto.swagger.<a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></h3> |
| <code><a href="SwaggerElement.html#asMap()">asMap</a>, <a href="SwaggerElement.html#extraKeys()">extraKeys</a>, <a href="SwaggerElement.html#get(java.lang.String)">get</a>, <a href="SwaggerElement.html#isStrict()">isStrict</a>, <a href="SwaggerElement.html#strict(java.lang.Object)">strict</a>, <a href="SwaggerElement.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>SecurityScheme</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-83">SecurityScheme</a></span>()</div> |
| <div class="block">Default constructor.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.juneau.dto.swagger.SecurityScheme)"> |
| <h3>SecurityScheme</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-90">SecurityScheme</a></span><wbr><span class="parameters">(<a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a> copyFrom)</span></div> |
| <div class="block">Copy constructor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>copyFrom</code> - The object to copy.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="copy()"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-108">copy</a></span>()</div> |
| <div class="block">Make a deep copy of this object.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A deep copy of this object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="strict()"> |
| <h3>strict</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-113">strict</a></span>()</div> |
| <div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="SwaggerElement.html#strict()">SwaggerElement</a></code></span></div> |
| <div class="block">Sets strict mode on this bean.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SwaggerElement.html#strict()">strict</a></code> in class <code><a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAuthorizationUrl()"> |
| <h3>getAuthorizationUrl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-131">getAuthorizationUrl</a></span>()</div> |
| <div class="block">Bean property getter: <property>authorizationUrl</property>. |
| |
| <p> |
| The authorization URL to be used for this flow.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAuthorizationUrl(java.lang.String)"> |
| <h3>setAuthorizationUrl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-147">setAuthorizationUrl</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property setter: <property>authorizationUrl</property>. |
| |
| <p> |
| The authorization URL to be used for this flow.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>This SHOULD be in the form of a URL. |
| <br>Can be <jk>null</jk> to unset the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescription()"> |
| <h3>getDescription</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-160">getDescription</a></span>()</div> |
| <div class="block">Bean property getter: <property>description</property>. |
| |
| <p> |
| A short description for security scheme.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDescription(java.lang.String)"> |
| <h3>setDescription</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-175">setDescription</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property setter: <property>description</property>. |
| |
| <p> |
| A short description for security scheme.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>Can be <jk>null</jk> to unset the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFlow()"> |
| <h3>getFlow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-188">getFlow</a></span>()</div> |
| <div class="block">Bean property getter: <property>flow</property>. |
| |
| <p> |
| The flow used by the OAuth2 security scheme.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFlow(java.lang.String)"> |
| <h3>setFlow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-210">setFlow</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property setter: <property>flow</property>. |
| |
| <p> |
| The flow used by the OAuth2 security scheme.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>Valid values: |
| <ul> |
| <li><js>"implicit"</js> |
| <li><js>"password"</js> |
| <li><js>"application"</js> |
| <li><js>"accessCode"</js> |
| </ul> |
| <br>Can be <jk>null</jk> to unset the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIn()"> |
| <h3>getIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-223">getIn</a></span>()</div> |
| <div class="block">Bean property getter: <property>in</property>. |
| |
| <p> |
| The location of the API key.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIn(java.lang.String)"> |
| <h3>setIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-243">setIn</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property setter: <property>in</property>. |
| |
| <p> |
| The location of the API key.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>Valid values: |
| <ul> |
| <li><js>"query"</js> |
| <li><js>"header"</js> |
| </ul> |
| <br>Can be <jk>null</jk> to unset the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-256">getName</a></span>()</div> |
| <div class="block">Bean property getter: <property>name</property>. |
| |
| <p> |
| The name of the header or query parameter to be used.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setName(java.lang.String)"> |
| <h3>setName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-271">setName</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property setter: <property>name</property>. |
| |
| <p> |
| The name of the header or query parameter to be used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>Can be <jk>null</jk> to unset the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScopes()"> |
| <h3>getScopes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-284">getScopes</a></span>()</div> |
| <div class="block">Bean property getter: <property>scopes</property>. |
| |
| <p> |
| The available scopes for the OAuth2 security scheme.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setScopes(java.util.Map)"> |
| <h3>setScopes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-299">setScopes</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> value)</span></div> |
| <div class="block">Bean property setter: <property>scopes</property>. |
| |
| <p> |
| The available scopes for the OAuth2 security scheme.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>Can be <jk>null</jk> to unset the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addScope(java.lang.String,java.lang.String)"> |
| <h3>addScope</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-314">addScope</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property appender: <property>scopes</property>. |
| |
| <p> |
| The available scopes for the OAuth2 security scheme.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The scope key.</dd> |
| <dd><code>value</code> - The scope value.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTokenUrl()"> |
| <h3>getTokenUrl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-327">getTokenUrl</a></span>()</div> |
| <div class="block">Bean property getter: <property>tokenUrl</property>. |
| |
| <p> |
| The token URL to be used for this flow.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTokenUrl(java.lang.String)"> |
| <h3>setTokenUrl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-343">setTokenUrl</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property setter: <property>tokenUrl</property>. |
| |
| <p> |
| The token URL to be used for this flow.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>This SHOULD be in the form of a URL. |
| <br>Can be <jk>null</jk> to unset the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getType()"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-356">getType</a></span>()</div> |
| <div class="block">Bean property getter: <property>type</property>. |
| |
| <p> |
| The type of the security scheme.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setType(java.lang.String)"> |
| <h3>setType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-377">setType</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block">Bean property setter: <property>type</property>. |
| |
| <p> |
| The type of the security scheme.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The new value for this property. |
| <br>Valid values: |
| <ul> |
| <li><js>"basic"</js> |
| <li><js>"apiKey"</js> |
| <li><js>"oauth2"</js> |
| </ul> |
| <br>Property value is required.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(java.lang.String,java.lang.Class)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-391">get</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> type)</span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="SwaggerElement.html#get(java.lang.String,java.lang.Class)">SwaggerElement</a></code></span></div> |
| <div class="block">Generic property getter. |
| |
| <p> |
| Can be used to retrieve non-standard Swagger fields such as <js>"$ref"</js>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SwaggerElement.html#get(java.lang.String,java.lang.Class)">get</a></code> in class <code><a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The datatype to cast the value to.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>property</code> - The property name to retrieve.</dd> |
| <dd><code>type</code> - The datatype to cast the value to.</dd> |
| <dt>Returns:</dt> |
| <dd>The property value, or <jk>null</jk> if the property does not exist or is not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set(java.lang.String,java.lang.Object)"> |
| <h3>set</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-408">set</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="SwaggerElement.html#set(java.lang.String,java.lang.Object)">SwaggerElement</a></code></span></div> |
| <div class="block">Generic property setter. |
| |
| <p> |
| Can be used to set non-standard Swagger fields such as <js>"$ref"</js>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SwaggerElement.html#set(java.lang.String,java.lang.Object)">set</a></code> in class <code><a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>property</code> - The property name to set.</dd> |
| <dd><code>value</code> - The new value for the property.</dd> |
| <dt>Returns:</dt> |
| <dd>This object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keySet()"> |
| <h3>keySet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/juneau/dto/swagger/SecurityScheme.html#line-427">keySet</a></span>()</div> |
| <div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="SwaggerElement.html#keySet()">SwaggerElement</a></code></span></div> |
| <div class="block">Returns all the keys on this element.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SwaggerElement.html#keySet()">keySet</a></code> in class <code><a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>All the keys on this element. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
