org.apache.geronimo.deployment.spi.ModuleConfigurer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geronimo-deploy-config Show documentation

The deployment module contains basic infrastructure and base classes for module builders / deployers. This module contains infrastructure and base classes for JSR-88 DConfigBeans.

The newest version!

/**
 *  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.geronimo.deployment.spi;

import javax.enterprise.deploy.spi.DeploymentConfiguration;
import javax.enterprise.deploy.model.DeployableObject;
import javax.enterprise.deploy.shared.ModuleType;

/**
 * Interface to be implemented by the deployment subsystem for any type
 * of component (e.g. EAR, WAR, ...) that needs configuration.
 * 
 * @version $Rev: 1213810 $ $Date: 2011-12-14 02:00:08 +0800 (Wed, 14 Dec 2011) $
 */
public interface ModuleConfigurer {
    /**
     * JSR88 method for getting the vendor part of the deployment configuration
     * @param deployable the object the tool is trying to deploy
     * @return the vendor-specific deployment configuration, or null a configurer cannot handle the DeployableObject
     */
    DeploymentConfiguration createConfiguration(DeployableObject deployable);

    /**
     * Supply the module type this configurer handles for indexing
     * @return ModuleType handled by this Configurer.
     */
    ModuleType getModuleType();
}