enterprise/payara.jakartaee/src/org/netbeans/modules/payara/jakartaee/ide/MonitorProgressObject.java - netbeans - Git at Google

 /*
  * 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.payara.jakartaee.ide;

 import org.netbeans.modules.payara.tooling.admin.CommandGetProperty;
 import org.netbeans.modules.payara.tooling.admin.ResultMap;
 import java.io.File;
 import java.io.IOException;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.StringTokenizer;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeoutException;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import javax.enterprise.deploy.shared.ActionType;
 import javax.enterprise.deploy.shared.CommandType;
 import javax.enterprise.deploy.shared.StateType;
 import javax.enterprise.deploy.spi.TargetModuleID;
 import javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException;
 import javax.enterprise.deploy.spi.status.*;
 import org.netbeans.modules.payara.tooling.PayaraIdeException;
 import org.netbeans.modules.payara.tooling.TaskEvent;
 import org.netbeans.modules.payara.tooling.TaskState;
 import org.netbeans.modules.payara.tooling.TaskStateListener;
 import org.netbeans.modules.payara.tooling.utils.Utils;
 import org.netbeans.modules.payara.jakartaee.Hk2DeploymentManager;
 import org.netbeans.modules.j2ee.dd.api.application.Application;
 import org.netbeans.modules.j2ee.dd.api.application.DDProvider;
 import org.netbeans.modules.j2ee.dd.api.application.Module;
 import org.netbeans.modules.j2ee.dd.api.application.Web;
 import org.openide.filesystems.FileUtil;

 /**
  * Progress object that monitors events from Payara Common and translates
  * them into JSR-88 equivalents.
  *
  * @author Peter Williams
  */
 public class MonitorProgressObject
         implements ProgressObject, TaskStateListener {

     /** Server property pattern prefix to search in applications. */
     private static final String PROPERTY_PATTERN_PREFIX
             = "applications.application.";

     private final Hk2DeploymentManager dm;
     private final Hk2TargetModuleID moduleId;
     private final CommandType commandType;

     public MonitorProgressObject(Hk2DeploymentManager dm, Hk2TargetModuleID moduleId) {
         this(dm, moduleId, CommandType.DISTRIBUTE);
     }

     public MonitorProgressObject(Hk2DeploymentManager dm, Hk2TargetModuleID moduleId, CommandType commandType) {
         this.dm = dm;
         this.moduleId = moduleId;
         this.commandType = commandType;
         this.operationStatus = new Hk2DeploymentStatus(commandType,
                 StateType.RUNNING, ActionType.EXECUTE, "Initializing...");
     }

     @Override
     public DeploymentStatus getDeploymentStatus() {
         return operationStatus;
     }

     @Override
     public TargetModuleID[] getResultTargetModuleIDs() {
         if (null == moduleId) {
             return computeResultTMID();
         } else {
             synchronized (moduleId) {
                 return computeResultTMID();
             }
         }
     }

     @Override
     public ClientConfiguration getClientConfiguration(TargetModuleID moduleId) {
         throw new UnsupportedOperationException("Not supported yet.");
     }

     @Override
     public boolean isCancelSupported() {
         return false;
     }

     @Override
     public void cancel() throws OperationUnsupportedException {
         throw new OperationUnsupportedException("Cancel not supported yet.");
     }

     @Override
     public boolean isStopSupported() {
         return false;
     }

     @Override
     public void stop() throws OperationUnsupportedException {
         throw new OperationUnsupportedException("Stop not supported yet.");
     }

     /**
      * OperationState listener - translates state events from common instance
      * manager to JSR-88 compatible type.
      *
      * @param newState Current state of operation
      * @param message Informational message about latest state change
      */
     @Override
     public void operationStateChanged(
             TaskState newState, TaskEvent event, String... args) {
         String message = args != null ? Utils.concatenate(args) : "";
         Logger.getLogger("payara-jakartaee").log(Level.FINE, message);
         // Suppress message except in cases of failure.  Returning an empty
         // string prevents status from being displayed in build output window.
         String relayedMessage = newState == TaskState.FAILED ? message : "";
         fireHandleProgressEvent(new Hk2DeploymentStatus(commandType,
                 translateState(newState), ActionType.EXECUTE, relayedMessage));
     }

     private TargetModuleID[] computeResultTMID() {
         TargetModuleID[] retVal = new TargetModuleID[]{moduleId};
          try {
             retVal = createModuleIdTree(moduleId);
          } catch (InterruptedException | ExecutionException | TimeoutException ex) {
              Logger.getLogger("payara-jakartaee").log(Level.INFO, null, ex);
          }
          return retVal;
     }

     private void loopThroughListeners(DeploymentStatus status) {
         operationStatus = status;
         ProgressEvent event = new ProgressEvent(dm, moduleId, status);
         for (ProgressListener target : listeners) {
             target.handleProgressEvent(event);
         }
     }

     private StateType translateState(TaskState commonState) {
         switch(commonState) {
             case READY: case RUNNING:
                 return StateType.RUNNING;
             case COMPLETED:
                 return StateType.COMPLETED;
             case FAILED:
                 return StateType.FAILED;
             default:
                 return StateType.FAILED;
         }
     }

     // ProgressEvent/Listener support

     private volatile DeploymentStatus operationStatus;
     private CopyOnWriteArrayList<ProgressListener> listeners =
             new CopyOnWriteArrayList<ProgressListener>();

     @Override
     public void addProgressListener(ProgressListener listener) {
         listeners.add(listener);
     }

     @Override
     public void removeProgressListener(ProgressListener listener) {
         listeners.remove(listener);
     }

     public void fireHandleProgressEvent(DeploymentStatus status) {
         if (null == moduleId) {
             loopThroughListeners(status);
         } else {
             synchronized(moduleId) {
                 loopThroughListeners(status);
             }
         }
     }

     static final private String[] TYPES = {"web", "ejb"};

     private TargetModuleID[] createModuleIdTree(Hk2TargetModuleID moduleId)
             throws InterruptedException, ExecutionException, TimeoutException {
         synchronized (moduleId) {
             // this should only get called in the ear deploy case...
             Hk2TargetModuleID root
                     = Hk2TargetModuleID.get((Hk2Target) moduleId.getTarget(),
                     moduleId.getModuleID(), null, moduleId.getLocation(), true);
             // build the tree of submodule
             String query = getNameToQuery(moduleId.getModuleID());
             int queryLen = query != null ? query.length() : 0;
             StringBuilder propertyPattern = new StringBuilder(
                     PROPERTY_PATTERN_PREFIX.length() + queryLen);
             propertyPattern.append(PROPERTY_PATTERN_PREFIX);
             if (queryLen > 0) {
                 propertyPattern.append(query);
             }
             try {
                 ResultMap<String, String> result = CommandGetProperty
                         .getProperties(dm.getCommonServerSupport()
                         .getInstance(), propertyPattern.toString(), 60000);
                 if (result.getState() == TaskState.COMPLETED) {
                     Map<String, String> values = result.getValue();
                     for (Entry<String, String> e : values.entrySet()) {
                         String k = e.getKey();
                         int dex1 = k.lastIndexOf(".module."); // NOI18N
                         int dex2 = k.lastIndexOf(".name"); // NOI18N
                         String moduleName = e.getValue();
                         if (dex2 > dex1 && dex1 > 0
                                 && !moduleId.getModuleID().equals(moduleName)) {
                             for (String guess : TYPES) {
                                 String type
                                         = values.get("applications.application."
                                         + moduleId.getModuleID() + ".module."
                                         + moduleName + ".engine." + guess
                                         + ".sniffer");
                                 if (null != type) {
                                     Hk2TargetModuleID kid = Hk2TargetModuleID
                                             .get(
                                             (Hk2Target) moduleId.getTarget(),
                                             moduleName, "web".equals(guess)
                                             ? determineContextRoot(root, moduleName)
                                             : null,
                                             moduleId.getLocation()
                                             + File.separator
                                             + FastDeploy.transform(moduleName));
                                     root.addChild(kid);
                                 }
                             }
                         }
                     }

                 }
             } catch (PayaraIdeException gfie) {
                 Logger.getLogger("payara-jakartaee").log(Level.INFO,
                         "Could not retrieve property from server.", gfie);
             }
             return new TargetModuleID[]{root};
         }
     }

     // hotfix for #176096 - maven moduleID can contains dots and result is that
     // GetPropertyCommand above does not match right module. this fix
     // is extracting the longest name which does not have dots and will use it
     // as query, for example for "org.foo.bar.mywebapp_1.0-dev the query
     // will be "mywebapp_1"

     private String getNameToQuery(String name) {
         if (name.indexOf('.') == -1) {
             return name+".*";
         }
         StringTokenizer st = new StringTokenizer(name, ".");
         String newName = "";
         int segment = 0;
         int nameSegment = 0;
         while (st.hasMoreTokens()) {
             String token = st.nextToken();
             segment++;
             if (token.length() > newName.length()) {
                 newName = token;
                 nameSegment = segment;
             }
         }
         return (nameSegment > 1 ? "*."+newName : newName)+".*";
     }

     private String determineContextRoot(Hk2TargetModuleID root, String moduleName) {
         String retVal = "/" + moduleName;  // incorrect falback
         int dex = moduleName.lastIndexOf('.');
         if (dex > -1) {
             retVal = "/" + moduleName.substring(0, dex);
         }
         // look for the application.xml
         File appxml = new File(root.getLocation(), "META-INF"+File.separator+"application.xml");
         if (appxml.exists()) {
             try {
                 // TODO read the entries
                 DDProvider ddp = DDProvider.getDefault();
                 Application app = ddp.getDDRoot(FileUtil.createData(FileUtil.normalizeFile(appxml)));
                 // TODO build a map
                 Module[] mods = app.getModule();
                 for (Module m : mods) {
                     Web w = m.getWeb();
                     if (null != w && moduleName.equals(w.getWebUri())) {
                         retVal = w.getContextRoot();
                         break;
                     }
                 }
             } catch (IOException ex) {
                 Logger.getLogger("payara-jakartaee").log(Level.INFO, null, ex);
             }
         }
         return retVal;
     }
 }
	/*
	* 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.payara.jakartaee.ide;

	import org.netbeans.modules.payara.tooling.admin.CommandGetProperty;
	import org.netbeans.modules.payara.tooling.admin.ResultMap;
	import java.io.File;
	import java.io.IOException;
	import java.util.Map;
	import java.util.Map.Entry;
	import java.util.StringTokenizer;
	import java.util.concurrent.CopyOnWriteArrayList;
	import java.util.concurrent.ExecutionException;
	import java.util.concurrent.TimeoutException;
	import java.util.logging.Level;
	import java.util.logging.Logger;
	import javax.enterprise.deploy.shared.ActionType;
	import javax.enterprise.deploy.shared.CommandType;
	import javax.enterprise.deploy.shared.StateType;
	import javax.enterprise.deploy.spi.TargetModuleID;
	import javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException;
	import javax.enterprise.deploy.spi.status.*;
	import org.netbeans.modules.payara.tooling.PayaraIdeException;
	import org.netbeans.modules.payara.tooling.TaskEvent;
	import org.netbeans.modules.payara.tooling.TaskState;
	import org.netbeans.modules.payara.tooling.TaskStateListener;
	import org.netbeans.modules.payara.tooling.utils.Utils;
	import org.netbeans.modules.payara.jakartaee.Hk2DeploymentManager;
	import org.netbeans.modules.j2ee.dd.api.application.Application;
	import org.netbeans.modules.j2ee.dd.api.application.DDProvider;
	import org.netbeans.modules.j2ee.dd.api.application.Module;
	import org.netbeans.modules.j2ee.dd.api.application.Web;
	import org.openide.filesystems.FileUtil;

	/**
	* Progress object that monitors events from Payara Common and translates
	* them into JSR-88 equivalents.
	*
	* @author Peter Williams
	*/
	public class MonitorProgressObject
	implements ProgressObject, TaskStateListener {

	/** Server property pattern prefix to search in applications. */
	private static final String PROPERTY_PATTERN_PREFIX
	= "applications.application.";

	private final Hk2DeploymentManager dm;
	private final Hk2TargetModuleID moduleId;
	private final CommandType commandType;

	public MonitorProgressObject(Hk2DeploymentManager dm, Hk2TargetModuleID moduleId) {
	this(dm, moduleId, CommandType.DISTRIBUTE);
	}

	public MonitorProgressObject(Hk2DeploymentManager dm, Hk2TargetModuleID moduleId, CommandType commandType) {
	this.dm = dm;
	this.moduleId = moduleId;
	this.commandType = commandType;
	this.operationStatus = new Hk2DeploymentStatus(commandType,
	StateType.RUNNING, ActionType.EXECUTE, "Initializing...");
	}

	@Override
	public DeploymentStatus getDeploymentStatus() {
	return operationStatus;
	}

	@Override
	public TargetModuleID[] getResultTargetModuleIDs() {
	if (null == moduleId) {
	return computeResultTMID();
	} else {
	synchronized (moduleId) {
	return computeResultTMID();
	}
	}
	}

	@Override
	public ClientConfiguration getClientConfiguration(TargetModuleID moduleId) {
	throw new UnsupportedOperationException("Not supported yet.");
	}

	@Override
	public boolean isCancelSupported() {
	return false;
	}

	@Override
	public void cancel() throws OperationUnsupportedException {
	throw new OperationUnsupportedException("Cancel not supported yet.");
	}

	@Override
	public boolean isStopSupported() {
	return false;
	}

	@Override
	public void stop() throws OperationUnsupportedException {
	throw new OperationUnsupportedException("Stop not supported yet.");
	}

	/**
	* OperationState listener - translates state events from common instance
	* manager to JSR-88 compatible type.
	*
	* @param newState Current state of operation
	* @param message Informational message about latest state change
	*/
	@Override
	public void operationStateChanged(
	TaskState newState, TaskEvent event, String... args) {
	String message = args != null ? Utils.concatenate(args) : "";
	Logger.getLogger("payara-jakartaee").log(Level.FINE, message);
	// Suppress message except in cases of failure. Returning an empty
	// string prevents status from being displayed in build output window.
	String relayedMessage = newState == TaskState.FAILED ? message : "";
	fireHandleProgressEvent(new Hk2DeploymentStatus(commandType,
	translateState(newState), ActionType.EXECUTE, relayedMessage));
	}

	private TargetModuleID[] computeResultTMID() {
	TargetModuleID[] retVal = new TargetModuleID[]{moduleId};
	try {
	retVal = createModuleIdTree(moduleId);
	} catch (InterruptedException \| ExecutionException \| TimeoutException ex) {
	Logger.getLogger("payara-jakartaee").log(Level.INFO, null, ex);
	}
	return retVal;
	}

	private void loopThroughListeners(DeploymentStatus status) {
	operationStatus = status;
	ProgressEvent event = new ProgressEvent(dm, moduleId, status);
	for (ProgressListener target : listeners) {
	target.handleProgressEvent(event);
	}
	}

	private StateType translateState(TaskState commonState) {
	switch(commonState) {
	case READY: case RUNNING:
	return StateType.RUNNING;
	case COMPLETED:
	return StateType.COMPLETED;
	case FAILED:
	return StateType.FAILED;
	default:
	return StateType.FAILED;
	}
	}

	// ProgressEvent/Listener support

	private volatile DeploymentStatus operationStatus;
	private CopyOnWriteArrayList<ProgressListener> listeners =
	new CopyOnWriteArrayList<ProgressListener>();

	@Override
	public void addProgressListener(ProgressListener listener) {
	listeners.add(listener);
	}

	@Override
	public void removeProgressListener(ProgressListener listener) {
	listeners.remove(listener);
	}

	public void fireHandleProgressEvent(DeploymentStatus status) {
	if (null == moduleId) {
	loopThroughListeners(status);
	} else {
	synchronized(moduleId) {
	loopThroughListeners(status);
	}
	}
	}

	static final private String[] TYPES = {"web", "ejb"};

	private TargetModuleID[] createModuleIdTree(Hk2TargetModuleID moduleId)
	throws InterruptedException, ExecutionException, TimeoutException {
	synchronized (moduleId) {
	// this should only get called in the ear deploy case...
	Hk2TargetModuleID root
	= Hk2TargetModuleID.get((Hk2Target) moduleId.getTarget(),
	moduleId.getModuleID(), null, moduleId.getLocation(), true);
	// build the tree of submodule
	String query = getNameToQuery(moduleId.getModuleID());
	int queryLen = query != null ? query.length() : 0;
	StringBuilder propertyPattern = new StringBuilder(
	PROPERTY_PATTERN_PREFIX.length() + queryLen);
	propertyPattern.append(PROPERTY_PATTERN_PREFIX);
	if (queryLen > 0) {
	propertyPattern.append(query);
	}
	try {
	ResultMap<String, String> result = CommandGetProperty
	.getProperties(dm.getCommonServerSupport()
	.getInstance(), propertyPattern.toString(), 60000);
	if (result.getState() == TaskState.COMPLETED) {
	Map<String, String> values = result.getValue();
	for (Entry<String, String> e : values.entrySet()) {
	String k = e.getKey();
	int dex1 = k.lastIndexOf(".module."); // NOI18N
	int dex2 = k.lastIndexOf(".name"); // NOI18N
	String moduleName = e.getValue();
	if (dex2 > dex1 && dex1 > 0
	&& !moduleId.getModuleID().equals(moduleName)) {
	for (String guess : TYPES) {
	String type
	= values.get("applications.application."
	+ moduleId.getModuleID() + ".module."
	+ moduleName + ".engine." + guess
	+ ".sniffer");
	if (null != type) {
	Hk2TargetModuleID kid = Hk2TargetModuleID
	.get(
	(Hk2Target) moduleId.getTarget(),
	moduleName, "web".equals(guess)
	? determineContextRoot(root, moduleName)
	: null,
	moduleId.getLocation()
	+ File.separator
	+ FastDeploy.transform(moduleName));
	root.addChild(kid);
	}
	}
	}
	}

	}
	} catch (PayaraIdeException gfie) {
	Logger.getLogger("payara-jakartaee").log(Level.INFO,
	"Could not retrieve property from server.", gfie);
	}
	return new TargetModuleID[]{root};
	}
	}

	// hotfix for #176096 - maven moduleID can contains dots and result is that
	// GetPropertyCommand above does not match right module. this fix
	// is extracting the longest name which does not have dots and will use it
	// as query, for example for "org.foo.bar.mywebapp_1.0-dev the query
	// will be "mywebapp_1"

	private String getNameToQuery(String name) {
	if (name.indexOf('.') == -1) {
	return name+".*";
	}
	StringTokenizer st = new StringTokenizer(name, ".");
	String newName = "";
	int segment = 0;
	int nameSegment = 0;
	while (st.hasMoreTokens()) {
	String token = st.nextToken();
	segment++;
	if (token.length() > newName.length()) {
	newName = token;
	nameSegment = segment;
	}
	}
	return (nameSegment > 1 ? "."+newName : newName)+".";
	}

	private String determineContextRoot(Hk2TargetModuleID root, String moduleName) {
	String retVal = "/" + moduleName; // incorrect falback
	int dex = moduleName.lastIndexOf('.');
	if (dex > -1) {
	retVal = "/" + moduleName.substring(0, dex);
	}
	// look for the application.xml
	File appxml = new File(root.getLocation(), "META-INF"+File.separator+"application.xml");
	if (appxml.exists()) {
	try {
	// TODO read the entries
	DDProvider ddp = DDProvider.getDefault();
	Application app = ddp.getDDRoot(FileUtil.createData(FileUtil.normalizeFile(appxml)));
	// TODO build a map
	Module[] mods = app.getModule();
	for (Module m : mods) {
	Web w = m.getWeb();
	if (null != w && moduleName.equals(w.getWebUri())) {
	retVal = w.getContextRoot();
	break;
	}
	}
	} catch (IOException ex) {
	Logger.getLogger("payara-jakartaee").log(Level.INFO, null, ex);
	}
	}
	return retVal;
	}
	}