Support parameter descriptions for operations. HWKAGENT-87.

hawkular-wildfly-agent-feature-pack/src/main/resources/subsystem-templates/hawkular-wildfly-agent.xml

@@ -609,7 +609,10 @@
         <operation-dmr name="JDR"      operation-name="generate-jdr-report" path="/subsystem=jdr" />
         <operation-dmr name="Reload"   operation-name="reload" />
         <operation-dmr name="Resume"   operation-name="resume" />
-        <operation-dmr name="Shutdown" operation-name="shutdown" /> <!-- shutdown and restart -->
+        <operation-dmr name="Shutdown" operation-name="shutdown" > <!-- shutdown and restart -->
+          <param name="timeout" type="number" defaultValue="0" description="Timeout in seconds to allow active connections to drain"/>
+          <param name="restart" type="bool" defaultValue="false" description="Should the server be restarted after shutdown?"/>
+        </operation-dmr>
         <operation-dmr name="Suspend"  operation-name="suspend" />
         <operation-dmr name="Deploy"   operation-name="deploy" />
         <operation-dmr name="Undeploy" operation-name="undeploy" />
@@ -627,11 +630,15 @@
         <resource-config-dmr name="Local Host Name" attribute="local-host-name" />
 
         <operation-dmr name="Reload Servers"  operation-name="reload-servers" />
-        <operation-dmr name="Restart Servers" operation-name="restart-servers" />
+        <operation-dmr name="Restart Servers" operation-name="restart-servers" >
+          <param name="timeout" type="number" defaultValue="0" description="Timeout in seconds to allow active connections to drain"/>
+        </operation-dmr>
         <operation-dmr name="Resume Servers"  operation-name="resume-servers" />
         <operation-dmr name="Start Servers"   operation-name="start-servers" />
         <operation-dmr name="Stop Servers"    operation-name="stop-servers" />
-        <operation-dmr name="Suspend Servers" operation-name="suspend-servers" />
+        <operation-dmr name="Suspend Servers" operation-name="suspend-servers" >
+          <param name="timeout" type="number" defaultValue="0" description="Timeout in seconds to allow active connections to drain"/>
+        </operation-dmr>
         <operation-dmr name="Deploy"          operation-name="deploy" />
         <operation-dmr name="Undeploy"        operation-name="undeploy" />
       </resource-type-dmr>

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/DMROperationAttributes.java

@@ -40,8 +40,9 @@ public interface DMROperationAttributes {
                     .addFlag(AttributeAccess.Flag.RESTART_RESOURCE_SERVICES)
                     .build();
 
+
     AttributeDefinition[] ATTRIBUTES = {
             PATH,
-            OPERATION_NAME
+            OPERATION_NAME,
     };
 }

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/DMROperationDefinition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 Red Hat, Inc. and/or its affiliates
+ * Copyright 2015-2016 Red Hat, Inc. and/or its affiliates
  * and other contributors as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,6 +18,7 @@
 
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.List;
 
 import org.jboss.as.controller.AttributeDefinition;
 import org.jboss.as.controller.PathElement;
@@ -44,4 +45,9 @@ private DMROperationDefinition() {
     public Collection<AttributeDefinition> getAttributes() {
         return Arrays.asList(DMROperationAttributes.ATTRIBUTES);
     }
+
+    @Override
+    protected List<? extends PersistentResourceDefinition> getChildren() {
+        return Arrays.asList(DMROperationParamDefinition.INSTANCE);
+    }
 }

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/DMROperationParamAdd.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2015-2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hawkular.agent.monitor.extension;
+
+import org.jboss.as.controller.AbstractAddStepHandler;
+
+public class DMROperationParamAdd extends AbstractAddStepHandler {
+
+    public static final DMROperationParamAdd INSTANCE = new DMROperationParamAdd();
+
+    private DMROperationParamAdd() {
+        super(DMROperationParamAttributes.ATTRIBUTES);
+    }
+}

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/DMROperationParamAttributes.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2015-2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hawkular.agent.monitor.extension;
+
+import org.jboss.as.controller.SimpleAttributeDefinition;
+import org.jboss.as.controller.SimpleAttributeDefinitionBuilder;
+import org.jboss.as.controller.registry.AttributeAccess;
+import org.jboss.dmr.ModelType;
+
+public interface DMROperationParamAttributes {
+
+
+    SimpleAttributeDefinition TYPE = new SimpleAttributeDefinitionBuilder("type",
+            ModelType.STRING)
+                    .setAllowNull(false)
+                    .setAllowExpression(true)
+                    .addFlag(AttributeAccess.Flag.RESTART_RESOURCE_SERVICES)
+                    .build();
+
+    SimpleAttributeDefinition DEFAULT_VALUE = new SimpleAttributeDefinitionBuilder("defaultValue",
+            ModelType.STRING)
+                    .setAllowNull(true)
+                    .setAllowExpression(true)
+                    .addFlag(AttributeAccess.Flag.RESTART_RESOURCE_SERVICES)
+                    .build();
+
+    SimpleAttributeDefinition DESCRIPTION = new SimpleAttributeDefinitionBuilder("description",
+            ModelType.STRING)
+                    .setAllowNull(true)
+                    .setAllowExpression(true)
+                    .addFlag(AttributeAccess.Flag.RESTART_RESOURCE_SERVICES)
+                    .build();
+
+    SimpleAttributeDefinition[] ATTRIBUTES = {
+            TYPE,
+            DEFAULT_VALUE,
+            DESCRIPTION
+    };
+}

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/DMROperationParamDefinition.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2015-2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hawkular.agent.monitor.extension;
+
+import java.util.Arrays;
+import java.util.Collection;
+
+import org.jboss.as.controller.AttributeDefinition;
+import org.jboss.as.controller.PathElement;
+import org.jboss.as.controller.PersistentResourceDefinition;
+import org.jboss.as.controller.registry.OperationEntry.Flag;
+
+public class DMROperationParamDefinition extends PersistentResourceDefinition {
+
+    public static final DMROperationParamDefinition INSTANCE = new DMROperationParamDefinition();
+
+    static final String PARAM = "param";
+
+    private DMROperationParamDefinition() {
+        super(PathElement.pathElement(PARAM),
+                SubsystemExtension.getResourceDescriptionResolver(DMRResourceTypeSetDefinition.RESOURCE_TYPE_SET,
+                        DMRResourceTypeDefinition.RESOURCE_TYPE, DMROperationDefinition.OPERATION, PARAM),
+                DMROperationParamAdd.INSTANCE,
+                DMROperationParamRemove.INSTANCE,
+                Flag.RESTART_RESOURCE_SERVICES,
+                Flag.RESTART_RESOURCE_SERVICES);
+    }
+
+
+    @Override
+    public Collection<AttributeDefinition> getAttributes() {
+        return Arrays.asList(DMROperationParamAttributes.ATTRIBUTES);
+    }
+}

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/DMROperationParamRemove.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2015-2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hawkular.agent.monitor.extension;
+
+import org.jboss.as.controller.AbstractRemoveStepHandler;
+
+public class DMROperationParamRemove extends AbstractRemoveStepHandler {
+
+    public static final DMROperationParamRemove INSTANCE = new DMROperationParamRemove();
+
+    private DMROperationParamRemove() {
+    }
+}

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/MonitorServiceConfigurationBuilder.java

@@ -50,6 +50,7 @@
 import org.hawkular.agent.monitor.inventory.NameSet;
 import org.hawkular.agent.monitor.inventory.NameSet.NameSetBuilder;
 import org.hawkular.agent.monitor.inventory.Operation;
+import org.hawkular.agent.monitor.inventory.OperationParam;
 import org.hawkular.agent.monitor.inventory.ResourceConfigurationPropertyType;
 import org.hawkular.agent.monitor.inventory.ResourceType;
 import org.hawkular.agent.monitor.inventory.ResourceType.Builder;
@@ -70,6 +71,7 @@
 import org.jboss.as.controller.SimpleAttributeDefinition;
 import org.jboss.as.controller.client.helpers.MeasurementUnit;
 import org.jboss.dmr.ModelNode;
+import org.jboss.dmr.ModelType;
 import org.jboss.dmr.Property;
 
 /**
@@ -439,7 +441,7 @@ private static void determineMetricSetPrometheus(ModelNode config,
 
     }
 
-    private static String determinePlatformMachineId(ModelNode config, OperationContext context)
+    private static String   determinePlatformMachineId(ModelNode config, OperationContext context)
             throws OperationFailedException {
 
         if (!config.hasDefined(PlatformDefinition.PLATFORM)) {
@@ -971,13 +973,16 @@ private static void determineResourceTypeSetDmr(ModelNode config,
                             List<Property> operationList = opModelNode.asPropertyList();
                             for (Property operationProperty : operationList) {
                                 ModelNode operationValueNode = operationProperty.getValue();
-                                String operationName = operationProperty.getName();
+                                String name = operationProperty.getName();
+
+                                List<OperationParam> params = getOpParamListFromOpNode(operationValueNode);
 
                                 PathAddress pathAddress = getPath(operationValueNode, context,
                                         DMROperationAttributes.PATH);
-                                Operation<DMRNodeLocation> op = new Operation<>(ID.NULL_ID, new Name(operationName),
+                                String operationName = getString(operationValueNode, context, DMROperationAttributes.OPERATION_NAME);
+                                Operation<DMRNodeLocation> op = new Operation<>(ID.NULL_ID, new Name(name),
                                         new DMRNodeLocation(pathAddress),
-                                        getString(operationValueNode, context, DMROperationAttributes.OPERATION_NAME));
+                                        operationName, params);
                                 resourceTypeBuilder.operation(op);
                             }
                         }
@@ -1090,7 +1095,7 @@ private static void determineResourceTypeSetJmx(ModelNode config,
                                             new JMXNodeLocation(getObjectName(operationValueNode, context,
                                                     JMXOperationAttributes.OBJECT_NAME)),
                                             getString(operationValueNode, context,
-                                                    JMXOperationAttributes.OPERATION_NAME));
+                                                    JMXOperationAttributes.OPERATION_NAME),null);
                                     resourceTypeBuilder.operation(op);
                                 }
                             }
@@ -1377,6 +1382,33 @@ private static List<Name> getNameListFromString(ModelNode modelNode, OperationCo
         }
     }
 
+    private static List<OperationParam> getOpParamListFromOpNode(ModelNode modelNode) throws OperationFailedException {
+
+        List<OperationParam> ret = new ArrayList<>();
+
+        ModelNode params = modelNode.get("param");
+        if (params.getType()==ModelType.UNDEFINED) {
+            return Collections.emptyList();
+        }
+        List<Property> ps = params.asPropertyList();
+        for (Property prop : ps) {
+            String name = prop.getName();
+            ModelNode m = prop.getValue();
+            String typ = m.get("type").asString();
+            String desc = m.get("description").asString();
+
+            OperationParam operationParam = new OperationParam(name,typ,desc);
+
+            ModelNode defaultValue = m.get("defaultValue");
+            if (defaultValue.getType()!= ModelType.UNDEFINED) {
+                String defVal = defaultValue.asString();
+                operationParam.setDefaultvalue(defVal);
+            }
+            ret.add(operationParam);
+        }
+        return ret;
+    }
+
     private static Map<String, String> getMapFromString(ModelNode modelNode, OperationContext context,
             SimpleAttributeDefinition attrib) throws OperationFailedException {
         ModelNode value = attrib.resolveModelAttribute(context, modelNode);

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/extension/SubsystemParser.java

@@ -83,6 +83,10 @@ public class SubsystemParser implements XMLStreamConstants, XMLElementReader<Lis
                                             .addChild(builder(DMROperationDefinition.INSTANCE)
                                                     .setXmlElementName(DMROperationDefinition.OPERATION)
                                                     .addAttributes(DMROperationAttributes.ATTRIBUTES)
+                                                    .addChild(builder(DMROperationParamDefinition.INSTANCE)
+                                                            .setXmlElementName(DMROperationParamDefinition.PARAM)
+                                                            .addAttributes(DMROperationParamAttributes.ATTRIBUTES)
+                                                    )
                                             )
                                     )
                             )

hawkular-wildfly-agent/src/main/java/org/hawkular/agent/monitor/inventory/Operation.java

@@ -16,6 +16,8 @@
  */
 package org.hawkular.agent.monitor.inventory;
 
+import java.util.List;
+
 /**
  * Defines an operation that can be executed on the managed resource.
  *
@@ -46,10 +48,15 @@ public final class Operation<L> extends NodeLocationProvider<L> {
      * @param operationName the actual name of the operation as it is known to the actual resource being managed.
      *                      This is the name that is used when telling the managed resource what operation to invoke.
      *                      It may or may not be the same as <code>name</code>.
+     * @param params Additional params for this operation definition, e.g. coming from dmr describe-operation.
+     *                   Can be null.
      */
-    public Operation(ID id, Name name, L location, String operationName) {
+    public Operation(ID id, Name name, L location, String operationName, List<OperationParam> params) {
         super(id, name, location);
         this.operationName = operationName;
+        if (params!=null && !params.isEmpty()) {
+            addProperty("params", params);
+        }
     }
 
     /**