View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 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.security.PermissionUtil;
38  import info.magnolia.cms.util.ContentUtil;
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 Node node = getJCRNode(ctx);
66          // TODO: determine whether method below needs to check for permissions
67          PermissionUtil.isGranted(node.getSession(), node.getPath(), Session.ACTION_READ);
68          return ContentUtil.asContent(node);
69      }
70  
71      /**
72       * Retrieve the Node.
73       */
74      protected Node getJCRNode(Context ctx) throws RepositoryException {
75          // TODO: check why this need to use the system context and why we can't use given CTX
76          final Session session = MgnlContext.getSystemContext().getJCRSession(getRepository());
77          final Node node;
78          if (StringUtils.isNotEmpty(getUuid())) {
79              node = session.getNodeByIdentifier(getUuid());
80          } else {
81              node = session.getNode(getPath());
82          }
83          return node;
84      }
85  
86      /**
87       * @return the repository
88       */
89      public String getRepository() {
90          return repository;
91      }
92  
93      /**
94       * @param repository the repository to set
95       */
96      public void setRepository(String repository) {
97          this.repository = repository;
98      }
99  
100     /**
101      * @return the path
102      */
103     public String getPath() {
104         return path;
105     }
106 
107     /**
108      * @param path the path to set
109      */
110     public void setPath(String path) {
111         this.path = path;
112     }
113 
114     /**
115      * @return the uuid
116      */
117     public String getUuid() {
118         return this.uuid;
119     }
120 
121     /**
122      * @param uuid the uuid to set
123      */
124     public void setUuid(String uuid) {
125         this.uuid = uuid;
126     }
127 
128     @Override
129     public void release() {
130         super.release();
131         this.uuid = null;
132         this.path = null;
133         this.repository = null;
134     }
135 
136 }