enterprise/maven.j2ee/src/org/netbeans/modules/maven/j2ee/BaseEEModuleProvider.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.netbeans.modules.maven.j2ee;

import org.netbeans.modules.maven.j2ee.execution.ExecutionChecker;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.project.Project;
import org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule;
import org.netbeans.modules.j2ee.deployment.devmodules.api.ModuleChangeReporter;
import org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleFactory;
import org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleImplementation2;
import org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleProvider;
import org.netbeans.modules.maven.api.execute.RunUtils;
import org.netbeans.modules.maven.j2ee.utils.Server;
import org.netbeans.modules.maven.j2ee.utils.ServerUtils;
import org.netbeans.modules.maven.j2ee.utils.MavenProjectSupport;

/**
 * Base class for ModuleProvider implementation of different project types
 * At the moment it's not a base class only for EAR projects, because there is different API provider which need to be
 * implemented in EAR projects.
 *
 * @author mjanicek
 */
public abstract class BaseEEModuleProvider extends J2eeModuleProvider {

    protected Project project;
    protected String serverInstanceID;
    protected J2eeModule j2eemodule;
    protected CopyOnSave copyOnSave;
    protected ModuleChangeReporter changeReporter;


    public BaseEEModuleProvider(Project project) {
        this.project = project;
        this.changeReporter = new ModuleChangeReporterImpl();
    }

    public abstract J2eeModuleImplementation2 getModuleImpl();


    @Override
    public boolean isOnlyCompileOnSaveEnabled() {
        return RunUtils.isCompileOnSaveEnabled(project) && !MavenProjectSupport.isDeployOnSave(project);
    }

    @Override
    public ModuleChangeReporter getModuleChangeReporter() {
        return changeReporter;
    }

    @Override
    @CheckForNull
    public DeployOnSaveSupport getDeployOnSaveSupport() {
        return getCopyOnSave();
    }

    /**
     * Returns actual CopyOnSave instance registered for the project. This method also call initialize method,
     * but it's up to client to call copyOnSave.cleanup().
     *
     * @return actual or newly created instance
     */
    @CheckForNull
    public CopyOnSave getCopyOnSaveSupport() {
        return getCopyOnSave();
    }

    @CheckForNull
    private CopyOnSave getCopyOnSave() {
        if (copyOnSave == null) {
            copyOnSave = project.getLookup().lookup(CopyOnSave.class);
            if (copyOnSave != null) {
                copyOnSave.initialize();
            }
        }
        return copyOnSave;
    }

    @Override
    public synchronized J2eeModule getJ2eeModule() {
        if (j2eemodule == null) {
            j2eemodule = J2eeModuleFactory.createJ2eeModule(getModuleImpl());
        }
        return j2eemodule;
    }

    @Override
    public void setServerInstanceID(String newId) {
        String oldId = null;
        if (serverInstanceID != null) {
            oldId = MavenProjectSupport.obtainServerID(serverInstanceID);
        }
        serverInstanceID = newId;
        fireServerChange(oldId, getServerID());
    }

    /**
     * Id of server instance for deployment. The default implementation returns
     * the default server instance selected in Server Registry.
     * The return value may not be null.
     * If modules override this method they also need to override {@link useDefaultServer}.
     */
    @Override
    public String getServerInstanceID() {
        if (serverInstanceID != null) {
            return serverInstanceID;
        }

        Server server = ServerUtils.findServer(project);
        if (server != null) {
            return server.getServerInstanceID();
        }
        return ExecutionChecker.DEV_NULL;
    }

    /**
     * This method is used to determine type of target server.
     * The return value must correspond to value returned from {@link getServerInstanceID}.
     */
    @Override
    public String getServerID() {
        if (serverInstanceID != null) {
            String serverID = MavenProjectSupport.obtainServerID(serverInstanceID);
            if (serverID != null) {
                return serverID;
            }
        }

        Server server = ServerUtils.findServer(project);
        if (server != null) {
            return server.getServerID();
        }
        return ExecutionChecker.DEV_NULL;
    }
}