<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<body link="#355491" alink="#4262a1" vlink="#355491" style="background: #e2e2e2; margin: 0; padding: 20px;">
<div>
<table cellpadding="0" bgcolor="#FFFFFF" border="0" cellspacing="0" style="border: 1px solid #dadada; margin-bottom: 30px; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td>
<table border="0" cellpadding="0" cellspacing="0" bgcolor="#FFFFFF" style="border: solid 2px #ccc; background: #dadada; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td bgcolor="#000000" valign="middle" height="58px" style="border-bottom: 1px solid #ccc; padding: 20px; -moz-border-radius-topleft: 3px; -moz-border-radius-topright: 3px; -webkit-border-top-right-radius: 5px; -webkit-border-top-left-radius: 5px;">
<h1 style="color: #333333; font: bold 22px Arial, Helvetica, sans-serif; margin: 0; display: block !important;">
<!-- To have a header image/logo replace the name below with your img tag -->
<!-- Email clients will render the images when the message is read so any image -->
<!-- must be made available on a public server, so that all recipients can load the image. -->
<a href="https://community.jboss.org/index.jspa" style="text-decoration: none; color: #E1E1E1">JBoss Community</a></h1>
</td>
</tr>
<tr>
<td bgcolor="#FFFFFF" style="font: normal 12px Arial, Helvetica, sans-serif; color:#333333; padding: 20px; -moz-border-radius-bottomleft: 4px; -moz-border-radius-bottomright: 4px; -webkit-border-bottom-right-radius: 5px; -webkit-border-bottom-left-radius: 5px;"><h3 style="margin: 10px 0 5px; font-size: 17px; font-weight: normal;">
CLICompoundValueFormat
</h3>
<span style="margin-bottom: 10px;">
created by <a href="https://community.jboss.org/people/aloubyansky">Alexey Loubyansky</a> in <i>JBoss AS 7 Development</i> - <a href="https://community.jboss.org/docs/DOC-17944">View the full document</a>
</span>
<hr style="margin: 20px 0; border: none; background-color: #dadada; height: 1px;">
<div class="jive-rendered-content"><h2>Compound Operation Parameter (or Command Argument) Value Format</h2><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Operation parameters of simple types (such as integer, boolean, string, etc) are easily expressed with a string (i.e. a word) value. Others (such as lists, properties, objects, etc) require a special syntax.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>These compound values can expressed in two formats. The first and the original one is the native DMR (Dynamic Model Representation) format. All the CLI operations and commands are translated into the DMR requests using <em>org.jboss.dmr.ModelNode</em> API. <em>org.jboss.dmr.ModelNode</em> has <em>toString()</em> and <em>fromString(str)</em> methods that output and read string representations of the DMR nodes in its specific format.</p><p>You can see examples of values in this format in <a class="" href="https://community.jboss.org/docs/DOC-16336">the Format of a Detyped Operation Request</a> and <a class="" href="https://community.jboss.org/docs/DOC-16354">the Format of a Detyped Operation Response</a> articles or simply construct your own instances of <em>org.jboss.dmr.ModelNode</em> and call <em>toString()</em> on them.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>As you, probably, know, the DMR format is very verbose and not easy to type complex values in w/o making mistakes. This is why the CLI supports a simplified version of the format. Basically, it doesn't require quotes around the values and accepts '=' instead of '=>'.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Here are a few examples (the examples show only the operation of command parameters w/o the rest of the operations, i.e. the address part and operation name.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Simple string value:</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_name=value</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>A list (the two versions are equivalent):</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_name=a,b,c</em></p><p><em>param_name=[a,b,c]</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Nested lists:</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_name=[a,b,[c,d]]</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>A list of properties:</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_name=[a=b,c=d]</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Values of type OBJECT (the two versions are equivalent):</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_name=a=b,c=d</em></p><p><em>param_name={a=b,c=d}</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Object with a property of type list:</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_name=a=b,c=[d,e]</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Object with a child of type object:</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_name=a=b,c={d=e}</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Object with a complex property list:</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><em>param_list=a=b,c=[d=e,f={g=h}]</em></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>These are, of course, simple but, hopefully, sufficient examples to give an idea of the compound value format.</p></div>
<div style="background-color: #f4f4f4; padding: 10px; margin-top: 20px;">
<p style="margin: 0;">Comment by <a href="https://community.jboss.org/docs/DOC-17944">going to Community</a></p>
<p style="margin: 0;">Create a new document in JBoss AS 7 Development at <a href="https://community.jboss.org/choose-container!input.jspa?contentType=102&containerType=14&container=2225">Community</a></p>
</div></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>