Google Git
Sign in
apache / tomee-site-pub / 476cf231b77b83a25b4407df84b6a5fd7c0d673a / . / microprofile-2.0 / javadoc / org / eclipse / microprofile / openapi / models / security / SecurityScheme.html
blob: 3497ba1df85d076916694ed4bfacb37cf40002db [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>SecurityScheme</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<link rel="shortcut icon" href="/img/microprofile-favicon.png">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SecurityScheme";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" target="_top">Frames</a></li>
<li><a href="SecurityScheme.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.eclipse.microprofile.openapi.models.security</div>
<h2 title="Interface SecurityScheme" class="title">Interface SecurityScheme</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SecurityScheme</span>
extends <a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&gt;</pre>
<div class="block">SecurityScheme</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-scheme-object"</dd>
</dl>
</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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.In</a></span></code>
<div class="block">In is a REQUIRED property that specifies the location of the API key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.Type.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.Type</a></span></code>
<div class="block">Type is a REQUIRED property that specifies the type of SecurityScheme instance.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#bearerFormat-java.lang.String-">bearerFormat</a></span>(java.lang.String&nbsp;bearerFormat)</code>
<div class="block">bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#description-java.lang.String-">description</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">A short description for security schema.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#flows-org.eclipse.microprofile.openapi.models.security.OAuthFlows-">flows</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlows.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlows</a>&nbsp;flows)</code>
<div class="block">Flows is a REQUIRED property.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getBearerFormat--">getBearerFormat</a></span>()</code>
<div class="block">bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getDescription--">getDescription</a></span>()</code>
<div class="block">A short description for security schema.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlows.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlows</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getFlows--">getFlows</a></span>()</code>
<div class="block">Flows is a REQUIRED property.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.In</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getIn--">getIn</a></span>()</code>
<div class="block">In is a REQUIRED property that indicates the location of the API key.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getName--">getName</a></span>()</code>
<div class="block">Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getOpenIdConnectUrl--">getOpenIdConnectUrl</a></span>()</code>
<div class="block">openIdConnectUrl is a REQUIRED property.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getScheme--">getScheme</a></span>()</code>
<div class="block">Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.Type.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.Type</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#getType--">getType</a></span>()</code>
<div class="block">Type is a REQUIRED property that specifies the type of SecurityScheme instance.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#in-org.eclipse.microprofile.openapi.models.security.SecurityScheme.In-">in</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.In</a>&nbsp;in)</code>
<div class="block">In is a REQUIRED property that indicates the location of the API key.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#name-java.lang.String-">name</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#openIdConnectUrl-java.lang.String-">openIdConnectUrl</a></span>(java.lang.String&nbsp;openIdConnectUrl)</code>
<div class="block">penIdConnectUrl is a REQUIRED property.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#scheme-java.lang.String-">scheme</a></span>(java.lang.String&nbsp;scheme)</code>
<div class="block">Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setBearerFormat-java.lang.String-">setBearerFormat</a></span>(java.lang.String&nbsp;bearerFormat)</code>
<div class="block">bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">A short description for security schema.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setFlows-org.eclipse.microprofile.openapi.models.security.OAuthFlows-">setFlows</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlows.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlows</a>&nbsp;flows)</code>
<div class="block">Flows is a REQUIRED property.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setIn-org.eclipse.microprofile.openapi.models.security.SecurityScheme.In-">setIn</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.In</a>&nbsp;in)</code>
<div class="block">In is a REQUIRED property that indicates the location of the API key.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setOpenIdConnectUrl-java.lang.String-">setOpenIdConnectUrl</a></span>(java.lang.String&nbsp;openIdConnectUrl)</code>
<div class="block">openIdConnectUrl is a REQUIRED property.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setScheme-java.lang.String-">setScheme</a></span>(java.lang.String&nbsp;scheme)</code>
<div class="block">Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#setType-org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type-">setType</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.Type.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.Type</a>&nbsp;type)</code>
<div class="block">Type is a REQUIRED property that specifies the type of SecurityScheme instance.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html#type-org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type-">type</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.Type.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.Type</a>&nbsp;type)</code>
<div class="block">Type is a REQUIRED property that specifies the type of SecurityScheme instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Extensible">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.microprofile.openapi.models.<a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></h3>
<code><a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#addExtension-java.lang.String-java.lang.Object-">addExtension</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#getExtensions--">getExtensions</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#setExtensions-java.util.Map-">setExtensions</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Reference">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.microprofile.openapi.models.<a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a></h3>
<code><a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#getRef--">getRef</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#ref-java.lang.String-">ref</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#setRef-java.lang.String-">setRef</a></code></li>
</ul>
</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="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.Type.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.Type</a>&nbsp;getType()</pre>
<div class="block">Type is a REQUIRED property that specifies the type of SecurityScheme instance.
<p>
This method returns the type property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Type type</dd>
</dl>
</li>
</ul>
<a name="setType-org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre>void&nbsp;setType(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.Type.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.Type</a>&nbsp;type)</pre>
<div class="block">Type is a REQUIRED property that specifies the type of SecurityScheme instance.
<p>
This method sets the type property of SecurityScheme instance to the given Type argument.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of SecurityScheme instance</dd>
</dl>
</li>
</ul>
<a name="type-org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;type(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.Type.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.Type</a>&nbsp;type)</pre>
<div class="block">Type is a REQUIRED property that specifies the type of SecurityScheme instance.
<p>
This method sets the type property of SecurityScheme instance to the given Type argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of SecurityScheme instance</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set type property</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>java.lang.String&nbsp;getDescription()</pre>
<div class="block">A short description for security schema.
<p>
This method returns the description property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String description</dd>
</dl>
</li>
</ul>
<a name="setDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
<pre>void&nbsp;setDescription(java.lang.String&nbsp;description)</pre>
<div class="block">A short description for security schema.
<p>
This method sets the description property of SecurityScheme instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - short description of the SecuirtyScheme instance</dd>
</dl>
</li>
</ul>
<a name="description-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;description(java.lang.String&nbsp;description)</pre>
<div class="block">A short description for security schema.
<p>
This method sets the description property of SecurityScheme instance and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - short description of the SecuirtyScheme instance</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set description property</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
<p>
This method returns the name property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String name</dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>void&nbsp;setName(java.lang.String&nbsp;name)</pre>
<div class="block">Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
<p>
This method sets the name property of SecurityScheme instance to the parameter.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the header, query or cookie parameter to be used</dd>
</dl>
</li>
</ul>
<a name="name-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;name(java.lang.String&nbsp;name)</pre>
<div class="block">Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
<p>
This method sets the name property of SecurityScheme instance to the given String argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the header, query or cookie parameter to be used</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set name property</dd>
</dl>
</li>
</ul>
<a name="getIn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIn</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.In</a>&nbsp;getIn()</pre>
<div class="block">In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie".
<p>
This method returns the in property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>In in</dd>
</dl>
</li>
</ul>
<a name="setIn-org.eclipse.microprofile.openapi.models.security.SecurityScheme.In-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIn</h4>
<pre>void&nbsp;setIn(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.In</a>&nbsp;in)</pre>
<div class="block">In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie".
<p>
The method sets the in property of SecurityScheme instance to the given In argument.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the location of the API key</dd>
</dl>
</li>
</ul>
<a name="in-org.eclipse.microprofile.openapi.models.security.SecurityScheme.In-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>in</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;in(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security">SecurityScheme.In</a>&nbsp;in)</pre>
<div class="block">In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie".
<p>
This method sets the in property of SecurityScheme instance to the given In argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the location of the API key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set in property</dd>
</dl>
</li>
</ul>
<a name="getScheme--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheme</h4>
<pre>java.lang.String&nbsp;getScheme()</pre>
<div class="block">Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
<p>
This method returns the scheme property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String scheme</dd>
</dl>
</li>
</ul>
<a name="setScheme-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScheme</h4>
<pre>void&nbsp;setScheme(java.lang.String&nbsp;scheme)</pre>
<div class="block">Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
<p>
This method sets the scheme property of SecurityScheme instance to the given String argument.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scheme</code> - the name of the HTTP Authorization scheme to be used in the Authorization header</dd>
</dl>
</li>
</ul>
<a name="scheme-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheme</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;scheme(java.lang.String&nbsp;scheme)</pre>
<div class="block">Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
<p>
This method sets the scheme property of SecurityScheme instance to the given String argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scheme</code> - the name of the HTTP Authorization scheme to be used in the Authorization header</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set scheme property</dd>
</dl>
</li>
</ul>
<a name="getBearerFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBearerFormat</h4>
<pre>java.lang.String&nbsp;getBearerFormat()</pre>
<div class="block">bearerFormat is intended as a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an
authorization server, so this information is primarily for documentation purposes.
<p>
This method returns the bearerFormat property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String bearerFormat</dd>
</dl>
</li>
</ul>
<a name="setBearerFormat-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBearerFormat</h4>
<pre>void&nbsp;setBearerFormat(java.lang.String&nbsp;bearerFormat)</pre>
<div class="block">bearerFormat is intended as a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an
authorization server, so this information is primarily for documentation purposes.
<p>
This method sets the bearerFormat property of SecurityScheme instance to the given String argument.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bearerFormat</code> - a hint to the client to identify how the bearer token is formatted</dd>
</dl>
</li>
</ul>
<a name="bearerFormat-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bearerFormat</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;bearerFormat(java.lang.String&nbsp;bearerFormat)</pre>
<div class="block">bearerFormat is intended as a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an
authorization server, so this information is primarily for documentation purposes.
<p>
This method sets the bearerFormat property of SecurityScheme instance to the given String argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bearerFormat</code> - a hint to the client to identify how the bearer token is formatted</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set bearerFormat property</dd>
</dl>
</li>
</ul>
<a name="getFlows--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlows</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlows.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlows</a>&nbsp;getFlows()</pre>
<div class="block">Flows is a REQUIRED property.
<p>
Flows is an object containing configuration information for the flow types supported.
</p>
<p>
This method returns the flows property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>OAuthFlows flows</dd>
</dl>
</li>
</ul>
<a name="setFlows-org.eclipse.microprofile.openapi.models.security.OAuthFlows-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFlows</h4>
<pre>void&nbsp;setFlows(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlows.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlows</a>&nbsp;flows)</pre>
<div class="block">Flows is a REQUIRED property.
<p>
Flows is an object containing configuration information for the flow types supported.
</p>
<p>
This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>flows</code> - an object containing configuration information for the flow types supported</dd>
</dl>
</li>
</ul>
<a name="flows-org.eclipse.microprofile.openapi.models.security.OAuthFlows-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flows</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;flows(<a href="../../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlows.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlows</a>&nbsp;flows)</pre>
<div class="block">Flows is a REQUIRED property.
<p>
Flows is an object containing configuration information for the flow types supported.
</p>
<p>
This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>flows</code> - an object containing configuration information for the flow types supported</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set flows property</dd>
</dl>
</li>
</ul>
<a name="getOpenIdConnectUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpenIdConnectUrl</h4>
<pre>java.lang.String&nbsp;getOpenIdConnectUrl()</pre>
<div class="block">openIdConnectUrl is a REQUIRED property.
<p>
This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL.
</p>
<p>
This method returns the openIdConnectUrl property from SecurityScheme instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String openIdConnectUrl</dd>
</dl>
</li>
</ul>
<a name="setOpenIdConnectUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOpenIdConnectUrl</h4>
<pre>void&nbsp;setOpenIdConnectUrl(java.lang.String&nbsp;openIdConnectUrl)</pre>
<div class="block">openIdConnectUrl is a REQUIRED property.
<p>
This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL.
</p>
<p>
This method sets the openIdConnectUrl property of a SecurityScheme instance to the given String argument.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>openIdConnectUrl</code> - a URL where OAuth2 configuration values are stored</dd>
</dl>
</li>
</ul>
<a name="openIdConnectUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>openIdConnectUrl</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>&nbsp;openIdConnectUrl(java.lang.String&nbsp;openIdConnectUrl)</pre>
<div class="block">penIdConnectUrl is a REQUIRED property.
<p>
This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL.
</p>
<p>
This method sets the openIdConnectUrl property of SecurityScheme instance to the given String argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>openIdConnectUrl</code> - a URL where OAuth2 configuration values are stored</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SecurityScheme instance with the set openIdConnectUrl property</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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.In.html" title="enum in org.eclipse.microprofile.openapi.models.security"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" target="_top">Frames</a></li>
<li><a href="SecurityScheme.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>