Package org.wildfly.subsystem

Interface SubsystemPersistence<S extends org.jboss.as.controller.SubsystemSchema<S>>

Type Parameters:
S - the schema type
public interface SubsystemPersistence<S extends org.jboss.as.controller.SubsystemSchema<S>>
Encapsulates the persistence configuration of a subsystem.
Author:
Paul Ferraro

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>>
    getReader(S schema)
    Returns the appropriate StAX reader for the version of the specified schema that parses subsystem XML into a set of management operations.
    Set<S>
    getSchemas()
    Returns the supported schemas of this subsystem.
    org.jboss.staxmapper.XMLElementWriter<org.jboss.as.controller.persistence.SubsystemMarshallingContext>
    getWriter(org.jboss.as.version.Stability stability)
    Returns a StAX writer that writes the subsystem model to XML according to the current schema version for the specified stability level.
    static <S extends Enum<S> & org.jboss.as.controller.SubsystemSchema<S>>
    SubsystemPersistence<S>
    of(Map<S,org.jboss.staxmapper.XMLElementWriter<org.jboss.as.controller.persistence.SubsystemMarshallingContext>> currentWriters)
    Creates the subsystem persistence configuration for the specified writers for current versions of the schema.
    static <S extends Enum<S> & org.jboss.as.controller.persistence.xml.SubsystemResourceXMLSchema<S>>
    SubsystemPersistence<S>
    of(Set<S> currentSchemas)
    Creates the subsystem persistence configuration for the current versions of the schema.
    static <S extends Enum<S> & org.jboss.as.controller.persistence.xml.SubsystemResourceXMLSchema<S>>
    SubsystemPersistence<S>
    of(S currentSchema)
    Creates the subsystem persistence configuration for the current version of the schema.
    static <S extends Enum<S> & org.jboss.as.controller.SubsystemSchema<S>>
    SubsystemPersistence<S>
    of(S currentSchema, org.jboss.staxmapper.XMLElementWriter<org.jboss.as.controller.persistence.SubsystemMarshallingContext> writer)
    Creates the subsystem persistence configuration for the current version of the schema and specified writer

  • Method Details

    • getSchemas

      Set<S> getSchemas()
      Returns the supported schemas of this subsystem.
      Returns:
      a set of schemas

    • getReader

      default org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> getReader(S schema)
      Returns the appropriate StAX reader for the version of the specified schema that parses subsystem XML into a set of management operations.
      Returns:
      a StAX reader for the version of the specified schema

    • getWriter

      org.jboss.staxmapper.XMLElementWriter<org.jboss.as.controller.persistence.SubsystemMarshallingContext> getWriter(org.jboss.as.version.Stability stability)
      Returns a StAX writer that writes the subsystem model to XML according to the current schema version for the specified stability level.
      Parameters:
      stability - the stability level of the process
      Returns:
      a StAX writer

    • of

      static <S extends Enum<S> & org.jboss.as.controller.persistence.xml.SubsystemResourceXMLSchema<S>> SubsystemPersistence<S> of(S currentSchema)
      Creates the subsystem persistence configuration for the current version of the schema.
      Type Parameters:
      S - the schema type
      Parameters:
      currentSchema - the current schema version
      Returns:
      a subsystem persistence configuration

    • of

      static <S extends Enum<S> & org.jboss.as.controller.persistence.xml.SubsystemResourceXMLSchema<S>> SubsystemPersistence<S> of(Set<S> currentSchemas)
      Creates the subsystem persistence configuration for the current versions of the schema.
      Type Parameters:
      S - the schema type
      Parameters:
      currentSchemas - the current schema versions
      Returns:
      a subsystem persistence configuration

    • of

      static <S extends Enum<S> & org.jboss.as.controller.SubsystemSchema<S>> SubsystemPersistence<S> of(S currentSchema, org.jboss.staxmapper.XMLElementWriter<org.jboss.as.controller.persistence.SubsystemMarshallingContext> writer)
      Creates the subsystem persistence configuration for the current version of the schema and specified writer
      Type Parameters:
      S - the schema type
      Parameters:
      currentSchema - the current schema version
      Returns:
      a subsystem persistence configuration

    • of

      static <S extends Enum<S> & org.jboss.as.controller.SubsystemSchema<S>> SubsystemPersistence<S> of(Map<S,org.jboss.staxmapper.XMLElementWriter<org.jboss.as.controller.persistence.SubsystemMarshallingContext>> currentWriters)
      Creates the subsystem persistence configuration for the specified writers for current versions of the schema.
      Type Parameters:
      S - the schema type
      Parameters:
      currentWirter - the schema writer per current schema version
      Returns:
      a subsystem persistence configuration