Google Git
Sign in
apache / chemistry-site / 19af7d0fa4e1872c926a0e153c3f24d6bc996bae / . / content / java / 0.7.0 / maven / chemistry-opencmis-server / chemistry-opencmis-server-jcr / xref / org / apache / chemistry / opencmis / jcr / PathManager.html
blob: 6d1d622351cdffa8acc0edf55786be8520184955 [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=ISO-8859-1" />
<title>PathManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a 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 name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.chemistry.opencmis.jcr;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.exceptions.CmisInvalidArgumentException;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a name="26" href="#26">26</a>
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.jcr.Node;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.jcr.RepositoryException;
<a name="29" href="#29">29</a>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Utility class for mapping JCR paths to CMIS paths</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em>
<a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/chemistry/opencmis/jcr/PathManager.html">PathManager</a> {
<a name="34" href="#34">34</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log log = LogFactory.getLog(PathManager.<strong class="jxr_keyword">class</strong>);
<a name="35" href="#35">35</a>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Identifier of the root folder</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em>
<a name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CMIS_ROOT_ID = <span class="jxr_string">"[root]"</span>;
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Root path</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
<a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CMIS_ROOT_PATH = <span class="jxr_string">"/"</span>;
<a name="45" href="#45">45</a>
<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String jcrRootPath;
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Create a new &lt;code&gt;PathManager&lt;/code&gt; instance for the given JCR root path.</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @param jcrRootPath</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/chemistry/opencmis/jcr/PathManager.html">PathManager</a>(String jcrRootPath) {
<a name="53" href="#53">53</a> <strong class="jxr_keyword">this</strong>.jcrRootPath = normalize(jcrRootPath);
<a name="54" href="#54">54</a> }
<a name="55" href="#55">55</a>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @return the JCR root path</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> String getJcrRootPath() {
<a name="60" href="#60">60</a> <strong class="jxr_keyword">return</strong> jcrRootPath;
<a name="61" href="#61">61</a> }
<a name="62" href="#62">62</a>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Determines whether a JCR &lt;code&gt;Node&lt;/code&gt; is the root node wrt. to this</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * &lt;code&gt;PathManager&lt;/code&gt; instance. That is, whether the path of the node is</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * equal to this instance's JCR root path.</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * </em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @param node</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; iff &lt;code&gt;node&lt;/code&gt; is the root node wrt. to</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * this &lt;code&gt;PathManager&lt;/code&gt; instance.</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em>
<a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isRoot(Node node) {
<a name="73" href="#73">73</a> <strong class="jxr_keyword">try</strong> {
<a name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> node.getPath().equals(jcrRootPath);
<a name="75" href="#75">75</a> }
<a name="76" href="#76">76</a> <strong class="jxr_keyword">catch</strong> (RepositoryException e) {
<a name="77" href="#77">77</a> log.debug(e.getMessage(), e);
<a name="78" href="#78">78</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CmisRuntimeException(e.getMessage(), e);
<a name="79" href="#79">79</a> }
<a name="80" href="#80">80</a> }
<a name="81" href="#81">81</a>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * Determine the CMIS path given a JCR &lt;code&gt;Node&lt;/code&gt;.</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> *</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param node</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @return</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException when &lt;code&gt;node&lt;/code&gt; is not part of the hierarchy</em>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
<a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> String getPath(Node node) {
<a name="90" href="#90">90</a> <strong class="jxr_keyword">try</strong> {
<a name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (jcrRootPath.length() &gt; node.getPath().length()) {
<a name="92" href="#92">92</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Node is not part of the hierarchy: "</span> + node.getPath());
<a name="93" href="#93">93</a> }
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> String path = node.getPath().substring(jcrRootPath.length());
<a name="96" href="#96">96</a> <strong class="jxr_keyword">return</strong> path.startsWith(<span class="jxr_string">"/"</span>) ? path : '/' + path;
<a name="97" href="#97">97</a> }
<a name="98" href="#98">98</a> <strong class="jxr_keyword">catch</strong> (RepositoryException e) {
<a name="99" href="#99">99</a> log.debug(e.getMessage(), e);
<a name="100" href="#100">100</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CmisRuntimeException(e.getMessage(), e);
<a name="101" href="#101">101</a> }
<a name="102" href="#102">102</a> }
<a name="103" href="#103">103</a>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">/**</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @param cmisPath</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; iff &lt;code&gt;cmisPath&lt;/code&gt; equals {@link PathManager#CMIS_ROOT_PATH}</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em>
<a name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isRoot(String cmisPath) {
<a name="109" href="#109">109</a> <strong class="jxr_keyword">return</strong> CMIS_ROOT_PATH.equals(cmisPath);
<a name="110" href="#110">110</a> }
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @param cmisPath</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; iff &lt;code&gt;cmisPath&lt;/code&gt;</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em>
<a name="116" href="#116">116</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isAbsolute(String cmisPath) {
<a name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> cmisPath.startsWith(CMIS_ROOT_PATH);
<a name="118" href="#118">118</a> }
<a name="119" href="#119">119</a>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * Create a CMIS path from a parent path and a child element</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @param cmisPath parent path</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param child child element</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @return</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em>
<a name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String createCmisPath(String cmisPath, String child) {
<a name="127" href="#127">127</a> <strong class="jxr_keyword">return</strong> cmisPath.length() &gt; 0 &amp;&amp; cmisPath.charAt(cmisPath.length() - 1) == '/'
<a name="128" href="#128">128</a> ? cmisPath + child
<a name="129" href="#129">129</a> : cmisPath + '/' + child;
<a name="130" href="#130">130</a> }
<a name="131" href="#131">131</a>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Relativize an CMIS path wrt. to a prefix. </em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param prefix</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @param cmisPath</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @return a string &lt;code&gt;r&lt;/code&gt; such that &lt;code&gt;prefix&lt;/code&gt; + &lt;code&gt;r&lt;/code&gt; = &lt;code&gt;cmisPath&lt;/code&gt; </em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if &lt;code&gt;prefix&lt;/code&gt; is not a prefix of &lt;code&gt;cmisPath&lt;/code&gt;</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em>
<a name="139" href="#139">139</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String relativize(String prefix, String cmisPath) {
<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (cmisPath.startsWith(prefix)) {
<a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> cmisPath.substring(prefix.length());
<a name="142" href="#142">142</a> }
<a name="143" href="#143">143</a> <strong class="jxr_keyword">else</strong> {
<a name="144" href="#144">144</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(prefix + <span class="jxr_string">" is not a prefix of "</span> + cmisPath);
<a name="145" href="#145">145</a> }
<a name="146" href="#146">146</a> }
<a name="147" href="#147">147</a>
<a name="148" href="#148">148</a> <em class="jxr_comment">//------------------------------------------&lt; private &gt;---</em>
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String normalize(String path) {
<a name="151" href="#151">151</a> <strong class="jxr_keyword">if</strong> (path == <strong class="jxr_keyword">null</strong> || path.length() == 0) {
<a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"/"</span>;
<a name="153" href="#153">153</a> }
<a name="154" href="#154">154</a>
<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (!path.startsWith(<span class="jxr_string">"/"</span>)) {
<a name="156" href="#156">156</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CmisInvalidArgumentException(<span class="jxr_string">"Root path must be absolute. Got: "</span> + path);
<a name="157" href="#157">157</a> }
<a name="158" href="#158">158</a>
<a name="159" href="#159">159</a> <strong class="jxr_keyword">while</strong> (path.length() &gt; 1 &amp;&amp; path.endsWith(<span class="jxr_string">"/"</span>)) {
<a name="160" href="#160">160</a> path = path.substring(0, path.length() - 1);
<a name="161" href="#161">161</a> }
<a name="162" href="#162">162</a> <strong class="jxr_keyword">return</strong> path;
<a name="163" href="#163">163</a> }
<a name="164" href="#164">164</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>