/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.server.deployment;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.CONTENT;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.HASH;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import org.jboss.as.controller.HashUtil;
import org.jboss.as.controller.registry.Resource;
import org.jboss.as.server.controller.resources.DeploymentAttributes;
import org.jboss.as.server.deployment.module.ResourceRoot;
import org.jboss.dmr.ModelNode;
import org.jboss.msc.service.ServiceName;
import org.wildfly.common.Assert;
/**
* Helper class with static methods related to deployment
*
* TODO: this should probably be somewhere else
*
* @author Stuart Douglas
* @author Ales Justin
*/
public final class DeploymentUtils {
/**
* Format used to display timestamp of enable/disable operations.
*/
static String DATEFORMAT_ATTR = "yyyy-MM-dd HH:mm:ss,SSS zzz";
/**
* Get all resource roots for a {@link DeploymentUnit}
*
* @param deploymentUnit The deployment unit
* @return The deployment root and any additional resource roots
*/
public static List<ResourceRoot> allResourceRoots(DeploymentUnit deploymentUnit) {
List<ResourceRoot> roots = new ArrayList<ResourceRoot>();
// not all deployment units have a deployment root
final ResourceRoot deploymentRoot = deploymentUnit.getAttachment(Attachments.DEPLOYMENT_ROOT);
if (deploymentRoot != null)
roots.add(deploymentRoot);
roots.addAll(deploymentUnit.getAttachmentList(Attachments.RESOURCE_ROOTS));
return roots;
}
/**
* Get top deployment unit.
*
* @param unit the current deployment unit
* @return top deployment unit
*/
public static DeploymentUnit getTopDeploymentUnit(DeploymentUnit unit) {
Assert.checkNotNullParam("unit", unit);
DeploymentUnit parent = unit.getParent();
while (parent != null) {
unit = parent;
parent = unit.getParent();
}
return unit;
}
public static boolean skipRepeatedActivation(DeploymentUnit unit, int maxValue) {
AtomicInteger count = unit.getAttachment(Attachments.DEFERRED_ACTIVATION_COUNT);
return count != null && count.get() > maxValue;
}
public static ServiceName getDeploymentUnitPhaseServiceName(final DeploymentUnit depUnit, final Phase phase) {
DeploymentUnit parent = depUnit.getParent();
if (parent == null) {
return Services.deploymentUnitName(depUnit.getName(), phase);
} else {
return Services.deploymentUnitName(parent.getName(), depUnit.getName(), phase);
}
}
public static void addDeferredModule(DeploymentUnit depUnit) {
DeploymentUnit topUnit = getTopDeploymentUnit(depUnit);
topUnit.addToAttachmentList(Attachments.DEFERRED_MODULES, depUnit.getName());
}
public static List<String> getDeferredModules(DeploymentUnit depUnit) {
DeploymentUnit topUnit = getTopDeploymentUnit(depUnit);
return topUnit.getAttachmentList(Attachments.DEFERRED_MODULES);
}
public static List<byte[]> getDeploymentHash(Resource deployment) {
return getDeploymentHash(deployment.getModel());
}
public static List<byte[]> getDeploymentHash(ModelNode deployment){
List<byte[]> hashes = new ArrayList<byte[]>();
if (deployment.hasDefined(CONTENT)) {
for (ModelNode contentElement : deployment.get(CONTENT).asList()) {
if (contentElement.hasDefined(HASH)) {
final byte[] hash = contentElement.get(HASH).asBytes();
hashes.add(hash);
}
}
}
return hashes;
}
public static Set<String> getDeploymentHexHash(ModelNode deployment){
Set<String> hashes = new HashSet<String>();
if (deployment.hasDefined(CONTENT)) {
for (ModelNode contentElement : deployment.get(CONTENT).asList()) {
if (contentElement.hasDefined(HASH)) {
hashes.add(HashUtil.bytesToHexString(contentElement.get(HASH).asBytes()));
}
}
}
return hashes;
}
/**
* Set the enabled-time{stamp} attribute of deployment to the current timestamp. Useful to track the deployment enable events.
*
* @param model
*/
static void enableAttribute(ModelNode model) {
Date enabledTime = new Date();
DateFormat df = new SimpleDateFormat(DATEFORMAT_ATTR);
model.get(DeploymentAttributes.ENABLED_TIME.getName()).set(enabledTime.getTime());
model.get(DeploymentAttributes.ENABLED_TIMESTAMP.getName()).set(df.format(enabledTime));
}
/**
* Set the disabled-time{stamp} attribute of deployment to the current timestamp. Useful to track the deployment disable events.
*
* @param model
*/
static void disableAttribute(ModelNode model) {
Date enabledTime = new Date();
DateFormat df = new SimpleDateFormat(DATEFORMAT_ATTR);
model.get(DeploymentAttributes.DISABLED_TIME.getName()).set(enabledTime.getTime());
model.get(DeploymentAttributes.DISABLED_TIMESTAMP.getName()).set(df.format(enabledTime));
}
private DeploymentUtils() {
}
}