View Javadoc
1   /**
2    * This file Copyright (c) 2013-2016 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.dam.jcr;
35  
36  import info.magnolia.jcr.RuntimeRepositoryException;
37  import info.magnolia.jcr.util.NodeTypes;
38  
39  import javax.jcr.Node;
40  import javax.jcr.RepositoryException;
41  
42  import org.apache.commons.lang3.StringUtils;
43  import org.apache.jackrabbit.JcrConstants;
44  
45  /**
46   * Constants and convenience methods for Asset node types.
47   */
48  public class AssetNodeTypes {
49  
50      /**
51       * Represents the node type mgnl:asset.
52       */
53      public static class Asset {
54  
55          public static final String NAME = NodeTypes.MGNL_PREFIX + "asset";
56  
57          public static final String TYPE = "type";
58          // public static final String MEDIATYPE = "mediaType";
59          public static final String LANGUAGE = "language";
60          public static final String ASSET_NAME = "name";
61          public static final String TITLE = "title";
62          public static final String SUBJECT = "subject";
63          public static final String DESCRIPTION = "description";
64          public static final String CAPTION = "caption";
65          public static final String COPYRIGHT = "copyright";
66          public static final String COMMENT = "comment";
67          // TODO Should we keep this ?
68          public final static String PROVIDER_TYPE = "providerType";
69          public final static String MASTER = "master";
70  
71      }
72  
73      /**
74       * Represent the resource node bound to an Asset.
75       */
76      public static class AssetResource {
77          public static final String NAME = NodeTypes.Resource.NAME;
78          public static final String RESOURCE_NAME = JcrConstants.JCR_CONTENT;
79  
80          public static final String EXTENSION = "extension";
81          public static final String FILENAME = "fileName";
82          public static final String HEIGHT = "height";
83          public static final String SIZE = "size";
84          public static final String WIDTH = "width";
85          public static final String DATA = JcrConstants.JCR_DATA;
86          public static final String MIMETYPE = JcrConstants.JCR_MIMETYPE;
87  
88          /**
89           * Return the resource node related to the given asset node.
90           */
91          public static Node getResourceNodeFromAsset(Node assetNode) {
92              try {
93                  if (assetNode.hasNode(RESOURCE_NAME)) {
94                      return assetNode.getNode(RESOURCE_NAME);
95                  }
96              } catch (RepositoryException e) {
97                  throw new RuntimeRepositoryException(e);
98              }
99              return null;
100         }
101     }
102 
103     /**
104      * Check if the given node is of type asset.
105      */
106     static boolean isAsset(Node assetNode) {
107         try {
108             return StringUtils.equals(assetNode.getPrimaryNodeType().getName(), Asset.NAME);
109         } catch (RepositoryException e) {
110             throw new RuntimeRepositoryException(e);
111         }
112     }
113 
114     /**
115      * Check if the given node is of type folder.
116      */
117     static boolean isFolder(Node assetNode) {
118         try {
119             return StringUtils.equals(assetNode.getPrimaryNodeType().getName(), NodeTypes.Folder.NAME);
120         } catch (RepositoryException e) {
121             throw new RuntimeRepositoryException(e);
122         }
123     }
124 }