1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2016 ForgeRock AS.
15 */
16
17 package org.forgerock.api.annotations;
18
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * Specify a schema for the element that is being described.
26 * <p>
27 * This annotation can also be used to specify an {@code id} for a schema defined by a type.
28 */
29 @Retention(RetentionPolicy.RUNTIME)
30 @Target({ElementType.METHOD, ElementType.TYPE})
31 public @interface Schema {
32
33 /**
34 * The schema identifier. If provided, this schema will be added to definitions and referenced from
35 * anywhere it is used. If null/empty, the schema will be used inline.
36 */
37 String id() default "";
38 /** The type to produce the schema from. */
39 Class<?> fromType() default Void.class;
40 /**
41 * A classpath resource that contains a JSON Schema structure to be used. The path is relative to the type
42 * that the annotated resource method is part of, and will be resolved using the
43 * {@link Class#getResourceAsStream(String)} method on that class instance.
44 */
45 String schemaResource() default "";
46
47 }