/*
* JBoss, Home of Professional Open Source
* Copyright 2011 Red Hat Inc. and/or its affiliates and other contributors
* as indicated by the @authors tag. All rights reserved.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* 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,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
package org.jboss.as.domain.controller.operations.deployment;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ADD;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ARCHIVE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.BYTES;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.CONTENT;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.HASH;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.INPUT_STREAM_INDEX;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.NAME;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP_ADDR;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.PATH;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.RELATIVE_TO;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.RUNTIME_NAME;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.URL;
import static org.jboss.as.controller.operations.validation.ChainedParameterValidator.chain;
import static org.jboss.as.domain.controller.DomainControllerMessages.MESSAGES;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import org.jboss.as.controller.HashUtil;
import org.jboss.as.controller.OperationContext;
import org.jboss.as.controller.OperationFailedException;
import org.jboss.as.controller.OperationStepHandler;
import org.jboss.as.controller.PathAddress;
import org.jboss.as.controller.RunningMode;
import org.jboss.as.controller.descriptions.DescriptionProvider;
import org.jboss.as.controller.descriptions.common.DeploymentDescription;
import org.jboss.as.controller.operations.validation.AbstractParameterValidator;
import org.jboss.as.controller.operations.validation.ListValidator;
import org.jboss.as.controller.operations.validation.ModelTypeValidator;
import org.jboss.as.controller.operations.validation.ParametersOfValidator;
import org.jboss.as.controller.operations.validation.ParametersValidator;
import org.jboss.as.controller.operations.validation.StringLengthValidator;
import org.jboss.as.controller.registry.Resource;
import org.jboss.as.domain.controller.DomainControllerLogger;
import org.jboss.as.protocol.StreamUtils;
import org.jboss.as.repository.ContentRepository;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.ModelType;
/**
* Handles addition of a deployment to the model.
*
* @author Brian Stansberry (c) 2011 Red Hat Inc.
*/
public class DeploymentAddHandler implements OperationStepHandler, DescriptionProvider {
public static final String OPERATION_NAME = ADD;
private static final List<String> CONTENT_ADDITION_PARAMETERS = Arrays.asList(INPUT_STREAM_INDEX, BYTES, URL);
private final ContentRepository contentRepository;
private final ParametersValidator validator = new ParametersValidator();
private final ParametersValidator unmanagedContentValidator = new ParametersValidator();
private final ParametersValidator managedContentValidator = new ParametersValidator();
/** Constructor for a slave Host Controller */
public DeploymentAddHandler() {
this(null);
}
/**
* Constructor for a master Host Controller
*
* @param contentRepository the master content repository. If {@code null} this handler will function as a slave handler would.
*/
public DeploymentAddHandler(final ContentRepository contentRepository) {
this.contentRepository = contentRepository;
this.validator.registerValidator(RUNTIME_NAME, new StringLengthValidator(1, Integer.MAX_VALUE, true, false));
final ParametersValidator contentValidator = new ParametersValidator();
// existing managed content
contentValidator.registerValidator(HASH, new ModelTypeValidator(ModelType.BYTES, true));
// existing unmanaged content
contentValidator.registerValidator(ARCHIVE, new ModelTypeValidator(ModelType.BOOLEAN, true));
contentValidator.registerValidator(PATH, new StringLengthValidator(1, true));
contentValidator.registerValidator(RELATIVE_TO, new ModelTypeValidator(ModelType.STRING, true));
// content additions
contentValidator.registerValidator(INPUT_STREAM_INDEX, new ModelTypeValidator(ModelType.INT, true));
contentValidator.registerValidator(BYTES, new ModelTypeValidator(ModelType.BYTES, true));
contentValidator.registerValidator(URL, new StringLengthValidator(1, true));
this.validator.registerValidator(CONTENT, chain(new ListValidator(new ParametersOfValidator(contentValidator)),
new AbstractParameterValidator() {
@Override
public void validateParameter(String parameterName, ModelNode value) throws OperationFailedException {
validateOnePieceOfContent(value);
}
}));
this.managedContentValidator.registerValidator(HASH, new ModelTypeValidator(ModelType.BYTES));
this.unmanagedContentValidator.registerValidator(ARCHIVE, new ModelTypeValidator(ModelType.BOOLEAN));
this.unmanagedContentValidator.registerValidator(PATH, new StringLengthValidator(1));
}
@Override
public ModelNode getModelDescription(Locale locale) {
return DeploymentDescription.getAddDeploymentOperation(locale, false);
}
/**
* {@inheritDoc}
*/
public void execute(OperationContext context, ModelNode operation) throws OperationFailedException {
validator.validate(operation);
PathAddress address = PathAddress.pathAddress(operation.get(OP_ADDR));
String name = address.getLastElement().getValue();
String runtimeName = operation.hasDefined(RUNTIME_NAME) ? operation.get(RUNTIME_NAME).asString() : name;
byte[] hash = null;
// clone it, so we can modify it to our own content
final ModelNode content = operation.require(CONTENT).clone();
// TODO: JBAS-9020: for the moment overlays are not supported, so there is a single content item
final ModelNode contentItemNode = content.require(0);
if (contentItemNode.hasDefined(HASH)) {
managedContentValidator.validate(contentItemNode);
hash = contentItemNode.require(HASH).asBytes();
// If we are the master, validate that we actually have this content. If we're not the master
// we do not need the content until it's added to a server group we care about, so we defer
// pulling it until then
if (contentRepository != null && !contentRepository.hasContent(hash)) {
if (context.isBooting()) {
if (context.getRunningMode() == RunningMode.ADMIN_ONLY) {
// The deployment content is missing, which would be a fatal boot error if we were going to actually
// install services. In ADMIN-ONLY mode we allow it to give the admin a chance to correct the problem
DomainControllerLogger.HOST_CONTROLLER_LOGGER.reportAdminOnlyMissingDeploymentContent(HashUtil.bytesToHexString(hash), name);
} else {
throw createFailureException(MESSAGES.noDeploymentContentWithHashAtBoot(HashUtil.bytesToHexString(hash), name));
}
} else {
throw createFailureException(MESSAGES.noDeploymentContentWithHash(HashUtil.bytesToHexString(hash)));
}
}
} else if (hasValidContentAdditionParameterDefined(contentItemNode)) {
if (contentRepository == null) {
// This is a slave DC. We can't handle this operation; it should have been fixed up on the master DC
throw createFailureException(MESSAGES.slaveCannotAcceptUploads());
}
InputStream in = getInputStream(context, contentItemNode);
try {
try {
hash = contentRepository.addContent(in);
} catch (IOException e) {
throw createFailureException(e.toString());
}
} finally {
StreamUtils.safeClose(in);
}
contentItemNode.clear(); // AS7-1029
contentItemNode.get(HASH).set(hash);
} else {
// Unmanaged content, the user is responsible for replication
// Just validate the required attributes are present
unmanagedContentValidator.validate(contentItemNode);
}
final Resource resource = context.createResource(PathAddress.EMPTY_ADDRESS);
final ModelNode subModel = resource.getModel();
subModel.get(NAME).set(name);
subModel.get(RUNTIME_NAME).set(runtimeName);
subModel.get(CONTENT).set(content);
context.completeStep(OperationContext.RollbackHandler.NOOP_ROLLBACK_HANDLER);
}
private static InputStream getInputStream(OperationContext context, ModelNode operation) throws OperationFailedException {
InputStream in = null;
String message = "";
if (operation.hasDefined(INPUT_STREAM_INDEX)) {
int streamIndex = operation.get(INPUT_STREAM_INDEX).asInt();
message = MESSAGES.nullStream(streamIndex);
in = context.getAttachmentStream(streamIndex);
} else if (operation.hasDefined(BYTES)) {
message = MESSAGES.invalidByteStream();
in = new ByteArrayInputStream(operation.get(BYTES).asBytes());
} else if (operation.hasDefined(URL)) {
final String urlSpec = operation.get(URL).asString();
try {
message = MESSAGES.invalidUrlStream();
in = new URL(urlSpec).openStream();
} catch (MalformedURLException e) {
throw createFailureException(message);
} catch (IOException e) {
throw createFailureException(message);
}
}
if (in == null) {
throw createFailureException(message);
}
return in;
}
/**
* Checks to see if a valid deployment parameter has been defined.
*
* @param operation the operation to check.
* @return {@code true} of the parameter is valid, otherwise {@code false}.
*/
private static boolean hasValidContentAdditionParameterDefined(ModelNode operation) {
for (String s : CONTENT_ADDITION_PARAMETERS) {
if (operation.hasDefined(s)) {
return true;
}
}
return false;
}
private static OperationFailedException createFailureException(String msg) {
return new OperationFailedException(msg);
}
private static void validateOnePieceOfContent(final ModelNode content) throws OperationFailedException {
// TODO: implement overlays
if (content.asList().size() != 1)
throw createFailureException(MESSAGES.as7431());
}
}