/jboss-as-7.1.1.Final/controller/src/main/java/org/jboss/as/controller/ExpressionResolver.java

 1/*
 2* JBoss, Home of Professional Open Source.
 3* Copyright 2011, Red Hat Middleware LLC, and individual contributors
 4* as indicated by the @author tags. See the copyright.txt file in the
 5* distribution for a full listing of individual contributors.
 6*
 7* This is free software; you can redistribute it and/or modify it
 8* under the terms of the GNU Lesser General Public License as
 9* published by the Free Software Foundation; either version 2.1 of
10* the License, or (at your option) any later version.
11*
12* This software is distributed in the hope that it will be useful,
13* but WITHOUT ANY WARRANTY; without even the implied warranty of
14* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15* Lesser General Public License for more details.
16*
17* You should have received a copy of the GNU Lesser General Public
18* License along with this software; if not, write to the Free
19* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21*/
22package org.jboss.as.controller;
23
24import org.jboss.dmr.ModelNode;
25import org.jboss.dmr.ModelType;
26
27/**
28 * Resolves {@link ModelType#EXPRESSION} expressions in a {@link ModelNode}.
29 *
30 * @author <a href="kabir.khan@jboss.com">Kabir Khan</a>
31 */
32public interface ExpressionResolver {
33
34    /**
35     * Resolves any expressions in the passed in ModelNode.
36     * Expressions may either represent system properties or vaulted date. For vaulted data the format is
37     * ${VAULT::vault_block::attribute_name::sharedKey}
38     *
39     * @param node the ModelNode containing expressions.
40     * @return a copy of the node with expressions resolved
41     *
42     * @throws OperationFailedException if there is a value of type {@link ModelType#EXPRESSION} in the node tree and
43     *            there is no system property or environment variable that matches the expression, or if a security
44     *            manager exists and its {@link SecurityManager#checkPermission checkPermission} method doesn't allow
45     *            access to the relevant system property or environment variable
46     */
47    ModelNode resolveExpressions(ModelNode node) throws OperationFailedException;
48
49    /** Default {@code ExpressionResolver} that simply calls {@link ModelNode#resolve()}. */
50    ExpressionResolver DEFAULT = new ExpressionResolverImpl();
51}