aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--aai-annotations/src/main/java/org/onap/aai/annotations/Metadata.java71
-rw-r--r--aai-annotations/src/main/java/org/onap/aai/schema/enums/ObjectMetadata.java222
-rw-r--r--aai-annotations/src/main/java/org/onap/aai/schema/enums/PropertyMetadata.java120
-rw-r--r--aai-annotations/src/test/java/org/onap/aai/annotations/AnnotationsTest.java38
4 files changed, 243 insertions, 208 deletions
diff --git a/aai-annotations/src/main/java/org/onap/aai/annotations/Metadata.java b/aai-annotations/src/main/java/org/onap/aai/annotations/Metadata.java
index d9e9f0fd..eb88230c 100644
--- a/aai-annotations/src/main/java/org/onap/aai/annotations/Metadata.java
+++ b/aai-annotations/src/main/java/org/onap/aai/annotations/Metadata.java
@@ -8,7 +8,7 @@
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -17,6 +17,7 @@
* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.annotations;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
@@ -29,28 +30,50 @@ import java.lang.annotation.Target;
@Target({ElementType.METHOD, ElementType.TYPE, ElementType.FIELD})
public @interface Metadata {
- boolean isKey() default false;
- String description() default "";
- String nameProps() default "";
- String indexedProps() default "";
- String dependentOn() default "";
- String container() default "";
- String namespace() default "";
- String defaultValue() default "";
- String searchable() default "";
- String uniqueProps() default "";
- String requiredProps() default "";
- String uriTemplate() default "";
- String extendsFrom() default "";
- String isAbstract() default "";
- String alternateKeys1() default "";
- String maximumDepth() default "";
- String crossEntityReference() default "";
- String requires() default "";
- String dbAlias() default "";
- String dataLocation() default "";
- String containsSuggestibleProps() default "";
- String suggestionAliases() default "";
- String sourceOfTruthType() default "";
+ boolean isKey() default false;
+
+ String description() default "";
+
+ String nameProps() default "";
+
+ String indexedProps() default "";
+
+ String dependentOn() default "";
+
+ String container() default "";
+
+ String namespace() default "";
+
+ String defaultValue() default "";
+
+ String searchable() default "";
+
+ String uniqueProps() default "";
+
+ String requiredProps() default "";
+
+ String uriTemplate() default "";
+
+ String extendsFrom() default "";
+
+ String isAbstract() default "";
+
+ String alternateKeys1() default "";
+
+ String maximumDepth() default "";
+
+ String crossEntityReference() default "";
+
+ String requires() default "";
+
+ String dbAlias() default "";
+
+ String dataLocation() default "";
+
+ String containsSuggestibleProps() default "";
+
+ String suggestionAliases() default "";
+
+ String sourceOfTruthType() default "";
}
diff --git a/aai-annotations/src/main/java/org/onap/aai/schema/enums/ObjectMetadata.java b/aai-annotations/src/main/java/org/onap/aai/schema/enums/ObjectMetadata.java
index 39cfdec4..2ac4538d 100644
--- a/aai-annotations/src/main/java/org/onap/aai/schema/enums/ObjectMetadata.java
+++ b/aai-annotations/src/main/java/org/onap/aai/schema/enums/ObjectMetadata.java
@@ -8,7 +8,7 @@
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -17,116 +17,124 @@
* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.schema.enums;
public enum ObjectMetadata {
- /**
- * description of object
- */
- DESCRIPTION("description"),
- /**
- * names of properties to appear in relationship-lists
- * and parent objects in DMaaP messages
- * <br><b>comma separated list</b>
- */
- NAME_PROPS("nameProps"),
- /**
- * names of properties to be indexed in the
- * db schema
- * <br><b>comma separated list</b>
- */
- INDEXED_PROPS("indexedProps"),
- /**
- * name of the object this one depends on
- */
- DEPENDENT_ON("dependentOn"),
- /**
- * name of the object which contains this object
- */
- CONTAINER("container"),
- /**
- * the top level namespace to which this object belongs<br>
- * <b>only valid on top level objects</b>
- */
- NAMESPACE("namespace"),
- /**
- * properties which are searchable via the GUI
- * <br><b>comma separated list</b>
- */
- SEARCHABLE("searchable"),
- /**
- * properties marked as unique in the db schema
- * <br><b>comma separated list</b>
- */
- UNIQUE_PROPS("uniqueProps"),
- /**
- * properties marked as required
- * <br><b>comma separated list</b>
- */
- REQUIRED_PROPS("requiredProps"),
- /**
- * uri template for this object
- */
- URI_TEMPLATE("uriTemplate"),
- /**
- * abstract type from which this object extends
- */
- EXTENDS("extends"),
- /**
- * comma separated list of objects who inherit this object<br>
- * <b>only valid on abstract objects</b>
- */
- INHERITORS("inheritors"),
- /**
- * a value of true marks this object as abstract
- * abstract objects cannot be read/written directly
- * they resolve to "or queries" when used in queries
- */
- ABSTRACT("abstract"),
- /**
- * comma separated list of properties which are alternate ways
- * to identify this object
- */
- ALTERNATE_KEYS_1("alternateKeys1"),
- /**
- * the maximum allowable retrievable depth
- */
- MAXIMUM_DEPTH("maximumDepth"),
- /**
- * collection of other objects to retrieve along with this one
- * <br><b>comma separated list</b>
- */
- CROSS_ENTITY_REFERENCE("crossEntityReference"),
- /**
- * Marks that this object can be linked to via dataLink
- */
- CAN_BE_LINKED("canBeLinked"),
- /**
- * The entity contains properties that are suggestible
- */
- CONTAINS_SUGGESTIBLE_PROPS("containsSuggestibleProps"),
- /**
- * A list of aliases for the entity name (for AAI UI searches)
- */
- SUGGESTION_ALIASES("suggestionAliases"),
- /**
- * a value of true allows this object to be read directly
- */
- ALLOW_DIRECT_READ("allowDirectRead"),
- /**
- * a value of true allows this object to be written directly
- */
- ALLOW_DIRECT_WRITE("allowDirectWrite");
-
- private final String name;
+ /**
+ * description of object
+ */
+ DESCRIPTION("description"),
+ /**
+ * names of properties to appear in relationship-lists
+ * and parent objects in DMaaP messages
+ * <br>
+ * <b>comma separated list</b>
+ */
+ NAME_PROPS("nameProps"),
+ /**
+ * names of properties to be indexed in the
+ * db schema
+ * <br>
+ * <b>comma separated list</b>
+ */
+ INDEXED_PROPS("indexedProps"),
+ /**
+ * name of the object this one depends on
+ */
+ DEPENDENT_ON("dependentOn"),
+ /**
+ * name of the object which contains this object
+ */
+ CONTAINER("container"),
+ /**
+ * the top level namespace to which this object belongs<br>
+ * <b>only valid on top level objects</b>
+ */
+ NAMESPACE("namespace"),
+ /**
+ * properties which are searchable via the GUI
+ * <br>
+ * <b>comma separated list</b>
+ */
+ SEARCHABLE("searchable"),
+ /**
+ * properties marked as unique in the db schema
+ * <br>
+ * <b>comma separated list</b>
+ */
+ UNIQUE_PROPS("uniqueProps"),
+ /**
+ * properties marked as required
+ * <br>
+ * <b>comma separated list</b>
+ */
+ REQUIRED_PROPS("requiredProps"),
+ /**
+ * uri template for this object
+ */
+ URI_TEMPLATE("uriTemplate"),
+ /**
+ * abstract type from which this object extends
+ */
+ EXTENDS("extends"),
+ /**
+ * comma separated list of objects who inherit this object<br>
+ * <b>only valid on abstract objects</b>
+ */
+ INHERITORS("inheritors"),
+ /**
+ * a value of true marks this object as abstract
+ * abstract objects cannot be read/written directly
+ * they resolve to "or queries" when used in queries
+ */
+ ABSTRACT("abstract"),
+ /**
+ * comma separated list of properties which are alternate ways
+ * to identify this object
+ */
+ ALTERNATE_KEYS_1("alternateKeys1"),
+ /**
+ * the maximum allowable retrievable depth
+ */
+ MAXIMUM_DEPTH("maximumDepth"),
+ /**
+ * collection of other objects to retrieve along with this one
+ * <br>
+ * <b>comma separated list</b>
+ */
+ CROSS_ENTITY_REFERENCE("crossEntityReference"),
+ /**
+ * Marks that this object can be linked to via dataLink
+ */
+ CAN_BE_LINKED("canBeLinked"),
+ /**
+ * The entity contains properties that are suggestible
+ */
+ CONTAINS_SUGGESTIBLE_PROPS("containsSuggestibleProps"),
+ /**
+ * A list of aliases for the entity name (for AAI UI searches)
+ */
+ SUGGESTION_ALIASES("suggestionAliases"),
+ /**
+ * a value of true allows this object to be read directly
+ */
+ ALLOW_DIRECT_READ("allowDirectRead"),
+ /**
+ * a value of true allows this object to be written directly
+ */
+ ALLOW_DIRECT_WRITE("allowDirectWrite");
+
+ private final String name;
+
+ private ObjectMetadata(String name) {
+ this.name = name;
+ }
- private ObjectMetadata(String name) {
- this.name = name;
- }
+ @Override
+ public String toString() {
+ return name;
+ }
- @Override public String toString() {
- return name;
- }
-
}
diff --git a/aai-annotations/src/main/java/org/onap/aai/schema/enums/PropertyMetadata.java b/aai-annotations/src/main/java/org/onap/aai/schema/enums/PropertyMetadata.java
index ac2c00b7..559501a7 100644
--- a/aai-annotations/src/main/java/org/onap/aai/schema/enums/PropertyMetadata.java
+++ b/aai-annotations/src/main/java/org/onap/aai/schema/enums/PropertyMetadata.java
@@ -8,7 +8,7 @@
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -17,68 +17,70 @@
* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.schema.enums;
public enum PropertyMetadata {
- /**
- * description of property
- */
- DESCRIPTION("description"),
- /**
- * default value of property
- */
- DEFAULT_VALUE("defaultValue"),
- /**
- * sets the property name used when writing to the db
- */
- DB_ALIAS("dbAlias"),
- /**
- * a URI which describes the location of a value to be
- * written on a PUT
- */
- DATA_COPY("dataCopy"),
- /**
- * a URI which describes another object which backs this value
- */
- DATA_LINK("dataLink"),
- /**
- * controls the visibility of a field based on context
- */
- VISIBILITY("visibility"),
- /**
- * specifies a field which must be populated to pass validation
- */
- REQUIRES("requires"),
- /**
- * automatically creates an id for the property if not specified
- */
- AUTO_GENERATE_UUID("autoGenerateUuid"),
- /**
- * Property is used for VNF searches in AAI UI
- */
- SUGGESTIBLE_ON_SEARCH("suggestibleOnSearch"),
- /**
- * An identifier that indicates which system is the master of this property data
- */
- SOURCE_OF_TRUTH_TYPE("sourceOfTruthType"),
- /**
- * makes property read only by version
- */
- READ_ONLY("readOnly"),
- /**
- * Add a private edge between two objects based on the uri provided by user which should provide
- * the appropriate information from the url similar to dataCopy
- */
- PRIVATE_EDGE("privateEdge");
-
- private final String name;
+ /**
+ * description of property
+ */
+ DESCRIPTION("description"),
+ /**
+ * default value of property
+ */
+ DEFAULT_VALUE("defaultValue"),
+ /**
+ * sets the property name used when writing to the db
+ */
+ DB_ALIAS("dbAlias"),
+ /**
+ * a URI which describes the location of a value to be
+ * written on a PUT
+ */
+ DATA_COPY("dataCopy"),
+ /**
+ * a URI which describes another object which backs this value
+ */
+ DATA_LINK("dataLink"),
+ /**
+ * controls the visibility of a field based on context
+ */
+ VISIBILITY("visibility"),
+ /**
+ * specifies a field which must be populated to pass validation
+ */
+ REQUIRES("requires"),
+ /**
+ * automatically creates an id for the property if not specified
+ */
+ AUTO_GENERATE_UUID("autoGenerateUuid"),
+ /**
+ * Property is used for VNF searches in AAI UI
+ */
+ SUGGESTIBLE_ON_SEARCH("suggestibleOnSearch"),
+ /**
+ * An identifier that indicates which system is the master of this property data
+ */
+ SOURCE_OF_TRUTH_TYPE("sourceOfTruthType"),
+ /**
+ * makes property read only by version
+ */
+ READ_ONLY("readOnly"),
+ /**
+ * Add a private edge between two objects based on the uri provided by user which should provide
+ * the appropriate information from the url similar to dataCopy
+ */
+ PRIVATE_EDGE("privateEdge");
+
+ private final String name;
- private PropertyMetadata(String name) {
- this.name = name;
- }
+ private PropertyMetadata(String name) {
+ this.name = name;
+ }
- @Override public String toString() {
- return name;
- }
+ @Override
+ public String toString() {
+ return name;
+ }
}
diff --git a/aai-annotations/src/test/java/org/onap/aai/annotations/AnnotationsTest.java b/aai-annotations/src/test/java/org/onap/aai/annotations/AnnotationsTest.java
index a518e0c2..e41ae284 100644
--- a/aai-annotations/src/test/java/org/onap/aai/annotations/AnnotationsTest.java
+++ b/aai-annotations/src/test/java/org/onap/aai/annotations/AnnotationsTest.java
@@ -8,7 +8,7 @@
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -17,6 +17,7 @@
* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.annotations;
import org.onap.aai.annotations.Metadata;
@@ -26,23 +27,24 @@ public class AnnotationsTest {
public AnnotationsTest() {
}
- @Metadata(isKey = false,
- description = "",
- nameProps = "",
- indexedProps = "",
- dependentOn = "",
- container = "",
- namespace = "",
- defaultValue = "",
- searchable = "",
- uniqueProps = "",
- requiredProps = "",
- uriTemplate = "",
- extendsFrom = "",
- isAbstract = "",
- alternateKeys1 = "",
- maximumDepth = "",
- crossEntityReference = "")
+ @Metadata(
+ isKey = false,
+ description = "",
+ nameProps = "",
+ indexedProps = "",
+ dependentOn = "",
+ container = "",
+ namespace = "",
+ defaultValue = "",
+ searchable = "",
+ uniqueProps = "",
+ requiredProps = "",
+ uriTemplate = "",
+ extendsFrom = "",
+ isAbstract = "",
+ alternateKeys1 = "",
+ maximumDepth = "",
+ crossEntityReference = "")
public void testAnnotation() {
}
}