DefaultLifecycleManager.java

/*******************************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.wink.common.internal.lifecycle;

import org.apache.wink.common.internal.i18n.Messages;
import org.apache.wink.common.internal.registry.metadata.ApplicationMetadataCollector;
import org.apache.wink.common.internal.registry.metadata.ProviderMetadataCollector;
import org.apache.wink.common.internal.registry.metadata.ResourceMetadataCollector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * <p>
 * Default implementation for LifecycleManager according to JAX RS (JSR 311).
 * <p>
 * For <tt>createObjectFactory(T object)</tt> the factory will always return a
 * SingletonObjectFactory.
 * <p>
 * For <tt>createObjectFactory(final Class<T> cls)</tt> the factory will return:
 * <ul>
 * <li>SingletonObjectFactory - for Providers</li>
 * <li>ClassMetadataPrototypeOF - for Resources</li>
 * <li>SimplePrototypeOF - for Resources (marked with DispatchedPath annotation)
 * </li>
 * </ul>
 * and throw IllegalArgumentException otherwise.
 * 
 * @param <T>
 * @see SingletonObjectFactory
 * @see PrototypeObjectFactory
 * @see SimplePrototypeOF
 */
class DefaultLifecycleManager<T> implements LifecycleManager<T> {

    private static final Logger logger = LoggerFactory.getLogger(DefaultLifecycleManager.class);

    /**
     * The default implementation, returns a SingletonFactory for all objects.
     */
    public ObjectFactory<T> createObjectFactory(T object) {
        if (object == null) {
            throw new NullPointerException(Messages.getMessage("variableIsNull", "object")); //$NON-NLS-1$ //$NON-NLS-2$
        }

        logger.trace("Creating a {} for {}", SingletonObjectFactory.class, object); //$NON-NLS-1$

        return LifecycleManagerUtils.createSingletonObjectFactory(object);
    }

    public ObjectFactory<T> createObjectFactory(final Class<T> cls) {
        logger.trace("Entry {}", cls); //$NON-NLS-1$

        if (cls == null) {
            throw new NullPointerException(Messages.getMessage("variableIsNull", "cls")); //$NON-NLS-1$ //$NON-NLS-2$
        }

        if (ResourceMetadataCollector.isDynamicResource(cls)) {
            // default factory cannot create instance of DynamicResource
            throw new IllegalArgumentException(Messages
                .getMessage("cannotCreateDefaultFactoryForDR", String.valueOf(cls))); //$NON-NLS-1$
        }

        ObjectFactory<T> ret = null;
        if (ApplicationMetadataCollector.isApplication(cls)) {
            // by default application subclasses are singletons
            ret = LifecycleManagerUtils.createSingletonObjectFactory(cls);
        } else if (ProviderMetadataCollector.isProvider(cls)) {
            // by default providers are singletons
            ret = LifecycleManagerUtils.createSingletonObjectFactory(cls);
        } else if (ResourceMetadataCollector.isStaticResource(cls)) {
            // by default resources are prototypes (created per request)
            ret = LifecycleManagerUtils.createPrototypeObjectFactory(cls);
        }

        if (ret != null) {
            logger.trace("Exit {}", ret); //$NON-NLS-1$
            return ret;
        } else
            // unknown object, should never reach this code
            throw new IllegalArgumentException(Messages
                .getMessage("cannotCreateDefaultFactoryFor", String.valueOf(cls))); //$NON-NLS-1$
    }

}