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.setup;
028
029import org.ldp4j.application.data.Name;
030import org.ldp4j.application.ext.ResourceHandler;
031import org.ldp4j.application.lifecycle.LifecycleEnvironment;
032
033/**
034 * Utility interface for initializing the root resources of an LDP4j
035 * Application. Using this class the application will be able to define the
036 * resources that will be published by default using a predefined path, and
037 * which {@code ResourceHandler} will handle the requests sent to the specified
038 * endpoint.
039 */
040public interface Environment {
041
042  /**
043   * Publish a resource managed by a particular handler class at a given path.
044   *
045   * @param resourceName
046   *            The name of the resource that is to be published.
047   * @param handlerClass
048   *            The class of the handler that will manage the resource
049   *            behind the endpoint.
050   * @param path
051   *            The path used to publish the resource. The path must end with
052   *            a single '/'.
053   */
054  void publishResource(Name<?> resourceName, Class<? extends ResourceHandler> handlerClass, String path);
055
056  /**
057   * Retrieve the Application's {@link LifecycleEnvironment}.
058   *
059   * @return the Application's {@link LifecycleEnvironment}.
060   */
061  LifecycleEnvironment lifecycle();
062
063}