| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>CmisAuthentication xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/chemistry/opencmis/commons/endpoints/CmisAuthentication.html">View Javadoc</a></div><pre> |
| |
| <a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.chemistry.opencmis.commons.endpoints; |
| <a class="jxr_linenumber" name="20" href="#20">20</a> |
| <a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="22" href="#22">22</a> |
| <a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * CMIS endpoint authentication information.</em> |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/endpoints/CmisAuthentication.html">CmisAuthentication</a> <strong class="jxr_keyword">extends</strong> Map<String, Object> { |
| <a class="jxr_linenumber" name="27" href="#27">27</a> |
| <a class="jxr_linenumber" name="28" href="#28">28</a> String KEY_TYPE = <span class="jxr_string">"type"</span>; |
| <a class="jxr_linenumber" name="29" href="#29">29</a> String KEY_DISPLAY_NAME = <span class="jxr_string">"displayName"</span>; |
| <a class="jxr_linenumber" name="30" href="#30">30</a> String KEY_DOCUMENTATION_URL = <span class="jxr_string">"documentationUrl"</span>; |
| <a class="jxr_linenumber" name="31" href="#31">31</a> String KEY_PREFERENCE = <span class="jxr_string">"preference"</span>; |
| <a class="jxr_linenumber" name="32" href="#32">32</a> |
| <a class="jxr_linenumber" name="33" href="#33">33</a> String AUTH_NONE = <span class="jxr_string">"none"</span>; |
| <a class="jxr_linenumber" name="34" href="#34">34</a> String AUTH_BASIC = <span class="jxr_string">"basic"</span>; |
| <a class="jxr_linenumber" name="35" href="#35">35</a> String AUTH_USERNAME_TOKEN = <span class="jxr_string">"usernameToken"</span>; |
| <a class="jxr_linenumber" name="36" href="#36">36</a> String AUTH_FORM = <span class="jxr_string">"form"</span>; |
| <a class="jxr_linenumber" name="37" href="#37">37</a> String AUTH_CERT = <span class="jxr_string">"certificate"</span>; |
| <a class="jxr_linenumber" name="38" href="#38">38</a> String AUTH_SAML = <span class="jxr_string">"saml"</span>; |
| <a class="jxr_linenumber" name="39" href="#39">39</a> String AUTH_OAUTH = <span class="jxr_string">"oauth"</span>; |
| <a class="jxr_linenumber" name="40" href="#40">40</a> String AUTH_OIDC = <span class="jxr_string">"oidc"</span>; |
| <a class="jxr_linenumber" name="41" href="#41">41</a> String AUTH_NTLM = <span class="jxr_string">"ntlm"</span>; |
| <a class="jxr_linenumber" name="42" href="#42">42</a> String AUTH_KERBEROS = <span class="jxr_string">"kerberos"</span>; |
| <a class="jxr_linenumber" name="43" href="#43">43</a> String AUTH_LTPA = <span class="jxr_string">"ltpa"</span>; |
| <a class="jxr_linenumber" name="44" href="#44">44</a> |
| <a class="jxr_linenumber" name="45" href="#45">45</a> String getType(); |
| <a class="jxr_linenumber" name="46" href="#46">46</a> |
| <a class="jxr_linenumber" name="47" href="#47">47</a> String getDisplayName(); |
| <a class="jxr_linenumber" name="48" href="#48">48</a> |
| <a class="jxr_linenumber" name="49" href="#49">49</a> String getDocumentationUrl(); |
| <a class="jxr_linenumber" name="50" href="#50">50</a> |
| <a class="jxr_linenumber" name="51" href="#51">51</a> Integer getPreference(); |
| <a class="jxr_linenumber" name="52" href="#52">52</a> |
| <a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Returns the associated CMIS endpoint.</em> |
| <a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @return the endpoint object, never {@code null}</em> |
| <a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="58" href="#58">58</a> <a href="../../../../../../org/apache/chemistry/opencmis/commons/endpoints/CmisEndpoint.html">CmisEndpoint</a> getEndpoint(); |
| <a class="jxr_linenumber" name="59" href="#59">59</a> |
| <a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Returns if this authentication method requires cookies.</em> |
| <a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Implementations should take following into account:</em> |
| <a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <li>the authentication method (some methods require cookies to work)</li></em> |
| <a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * <li>the binding and its cookie setting</li></em> |
| <a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <li>the CSRF settings</li></em> |
| <a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @return {@code true} if cookies are required, {@code false} if cookies</em> |
| <a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * are not required (they may be recommended, though)</em> |
| <a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">boolean</strong> requiresCookies(); |
| <a class="jxr_linenumber" name="75" href="#75">75</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
