com.canoo.dolphin.server.container.ContainerManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dolphin-platform-server Show documentation

The Dolphin Platform is a framework that implements the presentation model pattern and provides amodern way to create enterprise applications. The Platform provides several client implementations that all canbe used in combination with a general sever API.

There is a newer version: 1.0.0.CR5

Show newest version

/*
 * Copyright 2015-2017 Canoo Engineering AG.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.canoo.dolphin.server.container;

import com.canoo.dolphin.server.DolphinSessionListener;

import javax.servlet.ServletContext;

/**
 * 
 * This interface defines the platform / container specific controller management.
 * By default Dolphin Platform provides 2 implementations of this interface for Spring and JavaEE that
 * can be found in the specific modules. If you want to add the support for a different platform you need to
 * provide a custom implementation of this interface.
 * 
 * 
 * Here is a short overview how the architecture is defined:
 * 

 * 

 * 
 */
public interface ContainerManager {

    /**
     * This method must be called before the {@link ContainerManager} instance can be used. Some specific implementations
     * needs access to the {@link ServletContext} that is set by calling this method.
     * @param servletContext the servlet context
     */
    void init(ServletContext servletContext);

    /**
     * Creates a new managed instance for the given controller class.
     * @param controllerClass the class of the controller
     * @param modelInjector a injector that will be called to inject the model in the controller
     * @param  type of the controller
     * @return the new controller instance
     */
     T createManagedController(Class controllerClass, ModelInjector modelInjector);

    /**
     * Creates a new managed instance. See {@link com.canoo.dolphin.server.DolphinListener} and
     * {@link DolphinSessionListener} for more information
     * @param listenerClass the class of the listenerClass
     * @param  type of the listener
     * @return the new listener instance
     */
     T createListener(Class listenerClass);

    /**
     * Destroyes the given controller instance
     * @param instance controller instance
     * @param controllerClass type of controller
     */
    void destroyController(Object instance, Class controllerClass);

}