View Javadoc
1   /**
2    * This file Copyright (c) 2003-2015 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.lang3.StringUtils;
48  
49  /**
50   * Base class for the commands that work with the repository.
51   */
52  public abstract class BaseRepositoryCommand extends MgnlCommand {
53  
54      private String path = "/";
55  
56      private String repository;
57  
58      private String uuid;
59  
60      /**
61       * @deprecated since 4.5.7 use {@link #getJCRNode(Context)} instead
62       */
63      @Deprecated
64      protected Content getNode(Context ctx) throws RepositoryException {
65          final HierarchyManager hm = MgnlContext.getSystemContext().getHierarchyManager(getRepository());
66          final Content node;
67          if (StringUtils.isNotEmpty(getUuid())) {
68              node = hm.getContentByUUID(getUuid());
69          } else {
70              node = hm.getContent(getPath());
71          }
72          PermissionUtil.isGranted(node.getJCRNode().getSession(), node.getHandle(), Session.ACTION_READ);
73          return node;
74      }
75  
76      /**
77       * Retrieve the Node.
78       */
79      protected Node getJCRNode(Context ctx) throws RepositoryException {
80          final Session session = MgnlContext.getSystemContext().getJCRSession(getRepository());
81          final Node node;
82          if (StringUtils.isNotEmpty(getUuid())) {
83              node = session.getNodeByIdentifier(getUuid());
84          } else {
85              node = session.getNode(getPath());
86          }
87          return node;
88      }
89  
90      /**
91       * @return the repository
92       */
93      public String getRepository() {
94          return repository;
95      }
96  
97      /**
98       * @param repository the repository to set
99       */
100     public void setRepository(String repository) {
101         this.repository = repository;
102     }
103 
104     /**
105      * @return the path
106      */
107     public String getPath() {
108         return path;
109     }
110 
111     /**
112      * @param path the path to set
113      */
114     public void setPath(String path) {
115         this.path = path;
116     }
117 
118     /**
119      * @return the uuid
120      */
121     public String getUuid() {
122         return this.uuid;
123     }
124 
125     /**
126      * @param uuid the uuid to set
127      */
128     public void setUuid(String uuid) {
129         this.uuid = uuid;
130     }
131 
132     @Override
133     public void release() {
134         super.release();
135         this.uuid = null;
136         this.path = null;
137         this.repository = null;
138     }
139 
140 }