/*
* JBoss, Home of Professional Open Source.
* Copyright 2012, 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.jboss.as.controller.services.path;
import java.util.Locale;
import java.util.ResourceBundle;
import org.jboss.as.controller.AttributeDefinition;
import org.jboss.as.controller.ControllerMessages;
import org.jboss.as.controller.OperationContext;
import org.jboss.as.controller.OperationDefinition;
import org.jboss.as.controller.OperationFailedException;
import org.jboss.as.controller.OperationStepHandler;
import org.jboss.as.controller.PathAddress;
import org.jboss.as.controller.SimpleAttributeDefinition;
import org.jboss.as.controller.SimpleAttributeDefinitionBuilder;
import org.jboss.as.controller.SimpleOperationDefinition;
import org.jboss.as.controller.SimpleOperationDefinitionBuilder;
import org.jboss.as.controller.descriptions.ModelDescriptionConstants;
import org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver;
import org.jboss.as.controller.descriptions.common.ControllerResolver;
import org.jboss.as.controller.registry.Resource;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.ModelType;
/**
* An operation to resolve a relative-to path.
* <p/>
* The operation should be placed on any operation that defines a relative-to path attribute.
* <p/>
* Example usage in an extension:
* <code>
* <pre>
* public class CustomExtension implements Extension {
* ...
*
* public void initialize(final ExtensionContext context) {
* final SubsystemRegistration subsystem = context.registerSubsystem(SUBSYSTEM_NAME,
* MANAGEMENT_API_MAJOR_VERSION, MANAGEMENT_API_MINOR_VERSION, MANAGEMENT_API_MICRO_VERSION);
* final ManagementResourceRegistration registration = subsystem.registerSubsystemModel(CustomFileResource.INSTANCE);
*
* final ResolvePathHandler resolvePathHandler = ResolvePathHandler.Builder.of(context.getPathManager()).build();
* registration.registerOperationHandler(ResolvePathHandler.OPERATION_DEFINITION, resolvePathHandler);
*
* subsystem.registerXMLElementWriter(CustomSubsystemParser.INSTANCE);
* }
*
* ...
* }
* </pre>
* </code>
*
* @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
*/
public class ResolvePathHandler implements OperationStepHandler {
private static final String OPERATION_NAME = "resolve-path";
// Attributes
public static final SimpleAttributeDefinition RELATIVE_TO_ONLY = SimpleAttributeDefinitionBuilder.create("relative-to-only", ModelType.BOOLEAN, true).build();
private static final SimpleOperationDefinition DEFAULT_OPERATION_DEFINITION = new SimpleOperationDefinitionBuilder(OPERATION_NAME, new ResolvePathResourceDescriptionResolver(OPERATION_NAME))
.addParameter(RELATIVE_TO_ONLY)
.setReplyType(ModelType.STRING)
.build();
private final AttributeDefinition parentAttribute;
private final AttributeDefinition relativeToAttribute;
private final AttributeDefinition pathAttribute;
private final OperationDefinition operationDefinition;
private final PathManager pathManager;
private ResolvePathHandler(final OperationDefinition operationDefinition, final AttributeDefinition parentAttribute,
final AttributeDefinition relativeToAttribute, final AttributeDefinition pathAttribute,
final PathManager pathManager) {
this.parentAttribute = parentAttribute;
this.relativeToAttribute = relativeToAttribute;
this.pathAttribute = pathAttribute;
this.operationDefinition = operationDefinition;
this.pathManager = pathManager;
}
@Override
public void execute(final OperationContext context, final ModelNode operation) throws OperationFailedException {
// Get the resource
final Resource resource = context.readResource(PathAddress.EMPTY_ADDRESS);
final ModelNode model = resource.getModel();
// Validate the operation
final ModelNode relativeToOnly = RELATIVE_TO_ONLY.validateOperation(operation);
final boolean resolveRelativeToOnly = relativeToOnly.asBoolean(false);
// Resolve the model values
final ModelNode file = (parentAttribute != null ? parentAttribute.resolveModelAttribute(context, model) : model);
final ModelNode relativeTo = relativeToAttribute.resolveModelAttribute(context, file);
final ModelNode path = pathAttribute.resolveModelAttribute(context, file);
// Resolve paths
final String result;
if (relativeTo.isDefined()) {
// If resolving the full path and a path is defined
if (!resolveRelativeToOnly && path.isDefined()) {
result = pathManager.resolveRelativePathEntry(path.asString(), relativeTo.asString());
} else {
result = pathManager.getPathEntry(relativeTo.asString()).resolvePath();
}
} else if (path.isDefined()) {
result = pathManager.resolveRelativePathEntry(path.asString(), null);
} else {
throw ControllerMessages.MESSAGES.noPathToResolve(relativeToAttribute.getName(), pathAttribute.getName(), model);
}
context.getResult().set(new ModelNode(result));
context.completeStep(OperationContext.RollbackHandler.NOOP_ROLLBACK_HANDLER);
}
/**
* Returns the operation definition for the operation.
*
* @return the operation definition
*/
public OperationDefinition getOperationDefinition() {
return operationDefinition;
}
/**
* Build an operation to resolve the
*/
public static class Builder {
private final PathManager pathManager;
private final OperationDefinition operationDefinition;
private AttributeDefinition parentAttribute;
private AttributeDefinition relativeToAttribute;
private AttributeDefinition pathAttribute;
private Builder(final OperationDefinition operationDefinition, final PathManager pathManager) {
this.operationDefinition = operationDefinition;
this.pathManager = pathManager;
}
/**
* Creates a builder with the default operation name of {@code resolve-path}.
*
* @param pathManager the path manager used to resolve the path
*
* @return the operation handler builder
*/
public static Builder of(final PathManager pathManager) {
if (pathManager == null) {
throw ControllerMessages.MESSAGES.nullVar("pathManager");
}
return new Builder(DEFAULT_OPERATION_DEFINITION, pathManager);
}
/**
* Creates a builder with the default operation name of defined in the {@code operationName} parameter.
* <p/>
* While this seems odd to add a deprecated method from the start, the transaction extension requires a
* separate operation as there are two relative paths. Other extensions should not use this method and if the
* transaction subsystem changes to use a proper resource for the {@code object-store}, this method should be
* removed.
*
* @param operationName the name of the operation to register
* @param pathManager the path manager used to resolve the path
*
* @return the operation handler builder
*/
@Deprecated
public static Builder of(final String operationName, final PathManager pathManager) {
if (pathManager == null) {
throw ControllerMessages.MESSAGES.nullVar("pathManager");
}
if (operationName == null) {
throw ControllerMessages.MESSAGES.nullVar("operationName");
}
final OperationDefinition operationDefinition = new SimpleOperationDefinitionBuilder(operationName, new ResolvePathResourceDescriptionResolver(operationName))
.addParameter(ResolvePathHandler.RELATIVE_TO_ONLY)
.setReplyType(ModelType.STRING)
.build();
return new Builder(operationDefinition, pathManager);
}
/**
* Builds the resolve path handler.
*
* @return the operation step handler
*/
public ResolvePathHandler build() {
if (relativeToAttribute == null) relativeToAttribute = PathResourceDefinition.RELATIVE_TO;
if (pathAttribute == null) pathAttribute = PathResourceDefinition.PATH;
return new ResolvePathHandler(operationDefinition, parentAttribute, relativeToAttribute, pathAttribute, pathManager);
}
/**
* Sets the parent attribute that the {@code relative-to} and {@code path} attributes are children of. A value
* of {@code null} indicates they are a direct decedent of the resource.
*
* @param parentAttribute the parent attribute
*
* @return the builder
*/
public Builder setParentAttribute(final AttributeDefinition parentAttribute) {
this.parentAttribute = parentAttribute;
return this;
}
/**
* Sets the {@code relative-to} attribute. The default value is {@link PathResourceDefinition#RELATIVE_TO}.
*
* @param relativeToAttribute the relative to attribute
*
* @return the builder
*/
public Builder setRelativeToAttribute(final AttributeDefinition relativeToAttribute) {
this.relativeToAttribute = relativeToAttribute;
return this;
}
/**
* Sets the {@code path} attribute. The default value is {@link PathResourceDefinition#PATH}.
*
* @param pathAttribute the path to attribute
*
* @return the builder
*/
public Builder setPathAttribute(final AttributeDefinition pathAttribute) {
this.pathAttribute = pathAttribute;
return this;
}
}
private static class ResolvePathResourceDescriptionResolver extends StandardResourceDescriptionResolver {
private final String operationName;
public ResolvePathResourceDescriptionResolver(final String operationName) {
super(ModelDescriptionConstants.PATH, ControllerResolver.RESOURCE_NAME, ResolvePathHandler.class.getClassLoader(), false, false);
this.operationName = operationName;
}
@Override
public String getOperationDescription(String operationName, Locale locale, ResourceBundle bundle) {
if (this.operationName.equals(operationName)) {
return bundle.getString(getBundleKey());
}
return super.getOperationParameterDescription(operationName, operationName, locale, bundle);
}
@Override
public String getOperationParameterDescription(final String operationName, final String paramName, final Locale locale, final ResourceBundle bundle) {
if (this.operationName.equals(operationName)) {
return bundle.getString(getBundleKey(paramName));
}
return super.getOperationParameterDescription(operationName, paramName, locale, bundle);
}
@Override
public String getOperationReplyDescription(String operationName, Locale locale, ResourceBundle bundle) {
if (this.operationName.equals(operationName)) {
return bundle.getString(getBundleKey(REPLY));
}
return super.getOperationReplyDescription(operationName, locale, bundle);
}
}
private static String getBundleKey() {
return String.format("%s.%s", ModelDescriptionConstants.PATH, OPERATION_NAME);
}
private static String getBundleKey(final String key) {
return String.format("%s.%s.%s", ModelDescriptionConstants.PATH, OPERATION_NAME, key);
}
}