com.ibm.commerce.context.content.resources

Interface ResourceContainer

    • Method Detail

      • initialize

        void initialize()
                 throws java.lang.Exception
        This method initializes the container.
        Throws:
        java.lang.Exception - This is thrown if there is a problem reading, configuration or accessing a database when initializing the container.
      • commit

        void commit(ContentData contentData)
             throws ResourceException
        This method commits the changes in the workspace to the base schema.
        Parameters:
        contentData - The content data to commit.
        Throws:
        ResourceUpdateException - This is thrown if there is a problem performing the commit operation. This usually occurs when the commit causes data integrity problems.
        ResourceException
      • synchronize

        void synchronize(ContentData contentData)
                  throws ResourceException
        This method synchronizes the specified workspace. The workspace may need to be synchronized based on some changes either in the base schema or in the workspace itself. This method will be called when it is known that changes have been made which may have caused the workspace to be out of synchronization.
        Parameters:
        contentData - The content data to synchronize. This data will not include the task and task group because the entire workspace needs to be synchronized.
        Throws:
        ResourceException - This is thrown if there is a problem performing the synchronize operation. This usually occurs when the commit causes data integrity problems.
      • publish

        void publish(ContentData contentData,
                     ContentPublisher publisher)
              throws ResourceException
        This method publishes a task group.
        Parameters:
        contentData - The content data to publish.
        publisher - The quick publisher.
        Throws:
        ResourceException - This is thrown if there is a problem publishing a task group.
      • postPublish

        void postPublish(ContentData contentData)
                  throws ResourceException
        This method processes a post-publish event. The default implementation is to compose post-publish data and propagate the data to production server.
        Parameters:
        contentData - The content data.
        Throws:
        ResourceException - This is thrown if a problem occurs in the post-publish event processing.
      • rollback

        void rollback(ContentData contentData)
               throws ResourceException
        This method rolls back the workspace by undoing all changes.
        Parameters:
        contentData - The content data to commit.
        Throws:
        ResourceUpdateException - This is thrown if there is a problem performing the rollback.
        ResourceException
      • getResourceManager

        ResourceManager getResourceManager(java.lang.String resourceName)
        This method returns the resource manager for the specified resource.
        Parameters:
        resourceName - The name of the resource.
        Returns:
        The resource manager for the specified resource name.
      • getResourceManagers

        java.util.Map getResourceManagers()
        This method returns the map of resource managers belonging to the container and the name of the resource they represent.
        Returns:
        A list of resource managers.
      • setMetaData

        void setMetaData(ResourceContainerMetaData resourceContainerMetaData)
        This method sets the metadata associated with the container.
        Parameters:
        resourceContainerMetaData - The resource container metadata.
      • getMetaData

        ResourceContainerMetaData getMetaData()
        This method returns the metadata associated with the container.
        Returns:
        The container metadata.