/* * JBoss, Home of Professional Open Source. * Copyright 2013, Red Hat, Inc., and individual contributors * as indicated by the @author tags. See the copyright.txt file 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.wildfly.plugin.common; import static org.jboss.as.controller.client.helpers.ClientConstants.CHILD_TYPE; import static org.jboss.as.controller.client.helpers.ClientConstants.DEPLOYMENT; import static org.jboss.as.controller.client.helpers.ClientConstants.RECURSIVE; import static org.jboss.as.controller.client.helpers.ClientConstants.RESULT; import java.util.List; import org.jboss.as.controller.client.helpers.ClientConstants; import org.jboss.as.controller.client.helpers.Operations; import org.jboss.dmr.ModelNode; import org.jboss.dmr.ModelType; import org.jboss.dmr.Property; /** * A helper for creating operations. * * @author <a href="mailto:[email protected]">James R. Perkins</a> */ public class ServerOperations extends Operations { public static final String ARCHIVE = "archive"; public static final String BYTES = "bytes"; public static final String ENABLE = "enable"; public static final String ENABLED = "enabled"; public static final String INPUT_STREAM_INDEX = "input-stream-index"; public static final String LAUNCH_TYPE = "launch-type"; public static final String PROFILE = "profile"; public static final String READ_CHILDREN_NAMES = "read-children-names"; public static final String READ_RESOURCE = "read-resource"; public static final String RELOAD = "reload"; /** * Parses the result and returns the failure description. If the result was successful, an empty string is * returned. * * @param result the result of executing an operation * * @return the failure message or an empty string */ public static String getFailureDescriptionAsString(final ModelNode result) { if (isSuccessfulOutcome(result)) { return ""; } final String msg; if (result.hasDefined(ClientConstants.FAILURE_DESCRIPTION)) { if (result.hasDefined(ClientConstants.OP)) { msg = String.format("Operation '%s' at address '%s' failed: %s", result.get(ClientConstants.OP), result.get(ClientConstants.OP_ADDR), result .get(ClientConstants.FAILURE_DESCRIPTION)); } else { msg = String.format("Operation failed: %s", result.get(ClientConstants.FAILURE_DESCRIPTION)); } } else { msg = String.format("An unexpected response was found checking the deployment. Result: %s", result); } return msg; } /** * Creates an operation to list the deployments. * * @return the operation */ public static ModelNode createListDeploymentsOperation() { final ModelNode op = createOperation(READ_CHILDREN_NAMES); op.get(CHILD_TYPE).set(DEPLOYMENT); return op; } /** * Creates a remove operation. * * @param address the address for the operation * @param recursive {@code true} if the remove should be recursive, otherwise {@code false} * * @return the operation */ public static ModelNode createRemoveOperation(final ModelNode address, final boolean recursive) { final ModelNode op = createRemoveOperation(address); op.get(RECURSIVE).set(recursive); return op; } /** * Creates an operation to read the attribute represented by the {@code attributeName} parameter. * * @param attributeName the name of the parameter to read * * @return the operation */ public static ModelNode createReadAttributeOperation(final String attributeName) { return createReadAttributeOperation(new ModelNode().setEmptyList(), attributeName); } public static ModelNode createAddress(final String key, final String name) { final ModelNode address = new ModelNode().setEmptyList(); address.add(key, name); return address; } /** * Creates an address from the consecutive pairs. If there is an odd number of arguments the last argument will be * a wildcard ({@code *}). * * @param pairs the name/value pairs to create the address for * * @return the address for the arguments */ public static ModelNode createAddress(final String... pairs) { final ModelNode address = new ModelNode().setEmptyList(); final int len = pairs.length; for (int i = 0; i < len; i++) { final String key = pairs[i]; final String name = (++i < len) ? pairs[i] : "*"; address.add(key, name); } return address; } /** * Creates an operation. * * @param operation the operation name * @param address the address for the operation * @param recursive whether the operation is recursive or not * * @return the operation * * @throws IllegalArgumentException if the address is not of type {@link ModelType#LIST} */ public static ModelNode createOperation(final String operation, final ModelNode address, final boolean recursive) { final ModelNode op = createOperation(operation, address); op.get(RECURSIVE).set(recursive); return op; } /** * Finds the last entry of the address list and returns it as a property. * * @param address the address to get the last part of * * @return the last part of the address * * @throws IllegalArgumentException if the address is not of type {@link ModelType#LIST} or is empty */ public static Property getChildAddress(final ModelNode address) { if (address.getType() != ModelType.LIST) { throw new IllegalArgumentException("The address type must be a list."); } final List<Property> addressParts = address.asPropertyList(); if (addressParts.isEmpty()) { throw new IllegalArgumentException("The address is empty."); } return addressParts.get(addressParts.size() - 1); } /** * Finds the parent address, everything before the last address part. * * @param address the address to get the parent * * @return the parent address * * @throws IllegalArgumentException if the address is not of type {@link ModelType#LIST} or is empty */ public static ModelNode getParentAddress(final ModelNode address) { if (address.getType() != ModelType.LIST) { throw new IllegalArgumentException("The address type must be a list."); } final ModelNode result = new ModelNode(); final List<Property> addressParts = address.asPropertyList(); if (addressParts.isEmpty()) { throw new IllegalArgumentException("The address is empty."); } for (int i = 0; i < addressParts.size() - 1; ++i) { final Property property = addressParts.get(i); result.add(property.getName(), property.getValue()); } return result; } /** * Reads the result of an operation and returns the result as a string. If the operation does not have a {@link * ClientConstants#RESULT} attribute and empty string is returned. * * @param result the result of executing an operation * * @return the result of the operation or an empty string */ public static String readResultAsString(final ModelNode result) { return (result.hasDefined(RESULT) ? result.get(RESULT).asString() : ""); } }