Interface MembershipSchemaProvider

  • All Implemented Interfaces:

    
    public interface MembershipSchemaProvider
    
                        

    Provide the membership schema files to client's code ensuring that the load works under OSGi and non-OSGi.

    All provided InputStream objects should be closed by the client.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract InputStream getSchema(@NotNull() MembershipSchema schema, @NotNull() Version version) Retrieve the schema file for a membership schema.
      abstract InputStream getSchemaFile(@NotNull() String fileName) Retrieve a schema file with the given path.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getSchema

        @NotNull() abstract InputStream getSchema(@NotNull() MembershipSchema schema, @NotNull() Version version)

        Retrieve the schema file for a membership schema.

        NOTE: This does not resolve $ref fields in the schema file.

        Parameters:
        schema - The membership schema to retrieve.
        version - The version of the membership schema to retrieve.
      • getSchemaFile

        @NotNull() abstract InputStream getSchemaFile(@NotNull() String fileName)

        Retrieve a schema file with the given path.

        NOTE: This can be used to retrieve files required to resolve $ref fields in the schema.

        Parameters:
        fileName - The file to retrieve.