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.2
024 *   Bundle      : ldp4j-application-api-0.2.2.jar
025 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
026 */
027package org.ldp4j.application.ext;
028
029import org.ldp4j.application.session.WriteSession;
030import org.ldp4j.application.setup.Bootstrap;
031import org.ldp4j.application.setup.Environment;
032
033/**
034 * The entry point for an LDP4j Application. This class provides the means for
035 * controlling the life-cycle of the application: the bootstrapping of the
036 * application and the application termination.
037 */
038public abstract class Application<T extends Configuration> {
039
040  /**
041   * Returns the {@link Class} of the configuration class type parameter.
042   *
043   * @return the configuration class
044   * @see Generics#getTypeParameter(Class, Class)
045   */
046  public final Class<T> getConfigurationClass() {
047    return Generics.getTypeParameter(getClass(), Configuration.class);
048  }
049
050  /**
051   * Return the name of the application.
052   *
053   * @return the application's name
054   */
055  public String getName() {
056    return getClass().getSimpleName();
057  }
058
059  /**
060   * Setup the application. <br>
061   *
062   * The implementation class will have to register the resource handler
063   * instances and classes in the {@code Bootstrap} instance, and publish
064   * the root resources for the application in the {@code Environment} instance.
065   *
066   * @param environment
067   *            the environment for publishing root resources.
068   * @param bootstrap
069   *            the bootstrap for registering resource handler instances and
070   *            classes.
071   * @throws ApplicationSetupException
072   *             if any failure prevented setting up the application.
073   */
074  public abstract void setup(Environment environment, Bootstrap<T> bootstrap) throws ApplicationSetupException;
075
076  /**
077   * Initialize the application. <br>
078   *
079   * The implementation class may synchronize its internal state with the
080   * state of the resources already managed by the LDP4j framework.
081   *
082   * @param session
083   *            the session to use for controlling the lifecycle of the
084   *            resources managed by the framework.
085   * @throws ApplicationInitializationException
086   *             if any failure prevented the initialization of the
087   *             application.
088   */
089  public abstract void initialize(WriteSession session) throws ApplicationInitializationException;
090
091  /**
092   * Shutdown the application. <br>
093   *
094   * The implementation class should carry out any termination activity
095   * required before shutting down the application.
096   *
097   * @throws ApplicationShutdownException
098   *             if any failure prevented the graceful termination of the
099   *             application.
100   */
101  public abstract void shutdown() throws ApplicationShutdownException;
102
103}