blob: 576a762df7083a6c65d1d24f572b76372f67c5d4 [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_25) on Thu Jun 20 13:09:10 CEST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CmisBinding (Apache Chemistry OpenCMIS 0.9.0)</title>
<meta name="date" content="2013-06-20">
<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="CmisBinding (Apache Chemistry OpenCMIS 0.9.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/CmisBinding.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/spi/BindingsObjectFactory.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/DiscoveryService.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/commons/spi/CmisBinding.html" target="_top">Frames</a></li>
<li><a href="CmisBinding.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.spi</div>
<h2 title="Interface CmisBinding" class="title">Interface CmisBinding</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">CmisBinding</span></pre>
<div class="block">Entry point for all CMIS binding related operations. It provides access to
the service interface objects which are very similar to the CMIS 1.0 domain
model.
<p>
Each instance of this class represents a session. A session comprises of a
connection to one CMIS endpoint over one binding for one particular user and
a set of caches. All repositories that are exposed by this CMIS endpoint are
accessible in this session. All CMIS operations and extension points are
provided if they are supported by the underlying binding.
</p></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/spi/CmisBinding.html#clearAllCaches()">clearAllCaches</a></strong>()</code>
<div class="block">Clears all caches of the current CMIS binding session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#clearRepositoryCache(java.lang.String)">clearRepositoryCache</a></strong>(<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>&nbsp;repositoryId)</code>
<div class="block">Clears all caches of the current CMIS binding session that are related to
the given repository.</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/spi/CmisBinding.html#close()">close</a></strong>()</code>
<div class="block">Releases all resources assigned to this binding instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/AclService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">AclService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getAclService()">getAclService</a></strong>()</code>
<div class="block">Gets an ACL Service interface object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/AuthenticationProvider.html" title="interface in org.apache.chemistry.opencmis.commons.spi">AuthenticationProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getAuthenticationProvider()">getAuthenticationProvider</a></strong>()</code>
<div class="block">Gets the authentication provider.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/DiscoveryService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">DiscoveryService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getDiscoveryService()">getDiscoveryService</a></strong>()</code>
<div class="block">Gets a Discovery Service interface object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/MultiFilingService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">MultiFilingService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getMultiFilingService()">getMultiFilingService</a></strong>()</code>
<div class="block">Gets a Multifiling Service interface object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">NavigationService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getNavigationService()">getNavigationService</a></strong>()</code>
<div class="block">Gets a Navigation Service interface object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/BindingsObjectFactory.html" title="interface in org.apache.chemistry.opencmis.commons.spi">BindingsObjectFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getObjectFactory()">getObjectFactory</a></strong>()</code>
<div class="block">Gets a factory for CMIS binding specific objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/ObjectService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">ObjectService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getObjectService()">getObjectService</a></strong>()</code>
<div class="block">Gets an Object Service interface object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/PolicyService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">PolicyService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getPolicyService()">getPolicyService</a></strong>()</code>
<div class="block">Gets a Policy Service interface object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/RelationshipService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">RelationshipService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getRelationshipService()">getRelationshipService</a></strong>()</code>
<div class="block">Gets a Relationship Service interface object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/RepositoryService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">RepositoryService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getRepositoryService()">getRepositoryService</a></strong>()</code>
<div class="block">Gets a Repository Service interface object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/VersioningService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">VersioningService</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/CmisBinding.html#getVersioningService()">getVersioningService</a></strong>()</code>
<div class="block">Gets a Versioning Service interface object.</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="getRepositoryService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRepositoryService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/RepositoryService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">RepositoryService</a>&nbsp;getRepositoryService()</pre>
<div class="block">Gets a Repository Service interface object.</div>
</li>
</ul>
<a name="getNavigationService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNavigationService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">NavigationService</a>&nbsp;getNavigationService()</pre>
<div class="block">Gets a Navigation Service interface object.</div>
</li>
</ul>
<a name="getObjectService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/ObjectService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">ObjectService</a>&nbsp;getObjectService()</pre>
<div class="block">Gets an Object Service interface object.</div>
</li>
</ul>
<a name="getVersioningService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersioningService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/VersioningService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">VersioningService</a>&nbsp;getVersioningService()</pre>
<div class="block">Gets a Versioning Service interface object.</div>
</li>
</ul>
<a name="getRelationshipService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelationshipService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/RelationshipService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">RelationshipService</a>&nbsp;getRelationshipService()</pre>
<div class="block">Gets a Relationship Service interface object.</div>
</li>
</ul>
<a name="getDiscoveryService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiscoveryService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/DiscoveryService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">DiscoveryService</a>&nbsp;getDiscoveryService()</pre>
<div class="block">Gets a Discovery Service interface object.</div>
</li>
</ul>
<a name="getMultiFilingService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMultiFilingService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/MultiFilingService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">MultiFilingService</a>&nbsp;getMultiFilingService()</pre>
<div class="block">Gets a Multifiling Service interface object.</div>
</li>
</ul>
<a name="getAclService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAclService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/AclService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">AclService</a>&nbsp;getAclService()</pre>
<div class="block">Gets an ACL Service interface object.</div>
</li>
</ul>
<a name="getPolicyService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicyService</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/PolicyService.html" title="interface in org.apache.chemistry.opencmis.commons.spi">PolicyService</a>&nbsp;getPolicyService()</pre>
<div class="block">Gets a Policy Service interface object.</div>
</li>
</ul>
<a name="getObjectFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectFactory</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/BindingsObjectFactory.html" title="interface in org.apache.chemistry.opencmis.commons.spi">BindingsObjectFactory</a>&nbsp;getObjectFactory()</pre>
<div class="block">Gets a factory for CMIS binding specific objects.</div>
</li>
</ul>
<a name="getAuthenticationProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticationProvider</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/AuthenticationProvider.html" title="interface in org.apache.chemistry.opencmis.commons.spi">AuthenticationProvider</a>&nbsp;getAuthenticationProvider()</pre>
<div class="block">Gets the authentication provider.</div>
</li>
</ul>
<a name="clearAllCaches()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearAllCaches</h4>
<pre>void&nbsp;clearAllCaches()</pre>
<div class="block">Clears all caches of the current CMIS binding session.</div>
</li>
</ul>
<a name="clearRepositoryCache(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearRepositoryCache</h4>
<pre>void&nbsp;clearRepositoryCache(<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>&nbsp;repositoryId)</pre>
<div class="block">Clears all caches of the current CMIS binding session that are related to
the given repository.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repositoryId</code> - the repository id</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()</pre>
<div class="block">Releases all resources assigned to this binding instance.</div>
</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/CmisBinding.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/spi/BindingsObjectFactory.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/DiscoveryService.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/commons/spi/CmisBinding.html" target="_top">Frames</a></li>
<li><a href="CmisBinding.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-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>