Package org.jboss.as.domain.management.parsing

Interface ManagementXmlDelegate

  • public interface ManagementXmlDelegate
    The management element within the configurations has different constraints applied depending on whether it is for a standalone server or a host or domain, the different parsers can provide an implementation of this interface to override the specific behaviour. This interface consists of default methods so an implementation of the interface needs to only implement the methods of interest. The general pattern for the parse methods is that they return a boolean to indicate if an element has been handled, if it has not been handled the default parsing can occur. If an element is not supported the method should be implemented to throw a XMLStreamException.
    Author:
    Darran Lofthouse

    • Method Detail

      • parseManagementInterfaces

        default boolean parseManagementInterfaces​(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                                          org.jboss.dmr.ModelNode address,
                                          List<org.jboss.dmr.ModelNode> operationsList)
                                   throws XMLStreamException
        Parse Element.MANAGEMENT_INTERFACES content.

        This default implementation throws UnsupportedOperationException; override to support.

        Parameters:
        reader - the xml reader
        address - the address of the parent resource for any added resources
        expectedNs - the expected namespace for any children
        operationsList - list to which any operations should be added
        Throws:
        XMLStreamException

      • parseAccessControl

        default boolean parseAccessControl​(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                                   org.jboss.dmr.ModelNode address,
                                   List<org.jboss.dmr.ModelNode> operationsList)
                            throws XMLStreamException
        Parse Element.ACCESS_CONTROL content.
        Parameters:
        reader - the xml reader
        address - the address of the parent resource for any added resources
        operationsList - list to which any operations should be added
        Throws:
        XMLStreamException

      • parseAuditLog

        default boolean parseAuditLog​(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                              org.jboss.dmr.ModelNode address,
                              List<org.jboss.dmr.ModelNode> list)
                       throws XMLStreamException
        Throws:
        XMLStreamException

      • writeNativeManagementProtocol

        default boolean writeNativeManagementProtocol​(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                                              org.jboss.dmr.ModelNode protocol)
                                       throws XMLStreamException
        Write the Element.NATIVE_INTERFACE element.

        This default implementation throws UnsupportedOperationException; override to support.

        Parameters:
        writer - the xml writer
        protocol - the interface configuration
        Throws:
        XMLStreamException

      • writeHttpManagementProtocol

        default boolean writeHttpManagementProtocol​(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                                            org.jboss.dmr.ModelNode protocol)
                                     throws XMLStreamException
        Write the Element.HTTP_INTERFACE element.

        This default implementation throws UnsupportedOperationException; override to support.

        Parameters:
        writer - the xml writer
        protocol - the interface configuration
        Throws:
        XMLStreamException

      • writeAccessControl

        default boolean writeAccessControl​(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                                   org.jboss.dmr.ModelNode accessAuthorization)
                            throws XMLStreamException
        Throws:
        XMLStreamException

      • writeAuditLog

        default boolean writeAuditLog​(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                              org.jboss.dmr.ModelNode auditLog)
                       throws XMLStreamException
        Throws:
        XMLStreamException