View Javadoc

1   /**
2    * This file Copyright (c) 2003-2013 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.commands.impl;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.core.HierarchyManager;
38  import info.magnolia.cms.security.PermissionUtil;
39  import info.magnolia.commands.MgnlCommand;
40  import info.magnolia.context.Context;
41  import info.magnolia.context.MgnlContext;
42  
43  import javax.jcr.Node;
44  import javax.jcr.RepositoryException;
45  import javax.jcr.Session;
46  
47  import org.apache.commons.lang.StringUtils;
48  
49  /**
50   * Base class for the commands that work with the repository.
51   *
52   */
53  public abstract class BaseRepositoryCommand extends MgnlCommand {
54  
55      private String path = "/";
56  
57      private String repository;
58  
59      private String uuid;
60  
61      /**
62       * @deprecated since 4.5.7 use {@link #getJCRNode(Context)} instead
63       */
64      @Deprecated
65      protected Content getNode(Context ctx) throws RepositoryException {
66          final HierarchyManager hm = MgnlContext.getSystemContext().getHierarchyManager(getRepository());
67          final Content node;
68          if (StringUtils.isNotEmpty(getUuid())) {
69              node = hm.getContentByUUID(getUuid());
70          } else {
71              node = hm.getContent(getPath());
72          }
73          PermissionUtil.isGranted(node.getJCRNode().getSession(), node.getHandle(), Session.ACTION_READ);
74          return node;
75      }
76  
77      /**
78       * Retrieve the Node.
79       */
80      protected Node getJCRNode(Context ctx) throws RepositoryException {
81          final Session session = MgnlContext.getSystemContext().getJCRSession(getRepository());
82          final Node node;
83          if (StringUtils.isNotEmpty(getUuid())) {
84              node = session.getNodeByIdentifier(getUuid());
85          } else {
86              node = session.getNode(getPath());
87          }
88          return node;
89      }
90  
91      /**
92       * @return the repository
93       */
94      public String getRepository() {
95          return repository;
96      }
97  
98      /**
99       * @param repository the repository to set
100      */
101     public void setRepository(String repository) {
102         this.repository = repository;
103     }
104 
105     /**
106      * @return the path
107      */
108     public String getPath() {
109         return path;
110     }
111 
112     /**
113      * @param path the path to set
114      */
115     public void setPath(String path) {
116         this.path = path;
117     }
118 
119     /**
120      * @return the uuid
121      */
122     public String getUuid() {
123         return this.uuid;
124     }
125 
126     /**
127      * @param uuid the uuid to set
128      */
129     public void setUuid(String uuid) {
130         this.uuid = uuid;
131     }
132 
133     @Override
134     public void release() {
135         super.release();
136         this.uuid = null;
137         this.path = null;
138         this.repository = null;
139     }
140 
141 }