com.ibm.commerce.context.content.events

Class ContentEventFactory

  • java.lang.Object
    • com.ibm.commerce.context.content.events.ContentEventFactory

  • public class ContentEventFactory
extends java.lang.Object
    This class defines a factory to create a content context event.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void begin(java.lang.String workspaceName)
      This method generates a begin workspace content event.
      void begin(java.lang.String workspaceName, java.lang.String lockingPolicy)
      This method generates a begin workspace content event.
      void commit(ContentData data)
      This method generates a commit content event.
      void end(ContentData data)
      This method generates an content context event to end and cleanup of all runtime task groups.
      void end(java.lang.String workspaceName)
      This method generates a cancel workspace content context event.
      static ContentEventFactory getInstance()
      This is a static constructor for this class.
      void postPublish(ContentData data)
      This method generates a post-publish content event.
      void publish(ContentData data)
      This method generates a publish content event.
      void release(ContentData data)
      This method generates a release content event.
      void resynchronizeAllWorkspaces()
      This method indicates that data in the base schema has changed and that all workspaces need to be resynchronized.
      void resynchronizeWorkspace(java.lang.String workspaceName)
      This method allows the data in a particular workspace to be resynchronized.
      void rollback(ContentData data)
      This method generates a rollback content event.
      void synchronize(ContentData data)
      This method generates a synchronize workspace content context event.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Method Detail

      • getInstance

        public static ContentEventFactory getInstance()
        This is a static constructor for this class. IT returns a singleton instance of a content context factory.
        Returns:
        An instance of a content context factory.

      • begin

        public void begin(java.lang.String workspaceName)
           throws ECException
        This method generates a begin workspace content event.
        Parameters:
        workspaceName - The workspace name.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • begin

        public void begin(java.lang.String workspaceName,
                  java.lang.String lockingPolicy)
           throws ECException
        This method generates a begin workspace content event. The workspace will have the associated locking policy to be used for locking checks.
        Parameters:
        workspaceName - The workspace name.
        lockingPolicy - The locking policy.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • commit

        public void commit(ContentData data)
            throws ECException
        This method generates a commit content event.
        Parameters:
        data - The content data contain workspace and task group info.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • rollback

        public void rollback(ContentData data)
              throws ECException
        This method generates a rollback content event.
        Parameters:
        data - The content data contain workspace and task group info.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • release

        public void release(ContentData data)
             throws ECException
        This method generates a release content event.
        Parameters:
        data - The content data contain workspace and task group info.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • publish

        public void publish(ContentData data)
             throws ECException
        This method generates a publish content event.
        Parameters:
        data - The content data contain workspace and task group info.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • postPublish

        public void postPublish(ContentData data)
                 throws ECException
        This method generates a post-publish content event.
        Parameters:
        data - The content data contain workspace and task group info.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • end

        public void end(java.lang.String workspaceName)
         throws ECException
        This method generates a cancel workspace content context event.
        Parameters:
        workspaceName - The workspace name.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • end

        public void end(ContentData data)
         throws ECException
        This method generates an content context event to end and cleanup of all runtime task groups. Within the content data the workspace information is nullable. The resources for the workspace may have already been removed through a separate end() event for just the workspace.
        Parameters:
        data - The content data contain workspace and task group info.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • synchronize

        public void synchronize(ContentData data)
                 throws ECException
        This method generates a synchronize workspace content context event.
        Parameters:
        data - The ContentData containing workspace and task group identifiers.
        Throws:
        ECException - This can be thrown by the listener when the event is handled.

      • resynchronizeWorkspace

        public void resynchronizeWorkspace(java.lang.String workspaceName)
                            throws ECException
        This method allows the data in a particular workspace to be resynchronized. This can either be a result of a base change or a workspace change. In the case where the base necessitates a resynchronization, workspaces will be marked to indicated that resynchronization is required.
        Parameters:
        workspaceName - The workspace that caused the change. If the change is because of a change in the base then workspaceName will be null.
        Throws:
        ECException - This is thrown if there is a problem with the SQL/ used to mark the workspaces or a problem obtaining the database connection to do so.

      • resynchronizeAllWorkspaces

        public void resynchronizeAllWorkspaces()
                                throws ECException
        This method indicates that data in the base schema has changed and that all workspaces need to be resynchronized.
        Throws:
        ECException - This is thrown if there is a problem with the SQL used to mark the workspaces or a problem obtaining the database connection to do so.
Skip navigation links