/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, 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.parsing;
import java.util.List;
import java.util.function.Supplier;
import org.jboss.as.controller.ProcessType;
import org.jboss.as.controller.RunningMode;
import org.jboss.dmr.ModelNode;
import org.jboss.staxmapper.XMLElementReader;
/**
* Context in effect when the {@code extension} element for a given {@link org.jboss.as.controller.Extension} is being parsed. Allows the
* extension to {@link org.jboss.as.controller.Extension#initializeParsers(ExtensionParsingContext) initialize the XML parsers} that can
* be used for parsing the {@code subsystem} elements that contain the configuration for its subsystems.
*
* @author <a href="mailto:david.lloyd@redhat.com">David M. Lloyd</a>
*/
public interface ExtensionParsingContext {
/**
* Gets the type of the current process.
* @return the current process type. Will not be {@code null}
*/
ProcessType getProcessType();
/**
* Gets the current running mode of the process.
* @return the current running mode. Will not be {@code null}
*/
RunningMode getRunningMode();
/**
* Set the parser for the profile-wide subsystem configuration XML element. The element is always
* called {@code "subsystem"}. The reader should populate the given model node with the appropriate
* "subsystem add" update, without the address or operation name as that information will be automatically
* populated.
*
* @param subsystemName the name of the subsystem. Cannot be {@code null}
* @param namespaceUri the URI of the sussystem's XML namespace, in string form. Cannot be {@code null}
* @param reader the element reader. Cannot be {@code null}
*
* @throws IllegalStateException if another {@link org.jboss.as.controller.Extension} has already registered a subsystem with the given
* {@code subsystemName}
*/
void setSubsystemXmlMapping(String subsystemName, String namespaceUri, XMLElementReader<List<ModelNode>> reader);
/**
* Set the parser for the profile-wide subsystem configuration XML element. The element is always
* called {@code "subsystem"}. The reader should populate the given model node with the appropriate
* "subsystem add" update, without the address or operation name as that information will be automatically
* populated.
* It is recommended that supplier always creates new instance of the {@link XMLElementReader}
* instead of caching and returning always same instance.
*
* @param subsystemName the name of the subsystem. Cannot be {@code null}
* @param namespaceUri the URI of the sussystem's XML namespace, in string form. Cannot be {@code null}
* @param supplier of the element reader. Cannot be {@code null}
*
* @throws IllegalStateException if another {@link org.jboss.as.controller.Extension} has already registered a subsystem with the given
* {@code subsystemName}
*/
void setSubsystemXmlMapping(String subsystemName, String namespaceUri, Supplier<XMLElementReader<List<ModelNode>>> supplier);
/**
* Registers a {@link ProfileParsingCompletionHandler} to receive a callback upon completion of parsing of a
* profile.
*
* @param handler the handler. Cannot be {@code null}
*/
void setProfileParsingCompletionHandler(ProfileParsingCompletionHandler handler);
}