org.atmosphere.cpr.AtmosphereObjectFactory Maven / Gradle / Ivy
/*
* Copyright 2015 Sebastien Dionne
*
* 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 org.atmosphere.cpr;
import org.atmosphere.inject.AtmosphereConfigAware;
/**
* Customization point for Atmosphere to instantiate classes.
* Useful when using a DI framework.
*
* @author Norman Franke
* @author Jeanfrancois Arcand
*/
public interface AtmosphereObjectFactory extends AtmosphereConfigAware {
/**
* Delegate the creation of Object to the underlying object provider like Spring, Guice, etc.
*
* When creating a class, it is important to check if the class can be configured via its implementation
* of the {@link org.atmosphere.inject.AtmosphereConfigAware}. {@link org.atmosphere.inject.AtmosphereConfigAware#configure(AtmosphereConfig)}
* should be called in that case.
*
* @param classType The class' type to be created
* @param defaultType a class to be created @return an instance of T
* @throws InstantiationException
* @throws IllegalAccessException
*/
public T newClassInstance(Class classType, Class defaultType) throws InstantiationException, IllegalAccessException;
/**
* Pass information to the underlying Dependency Injection Implementation
* @param z an Z
* @return this
*/
public AtmosphereObjectFactory allowInjectionOf(Z z);
}