/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html * or packager/legal/LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at packager/legal/LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. */ package org.glassfish.internal.deployment; import org.glassfish.api.deployment.archive.ArchiveHandler; import org.glassfish.api.deployment.archive.ReadableArchive; import org.glassfish.api.deployment.DeploymentContext; import org.glassfish.api.deployment.OpsParams; import org.glassfish.api.deployment.UndeployCommandParameters; import org.glassfish.api.admin.ParameterMap; import org.glassfish.api.container.Sniffer; import org.glassfish.api.ActionReport; import org.glassfish.api.event.EventTypes; import org.glassfish.hk2.classmodel.reflect.Types; import org.glassfish.internal.data.ApplicationInfo; import org.glassfish.internal.data.EngineInfo; import org.glassfish.internal.data.ModuleInfo; import org.glassfish.internal.data.ProgressTracker; import org.jvnet.hk2.annotations.Contract; import org.jvnet.hk2.config.TransactionFailure; import org.jvnet.hk2.config.Transaction; import com.sun.enterprise.config.serverbeans.Application; import com.sun.enterprise.config.serverbeans.ApplicationRef; import java.io.IOException; import java.io.File; import java.util.LinkedList; import java.util.List; import java.util.Properties; import java.util.Collection; import java.util.logging.Logger; /** * Deployment facility * * @author Jerome Dochez */ @Contract public interface Deployment { /** * This asynchronous event is sent when a new deployment or loading of an already deployed application start. It is invoked * once before any sniffer is invoked. */ public final EventTypes DEPLOYMENT_START = EventTypes.create("Deployment_Start", DeploymentContext.class); /** * This asynchronous event is sent when a deployment activity (first time deploy or loading of an already deployed application) * failed. */ public final EventTypes DEPLOYMENT_FAILURE = EventTypes.create("Deployment_Failed", DeploymentContext.class); /** * This asynchronous event is sent before prepare phase of deployment. */ public final EventTypes DEPLOYMENT_BEFORE_CLASSLOADER_CREATION = EventTypes.create("Deployment_ClassLoader_Creation", DeploymentContext.class); /** * This asynchronous event is sent when a deployment activity (first time deploy or loading of an already deployed application) * succeeded. */ public final EventTypes DEPLOYMENT_SUCCESS = EventTypes.create("Deployment_Success", ApplicationInfo.class); /** * This asynchronous event is sent when a new deployment or loading of an already deployed application start. It is invoked * once before any sniffer is invoked. */ public final EventTypes UNDEPLOYMENT_START = EventTypes.create("Undeployment_Start", ApplicationInfo.class); /** * This asynchronous event is sent when a deployment activity (first time deploy or loading of an already deployed application) * failed. */ public final EventTypes UNDEPLOYMENT_FAILURE = EventTypes.create("Undeployment_Failed", DeploymentContext.class); /** * This asynchronous event is sent when a deployment activity (first time deploy or loading of an already deployed application) * succeeded. */ public final EventTypes UNDEPLOYMENT_SUCCESS = EventTypes.create("Undeployment_Success", DeploymentContext.class); /** * The following synchronous events are sent after each change in a module state. */ public final EventTypes MODULE_PREPARED = EventTypes.create("Module_Prepared", DeploymentContext.class); public final EventTypes MODULE_LOADED = EventTypes.create("Module_Loaded", ModuleInfo.class); public final EventTypes MODULE_STARTED = EventTypes.create("Module_Running", ModuleInfo.class); public final EventTypes MODULE_STOPPED = EventTypes.create("Module_Stopped", ModuleInfo.class); public final EventTypes MODULE_UNLOADED = EventTypes.create("Module_Unloaded", ModuleInfo.class); public final EventTypes MODULE_CLEANED= EventTypes.create("Module_Cleaned", DeploymentContext.class); /** * The following synchronous events are sent after each change in an application stated (An application contains * 1 to many modules) */ public final EventTypes APPLICATION_PREPARED = EventTypes.create("Application_Prepared", DeploymentContext.class); public final EventTypes APPLICATION_LOADED = EventTypes.create("Application_Loaded", ApplicationInfo.class); public final EventTypes APPLICATION_STARTED = EventTypes.create("Application_Running", ApplicationInfo.class); public final EventTypes APPLICATION_STOPPED = EventTypes.create("Application_Stopped", ApplicationInfo.class); public final EventTypes APPLICATION_UNLOADED = EventTypes.create("Application_Unloaded", ApplicationInfo.class); public final EventTypes APPLICATION_CLEANED= EventTypes.create("Application_Cleaned", DeploymentContext.class); public final EventTypes APPLICATION_DISABLED = EventTypes.create("Application_Disabled", ApplicationInfo.class); /** * The following synchronous event is sent before the application is * undeployed so various listeners could validate the undeploy operation * and decide whether to abort undeployment */ public final EventTypes UNDEPLOYMENT_VALIDATION = EventTypes.create("Undeployment_Validation", DeploymentContext.class); public interface DeploymentContextBuilder { public DeploymentContextBuilder source(File source); public DeploymentContextBuilder source(ReadableArchive archive); public File sourceAsFile(); public ReadableArchive sourceAsArchive(); public ArchiveHandler archiveHandler(); public DeploymentContextBuilder archiveHandler(ArchiveHandler handler); public Logger logger(); public ActionReport report(); public OpsParams params(); public ExtendedDeploymentContext build() throws IOException; public abstract ExtendedDeploymentContext build(ExtendedDeploymentContext initialContext) throws IOException; } /** * The following asynchronous event is sent after all applications are * started in server start up. */ public final EventTypes ALL_APPLICATIONS_PROCESSED= EventTypes.create("All_Applications_Processed", DeploymentContext.class); public DeploymentContextBuilder getBuilder(Logger loggger, OpsParams params, ActionReport report); public ArchiveHandler getArchiveHandler(ReadableArchive archive) throws IOException; public ArchiveHandler getArchiveHandler(ReadableArchive archive, String type) throws IOException; public ModuleInfo prepareModule( List sortedEngineInfos, String moduleName, DeploymentContext context, ProgressTracker tracker) throws Exception; public ApplicationInfo deploy(final ExtendedDeploymentContext context); public ApplicationInfo deploy(final Collection sniffers, final ExtendedDeploymentContext context); public void undeploy(String appName, ExtendedDeploymentContext context); public Transaction prepareAppConfigChanges(final DeploymentContext context) throws TransactionFailure; public void registerAppInDomainXML(final ApplicationInfo applicationInfo, final DeploymentContext context, Transaction t) throws TransactionFailure; public void unregisterAppFromDomainXML(final String appName, final String target) throws TransactionFailure; public void registerAppInDomainXML(final ApplicationInfo applicationInfo, final DeploymentContext context, Transaction t, boolean appRefOnly) throws TransactionFailure; public void unregisterAppFromDomainXML(final String appName, final String target, boolean appRefOnly) throws TransactionFailure; public void updateAppEnabledAttributeInDomainXML(final String appName, final String target, final boolean enabled) throws TransactionFailure; public List setupContainerInfos( DeploymentContext context) throws Exception; public List setupContainerInfos(final ArchiveHandler handler, Collection sniffers, DeploymentContext context) throws Exception; public boolean isRegistered(String appName); public ApplicationInfo get(String appName); public List prepareSniffersForOSGiDeployment(String type, DeploymentContext context); public ParameterMap prepareInstanceDeployParamMap(DeploymentContext dc) throws Exception; public void validateDeploymentTarget(String target, String name, boolean isRedeploy); public void validateUndeploymentTarget(String target, String name); public boolean isAppEnabled(Application app); public ApplicationInfo unload(ApplicationInfo appInfo, ExtendedDeploymentContext context); public void disable(UndeployCommandParameters commandParams, Application app, ApplicationInfo appInfo, ActionReport report, Logger logger) throws Exception; public void enable(String target, Application app, ApplicationRef appRef, ActionReport report, Logger logger) throws Exception; /** * Scans the source of the deployment operation for all types * and store the result in the deployment context. * Subsequent calls will return the cached copy from the context * * @param context deployment context * @return the types information from the deployment artifacts * @throws IOException if the scanning fails due to an I/O exception */ public Types getDeployableTypes(DeploymentContext context) throws IOException; public List getSniffersFromApp(Application app); }