Google Git
Sign in
apache / chemistry-site / 19af7d0fa4e1872c926a0e153c3f24d6bc996bae / . / content / java / 0.9.0 / maven / chemistry-opencmis-commons / chemistry-opencmis-commons-api / xref / org / apache / chemistry / opencmis / commons / server / CallContext.html
blob: 9f9558e9bee8f745b5b3f93899142d155c3632bb [file] [log] [blame]
<!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>CallContext xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/chemistry/opencmis/commons/server/CallContext.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.server;
<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.io.File;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.math.BigInteger;
<a class="jxr_linenumber" name="23" href="#23">23</a>
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.CmisVersion;
<a class="jxr_linenumber" name="25" href="#25">25</a>
<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * An object implementing this interface holds context data of the current call.</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CallContext.html">CallContext</a> {
<a class="jxr_linenumber" name="30" href="#30">30</a>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Binding: AtomPub */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> String BINDING_ATOMPUB = <span class="jxr_string">"atompub"</span>;
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Binding: Web Services */</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> String BINDING_WEBSERVICES = <span class="jxr_string">"webservices"</span>;
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Binding: Browser */</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> String BINDING_BROWSER = <span class="jxr_string">"browser"</span>;
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Binding: Local */</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> String BINDING_LOCAL = <span class="jxr_string">"local"</span>;
<a class="jxr_linenumber" name="39" href="#39">39</a>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: CMIS version (value is a CmisVersion) */</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> String CMIS_VERSION = <span class="jxr_string">"cmisVersion"</span>;
<a class="jxr_linenumber" name="42" href="#42">42</a>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: repository id */</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> String REPOSITORY_ID = <span class="jxr_string">"repositoryId"</span>;
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: username */</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> String USERNAME = <span class="jxr_string">"username"</span>;
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: password */</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> String PASSWORD = <span class="jxr_string">"password"</span>;
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: local */</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> String LOCALE = <span class="jxr_string">"locale"</span>;
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: offset (value is a BigInteger) */</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> String OFFSET = <span class="jxr_string">"offset"</span>;
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: length (value is a BigInteger) */</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> String LENGTH = <span class="jxr_string">"length"</span>;
<a class="jxr_linenumber" name="55" href="#55">55</a> String LOCALE_ISO639_LANGUAGE = <span class="jxr_string">"language"</span>;
<a class="jxr_linenumber" name="56" href="#56">56</a> String LOCALE_ISO3166_COUNTRY = <span class="jxr_string">"country"</span>;
<a class="jxr_linenumber" name="57" href="#57">57</a>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: servlet context (value is a ServletContext) */</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> String SERVLET_CONTEXT = <span class="jxr_string">"servletContext"</span>;
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: servlet request (value is a HttpServletRequest) */</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> String HTTP_SERVLET_REQUEST = <span class="jxr_string">"httpServletRequest"</span>;
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: servlet response (value is a HttpServletResponse) */</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> String HTTP_SERVLET_RESPONSE = <span class="jxr_string">"httpServletResponse"</span>;
<a class="jxr_linenumber" name="64" href="#64">64</a>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: temp directory */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> String TEMP_DIR = <span class="jxr_string">"tempDir"</span>;
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: memory threshold (values is an Integer) */</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> String MEMORY_THRESHOLD = <span class="jxr_string">"memoryThreshold"</span>;
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: max content size (values is a Long) */</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> String MAX_CONTENT_SIZE = <span class="jxr_string">"maxContentSize"</span>;
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: encrypt temp files (values is a Boolean) */</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> String ENCRYPT_TEMP_FILE = <span class="jxr_string">"encryptTempFiles"</span>;
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key: factory for threshold streams (value is a ThresholdOutputStreamFactory) */</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> String STREAM_FACTORY = <span class="jxr_string">"streamFactory"</span>;
<a class="jxr_linenumber" name="75" href="#75">75</a>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Returns the binding. Usually it returns</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * {@link CallContext#BINDING_ATOMPUB},</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * {@link CallContext#BINDING_WEBSERVICES},</em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * {@link CallContext#BINDING_BROWSER} or {@link CallContext#BINDING_LOCAL}.</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> String getBinding();
<a class="jxr_linenumber" name="83" href="#83">83</a>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Returns if &lt;code&gt;true&lt;/code&gt; object infos can improve the performance.</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">boolean</strong> isObjectInfoRequired();
<a class="jxr_linenumber" name="88" href="#88">88</a>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Returns context data by key.</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param key</em>
<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * the key</em>
<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @return the data if the key is valid, &lt;code&gt;null&lt;/code&gt; otherwise</em>
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> Object get(String key);
<a class="jxr_linenumber" name="97" href="#97">97</a>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Returns the CMIS version.</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/CmisVersion.html">CmisVersion</a> getCmisVersion();
<a class="jxr_linenumber" name="102" href="#102">102</a>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * Returns the repository id.</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> String getRepositoryId();
<a class="jxr_linenumber" name="107" href="#107">107</a>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * Returns the user name.</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> String getUsername();
<a class="jxr_linenumber" name="112" href="#112">112</a>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * Returns the password.</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="116" href="#116">116</a> String getPassword();
<a class="jxr_linenumber" name="117" href="#117">117</a>
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Returns the locale.</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> String getLocale();
<a class="jxr_linenumber" name="122" href="#122">122</a>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Returns the content offset if set, &lt;code&gt;null&lt;/code&gt; otherwise</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> BigInteger getOffset();
<a class="jxr_linenumber" name="127" href="#127">127</a>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * Returns the content length if set, &lt;code&gt;null&lt;/code&gt; otherwise</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> BigInteger getLength();
<a class="jxr_linenumber" name="132" href="#132">132</a>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * Returns the temp directory.</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> File getTempDirectory();
<a class="jxr_linenumber" name="137" href="#137">137</a>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * Returns if temp files should be encrypted.</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">boolean</strong> encryptTempFiles();
<a class="jxr_linenumber" name="142" href="#142">142</a>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Returns the memory threshold.</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">int</strong> getMemoryThreshold();
<a class="jxr_linenumber" name="147" href="#147">147</a>
<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * Returns the may size of content.</em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">long</strong> getMaxContentSize();
<a class="jxr_linenumber" name="152" href="#152">152</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>