001/**
002 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
003 *   This file is part of the LDP4j Project:
004 *     http://www.ldp4j.org/
005 *
006 *   Center for Open Middleware
007 *     http://www.centeropenmiddleware.com/
008 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
009 *   Copyright (C) 2014-2016 Center for Open Middleware.
010 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
011 *   Licensed under the Apache License, Version 2.0 (the "License");
012 *   you may not use this file except in compliance with the License.
013 *   You may obtain a copy of the License at
014 *
015 *             http://www.apache.org/licenses/LICENSE-2.0
016 *
017 *   Unless required by applicable law or agreed to in writing, software
018 *   distributed under the License is distributed on an "AS IS" BASIS,
019 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 *   See the License for the specific language governing permissions and
021 *   limitations under the License.
022 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
023 *   Artifact    : org.ldp4j.framework:ldp4j-application-api:0.2.1
024 *   Bundle      : ldp4j-application-api-0.2.1.jar
025 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
026 */
027package org.ldp4j.application.ext.annotations;
028
029import java.lang.annotation.Documented;
030import java.lang.annotation.ElementType;
031import java.lang.annotation.Retention;
032import java.lang.annotation.RetentionPolicy;
033import java.lang.annotation.Target;
034
035import org.ldp4j.application.ext.ResourceHandler;
036
037/**
038 * Used for defining templates for Direct Container LDP Resources.
039 */
040@Documented
041@Retention(RetentionPolicy.RUNTIME)
042@Target({ ElementType.TYPE })
043public @interface DirectContainer {
044
045  /**
046   * The identifier of the template. The identifier must be
047   * application-unique.
048   */
049  String id();
050
051  /** The human-based name of the template. */
052  String name() default "";
053
054  /** A description of the purpose of the template. */
055  String description() default "";
056
057  /** The attachments of the template. */
058  Attachment[] attachments() default {};
059
060  /**
061   * The {@code ResourceHandler} class that will handle the member resources
062   * of the container.
063   */
064  Class<? extends ResourceHandler> memberHandler();
065
066  /** If defined, the path prefix to be used when publishing member resources. */
067  String memberPath() default "";
068
069  /**
070   * The membership predicate to use for relating the member resources with
071   * the container.
072   */
073  String membershipPredicate() default "http://www.w3.org/ns/ldp#member";
074
075  /**
076   * The membership relation to use for defining direction of the relationship
077   * between the member resources with the container .
078   */
079  MembershipRelation membershipRelation() default MembershipRelation.HAS_MEMBER;
080
081}