blob: 8bf8ebfd2a76f62f3f18ecdaa68e355b3cdf62eb [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 (version 1.7.0_07) on Mon Apr 07 19:25:55 EDT 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CmisServiceFactory (Apache Chemistry OpenCMIS 0.11.0)</title>
<meta name="date" content="2014-04-07">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CmisServiceFactory (Apache Chemistry OpenCMIS 0.11.0)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">Prev 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="strong">Next 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 Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All 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 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="strong">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#destroy()">destroy</a></strong>()</code>
<div class="block">Cleans up the the factory instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#encryptTempFiles()">encryptTempFiles</a></strong>()</code>
<div class="block">Indicates if temporary files should be encrypted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getMaxContentSize()">getMaxContentSize</a></strong>()</code>
<div class="block">Returns the maximal content size in bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getMemoryThreshold()">getMemoryThreshold</a></strong>()</code>
<div class="block">Returns up to which size content should be kept in memory.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getService(org.apache.chemistry.opencmis.commons.server.CallContext)">getService</a></strong>(<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 class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#getTempDirectory()">getTempDirectory</a></strong>()</code>
<div class="block">Returns the absolute path of the directory that should be used for
temporary files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisServiceFactory.html#init(java.util.Map)">init</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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>
</li>
</ul>
<a name="getTempDirectory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTempDirectory</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/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="strong">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="strong">Returns:</span></dt><dd><code>true</code> if temporary files should be encrypted,
<code>false</code> otherwise</dd><dt><span class="strong">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="strong">Returns:</span></dt><dd>the threshold in bytes</dd><dt><span class="strong">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="blockListLast">
<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="strong">Returns:</span></dt><dd>the max size in bytes or -1 to disable the size check</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">Prev 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="strong">Next 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 Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All 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-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>