Google Git
Sign in
apache / chemistry-site / 19af7d0fa4e1872c926a0e153c3f24d6bc996bae / . / content / java / javadoc / org / apache / chemistry / opencmis / commons / server / CmisServiceFactory.html
blob: 6f49eed98a5356f6b551d82acb4921a2e1caf451 [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>
<!-- Generated by javadoc (1.8.0_121) on Fri Mar 31 15:41:38 CEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CmisServiceFactory (Apache Chemistry OpenCMIS 1.1.0)</title>
<meta name="date" content="2017-03-31">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CmisServiceFactory (Apache Chemistry OpenCMIS 1.1.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CmisServiceFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/LinkInfo.html" title="interface in org.apache.chemistry.opencmis.commons.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html" target="_top">Frames</a></li>
<li><a href="CmisServiceFactory.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>Nested&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.apache.chemistry.opencmis.commons.server</div>
<h2 title="Interface CmisServiceFactory" class="title">Interface CmisServiceFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../org/apache/chemistry/opencmis/server/async/AsyncCmisServiceFactory.html" title="interface in org.apache.chemistry.opencmis.server.async">AsyncCmisServiceFactory</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/chemistry/opencmis/bridge/AbstractBridgeServiceFactory.html" title="class in org.apache.chemistry.opencmis.bridge">AbstractBridgeServiceFactory</a>, <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/server/AbstractServiceFactory.html" title="class in org.apache.chemistry.opencmis.commons.impl.server">AbstractServiceFactory</a>, <a href="../../../../../../org/apache/chemistry/opencmis/bridge/httpsession/HttpSessionBridgeServiceFactory.html" title="class in org.apache.chemistry.opencmis.bridge.httpsession">HttpSessionBridgeServiceFactory</a>, <a href="../../../../../../org/apache/chemistry/opencmis/bridge/lrucache/LruCacheBridgeServiceFactory.html" title="class in org.apache.chemistry.opencmis.bridge.lrucache">LruCacheBridgeServiceFactory</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CmisServiceFactory</span></pre>
<div class="block">Factory for <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server"><code>CmisService</code></a> objects.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#destroy--">destroy</a></span>()</code>
<div class="block">Cleans up the the factory instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#encryptTempFiles--">encryptTempFiles</a></span>()</code>
<div class="block">Indicates if temporary files should be encrypted.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getMaxContentSize--">getMaxContentSize</a></span>()</code>
<div class="block">Returns the maximal content size in bytes.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getMemoryThreshold--">getMemoryThreshold</a></span>()</code>
<div class="block">Returns up to which size content should be kept in memory.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server">CmisService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getService-org.apache.chemistry.opencmis.commons.server.CallContext-">getService</a></span>(<a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CallContext.html" title="interface in org.apache.chemistry.opencmis.commons.server">CallContext</a>&nbsp;context)</code>
<div class="block">Returns a <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server"><code>CmisService</code></a> object for the given <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CallContext.html" title="interface in org.apache.chemistry.opencmis.commons.server"><code>CallContext</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getTempDirectory--">getTempDirectory</a></span>()</code>
<div class="block">Returns the absolute path of the directory that should be used for
temporary files.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.html" title="class in org.apache.chemistry.opencmis.commons.server">TempStoreOutputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getTempFileOutputStream-java.lang.String-">getTempFileOutputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId)</code>
<div class="block">Returns a <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.html" title="class in org.apache.chemistry.opencmis.commons.server"><code>TempStoreOutputStream</code></a> object for the given repository
ID.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#init-java.util.Map-">init</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;parameters)</code>
<div class="block">Initializes the factory instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;parameters)</pre>
<div class="block">Initializes the factory instance.</div>
</li>
</ul>
<a name="destroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>void&nbsp;destroy()</pre>
<div class="block">Cleans up the the factory instance.</div>
</li>
</ul>
<a name="getService-org.apache.chemistry.opencmis.commons.server.CallContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server">CmisService</a>&nbsp;getService(<a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CallContext.html" title="interface in org.apache.chemistry.opencmis.commons.server">CallContext</a>&nbsp;context)</pre>
<div class="block">Returns a <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server"><code>CmisService</code></a> object for the given <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CallContext.html" title="interface in org.apache.chemistry.opencmis.commons.server"><code>CallContext</code></a>.
When the <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server"><code>CmisService</code></a> object is not longer needed
<a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html#close--"><code>CmisService.close()</code></a> will be called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the call context</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server"><code>CmisService</code></a> instance, never <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getTempDirectory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTempDirectory</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getTempDirectory()</pre>
<div class="block">Returns the absolute path of the directory that should be used for
temporary files.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>absolute path of temp directory</dd>
</dl>
</li>
</ul>
<a name="encryptTempFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encryptTempFiles</h4>
<pre>boolean&nbsp;encryptTempFiles()</pre>
<div class="block">Indicates if temporary files should be encrypted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if temporary files should be encrypted,
<code>false</code> otherwise</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getTempDirectory--"><code>getTempDirectory()</code></a></dd>
</dl>
</li>
</ul>
<a name="getMemoryThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemoryThreshold</h4>
<pre>int&nbsp;getMemoryThreshold()</pre>
<div class="block">Returns up to which size content should be kept in memory. Documents
bigger than this threshold will be cached in a temporary directory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the threshold in bytes</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getTempDirectory--"><code>getTempDirectory()</code></a></dd>
</dl>
</li>
</ul>
<a name="getMaxContentSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxContentSize</h4>
<pre>long&nbsp;getMaxContentSize()</pre>
<div class="block">Returns the maximal content size in bytes. If a client provides content
bigger than that, a <a href="../../../../../../org/apache/chemistry/opencmis/commons/exceptions/CmisConstraintException.html" title="class in org.apache.chemistry.opencmis.commons.exceptions"><code>CmisConstraintException</code></a> is thrown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the max size in bytes or -1 to disable the size check</dd>
</dl>
</li>
</ul>
<a name="getTempFileOutputStream-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTempFileOutputStream</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.html" title="class in org.apache.chemistry.opencmis.commons.server">TempStoreOutputStream</a>&nbsp;getTempFileOutputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId)</pre>
<div class="block">Returns a <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.html" title="class in org.apache.chemistry.opencmis.commons.server"><code>TempStoreOutputStream</code></a> object for the given repository
ID.
This method is only called for the AtomPub and the Browser binding
requests. The Web Services binding always used temporary files (see
<a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getTempDirectory--"><code>getTempDirectory()</code></a>).
If <code>null</code> is returned, a default implementation that stores the
document content in temporary files is used (see
<a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getTempDirectory--"><code>getTempDirectory()</code></a>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repositoryId</code> - the repository ID or <code>null</code> if the repository ID is
unknown</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.html" title="class in org.apache.chemistry.opencmis.commons.server"><code>TempStoreOutputStream</code></a> instance or <code>null</code> to use
the default implementation</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="class-use/CmisServiceFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/LinkInfo.html" title="interface in org.apache.chemistry.opencmis.commons.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html" target="_top">Frames</a></li>
<li><a href="CmisServiceFactory.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>Nested&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2009&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>