Deployer.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.openejb.assembler;

import org.apache.openejb.NoSuchApplicationException;
import org.apache.openejb.OpenEJBException;
import org.apache.openejb.UndeployException;
import org.apache.openejb.assembler.classic.AppInfo;

import java.util.Collection;
import java.util.Properties;

// The signature of this interface must never change without caution
// it is used in many tools either internal or external (intellij idea)
public interface Deployer {
    String FILENAME = "filename";
    String ALT_DD = "altDD";

    /**
     * Returns a unique file per runtime. Clients can test for the existence of this file
     * to determine if the deployer is on the local machine.
     *
     * @return String - The canonical pathname
     */
    String getUniqueFile();

    Collection<AppInfo> getDeployedApps();

    AppInfo deploy(String location) throws OpenEJBException;

    AppInfo deploy(Properties properties) throws OpenEJBException;

    AppInfo deploy(String location, Properties properties) throws OpenEJBException;

    void undeploy(String moduleId) throws UndeployException, NoSuchApplicationException;

    void reload(String moduleId);
}