org.wildfly.apigen.model.ResourceDescription Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2010, 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.apigen.model;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.ModelType;
import org.jboss.dmr.Property;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.*;
/**
* Represents the result of a read-resource-description operation for one specific resource.
* @author Harald Pehl
*/
public class ResourceDescription extends ModelNode {
public final static ResourceDescription EMPTY = new ResourceDescription();
static final String ACCESS_CONTROL = "access-control";
static final String NOTIFICATIONS = "notifications";
private boolean isSingleton;
private String singletonName;
public ResourceDescription() {
super();
}
public ResourceDescription(ModelNode description) {
set(description);
}
public boolean hasAttributes() {
return hasDefined(ATTRIBUTES);
}
@SuppressWarnings("unchecked")
public List getAttributes() {
return hasAttributes() ? get(ATTRIBUTES).asPropertyList() : Collections.EMPTY_LIST;
}
public boolean hasAccessControl() {
return hasDefined(ACCESS_CONTROL);
}
public boolean hasChildrenDefined() {
return hasDefined(CHILDREN) && !get(CHILDREN).keys().isEmpty();
}
public boolean hasOperations() {
return hasDefined(OPERATIONS);
}
public boolean hasNotifications() {
return hasDefined(NOTIFICATIONS);
}
public Set getChildrenTypes() {
Set result = new HashSet<>();
if(hasChildrenDefined())
{
ModelNode children = get(CHILDREN);
List items = children.asPropertyList();
for (Property item : items) {
Set keys = item.getValue().get(MODEL_DESCRIPTION).keys();
if(keys.contains("*")) // regular resources (opposed to singletons, that carry distinct names)
{
result.add(item.getName());
}
}
}
return result;
}
public Set getSingletonChildrenTypes() {
Set result = new HashSet<>();
if(hasChildrenDefined())
{
ModelNode children = get(CHILDREN);
List items = children.asPropertyList();
for (Property item : items) {
Set keys = item.getValue().get(MODEL_DESCRIPTION).keys();
if(!keys.contains("*")) // singleton resources
{
result.addAll(keys.stream().map(key -> item.getName() + "=" + key).collect(Collectors.toList()));
}
}
}
return result;
}
/**
* Looks for the description of a child resource.
* @param childType The type of the child resource
* @return the description of the child resource or {@link #EMPTY} if no such resource exists.
*/
public ResourceDescription getChildDescription(String childType) {
return getChildDescription(childType, "*");
}
/**
* Looks for the description of a specific child resource.
* @param type The type of the child resource
* @param name The name of the instance
* @return the description of the specific child resource or {@link #EMPTY} if no such resource exists.
*/
public ResourceDescription getChildDescription(String type, String name) {
if (hasChildrenDefined()) {
List children = get("children").asPropertyList();
for (Property child : children) {
if (type.equals(child.getName()) && child.getValue().hasDefined(MODEL_DESCRIPTION)) {
List modelDescriptions = child.getValue().get(MODEL_DESCRIPTION).asPropertyList();
for (Property modelDescription : modelDescriptions) {
if (name.equals(modelDescription.getName())) {
return new ResourceDescription(modelDescription.getValue());
}
}
}
}
}
return EMPTY;
}
public static ResourceDescription from(ModelNode response) {
if(!response.get(OUTCOME).asString().equals(SUCCESS))
throw new RuntimeException(response.get(FAILURE_DESCRIPTION).asString());
ModelNode result = response.get(RESULT);
if(ModelType.LIST == result.getType())
{
// wildcard addressing
return new ResourceDescription(result.asList().get(0).get(RESULT));
}
else
{
// specific addressing
return new ResourceDescription(result);
}
}
public String getText() {
return get(DESCRIPTION).asString();
}
public boolean isSingleton() {
return isSingleton;
}
public String getSingletonName() {
return singletonName;
}
public void setSingletonName(String name) {
this.isSingleton = true;
this.singletonName = name;
}
}