Package org.apache.sling.jcr.base

Class NodeTypeLoader

  • public class NodeTypeLoader
extends java.lang.Object
    The NodeTypeSupport contains utility methods to register node types from a CND nodetype definition file given as an URL or InputStream with the repository.

    • Constructor Summary

      Constructors 
      Constructor Description
      NodeTypeLoader()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean registerNodeType​(Session session, java.io.InputStream source)
      Registers node types from the CND file read from the source with the node type manager available from the given session.
      static boolean registerNodeType​(Session session, java.lang.String systemId, java.io.Reader reader, boolean reregisterExisting)  
      static boolean registerNodeType​(Session session, java.net.URL source)
      Registers node types from the CND file accessible by the URL with the node type manager available from the given session.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • NodeTypeLoader

        public NodeTypeLoader()

    • Method Detail

      • registerNodeType

        public static boolean registerNodeType​(Session session,
                                       java.net.URL source)
        Registers node types from the CND file accessible by the URL with the node type manager available from the given session.

        The NodeTypeManager returned by the session's workspace is expected to be of type org.apache.jackrabbit.api.JackrabbitNodeTypeManager for the node type registration to succeed.

        This method is not synchronized. It is up to the calling method to prevent paralell execution.

        Parameters:
        session - The Session providing the node type manager through which the node type is to be registered.
        source - The URL from which to read the CND file
        Returns:
        true if registration of all node types succeeded.

      • registerNodeType

        public static boolean registerNodeType​(Session session,
                                       java.io.InputStream source)
                                throws java.io.IOException,
                                       RepositoryException
        Registers node types from the CND file read from the source with the node type manager available from the given session.

        The NodeTypeManager returned by the session's workspace is expected to be of type org.apache.jackrabbit.api.JackrabbitNodeTypeManager for the node type registration to succeed.

        This method is not synchronized. It is up to the calling method to prevent paralell execution.

        Parameters:
        session - The Session providing the node type manager through which the node type is to be registered.
        source - The InputStream from which the CND file is read.
        Returns:
        true if registration of all node types succeeded.
        Throws:
        java.io.IOException - if there is an error parsing the input stream
        RepositoryException - if another error occurs

      • registerNodeType

        public static boolean registerNodeType​(Session session,
                                       java.lang.String systemId,
                                       java.io.Reader reader,
                                       boolean reregisterExisting)
                                throws java.io.IOException,
                                       RepositoryException
        Throws:
        java.io.IOException
        RepositoryException