1 /**
2 * This file Copyright (c) 2014-2017 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.api;
35
36 import java.util.regex.Matcher;
37 import java.util.regex.Pattern;
38
39 /**
40 * A "composite key": in the dam, every {@link Asset} and {@link Folder} are identified by its provider's ID
41 * and its provider-specific ID (i.e the ID with which the provider can uniquely identify the asset itself).
42 */
43 public class ItemKey {
44 private static final Pattern PATTERN = Pattern.compile("^(.+?):(.+)$");
45
46 public static ItemKey from(String compositeKey) {
47 final Matcher matcher = PATTERN.matcher(compositeKey);
48 if (matcher.matches()) {
49 return new ItemKey(matcher.group(1), matcher.group(2));
50 }
51 throw new IllegalArgumentException(compositeKey + " is not a valid ItemKey");
52 }
53
54 public static boolean isValid(String compositeKey) {
55 final Matcher matcher = PATTERN.matcher(compositeKey);
56 return matcher.matches();
57 }
58
59 private final String providerId;
60 private final String assetId;
61
62 public ItemKey(String providerId, String assetId) {
63 this.providerId = providerId;
64 this.assetId = assetId;
65 }
66
67 public String getProviderId() {
68 return providerId;
69 }
70
71 public String getAssetId() {
72 return assetId;
73 }
74
75 public String asString() {
76 return String.format("%s:%s", providerId, assetId);
77 }
78
79 @Override
80 public boolean equals(Object o) {
81 if (this == o) {
82 return true;
83 }
84 if (o == null || getClass() != o.getClass()) {
85 return false;
86 }
87
88 ItemKey itemKey = (ItemKey) o;
89
90 if (!assetId.equals(itemKey.assetId)) {
91 return false;
92 }
93 if (!providerId.equals(itemKey.providerId)) {
94 return false;
95 }
96
97 return true;
98 }
99
100 @Override
101 public int hashCode() {
102 int result = providerId.hashCode();
103 result = 31 * result + assetId.hashCode();
104 return result;
105 }
106 }