1 /**
2 * This file Copyright (c) 2019 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.ui.framework.ioc;
35
36 import java.lang.annotation.Annotation;
37 import java.lang.annotation.ElementType;
38 import java.lang.annotation.Retention;
39 import java.lang.annotation.RetentionPolicy;
40 import java.lang.annotation.Target;
41 import java.util.Objects;
42
43 import com.google.inject.BindingAnnotation;
44
45 /**
46 * Binding annotation to be used with the component bindings/type mappings
47 * associated with datasource configuration.
48 *
49 * @see org.apache.jackrabbit.core.config.DataSourceConfig.DataSourceDefinition
50 */
51 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})
52 @Retention(RetentionPolicy.RUNTIME)
53 @BindingAnnotation
54 public @interface DatasourceComponent {
55
56 String datasourceName();
57
58 /**
59 * Implementation of {@link DatasourceComponent}.
60 */
61 class DatasourceComponentImpl implements DatasourceComponent, UiContextAnnotation {
62
63 private String datasourceName;
64
65 public DatasourceComponentImpl(String datasourceName) {
66 this.datasourceName = datasourceName;
67 }
68
69 @Override
70 public Class<DatasourceComponent> annotationType() {
71 return DatasourceComponent.class;
72 }
73
74 @Override
75 public String datasourceName() {
76 return this.datasourceName;
77 }
78
79 @Override
80 public boolean equals(Object o) {
81 if (this == o) return true;
82 if (!(o instanceof DatasourceComponentImpl)) return false;
83 DatasourceComponentImpl component = (DatasourceComponentImpl) o;
84 return Objects.equals(datasourceName, component.datasourceName);
85 }
86
87 @Override
88 public int hashCode() {
89 return Objects.hash(datasourceName);
90 }
91
92 @Override
93 public Class<? extends Annotation> getRelatedScopeAnnotation(boolean isEager) {
94 return DatasourceComponent.class;
95 }
96 }
97 }
98