001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    
018    package org.apache.geronimo.deployment;
019    
020    import javax.enterprise.deploy.spi.DeploymentConfiguration;
021    import javax.enterprise.deploy.model.DeployableObject;
022    import javax.enterprise.deploy.shared.ModuleType;
023    
024    /**
025     * Interface to be implemented by the deployment subsystem for any type
026     * of component (e.g. EAR, WAR, ...) that needs configuration.
027     * 
028     * @version $Rev: 706640 $ $Date: 2008-10-21 14:44:05 +0000 (Tue, 21 Oct 2008) $
029     */
030    public interface ModuleConfigurer {
031        /**
032         * JSR88 method for getting the vendor part of the deployment configuration
033         * @param deployable the object the tool is trying to deploy
034         * @return the vendor-specific deployment configuration, or null a configurer cannot handle the DeployableObject
035         */
036        DeploymentConfiguration createConfiguration(DeployableObject deployable);
037    
038        /**
039         * Supply the module type this configurer handles for indexing
040         * @return ModuleType handled by this Configurer.
041         */
042        ModuleType getModuleType();
043    }