com.ibm.commerce.filepublish.util

Class ContentManagedFileEARUpdateImpl

  • java.lang.Object
    • com.ibm.commerce.filepublish.util.ContentManagedFileEARUpdateImpl
  • All Implemented Interfaces:
    ContentManagedFileEARUpdate

    public class ContentManagedFileEARUpdateImpl
extends java.lang.Object
implements ContentManagedFileEARUpdate
    Implementation for ContentManagedFileEARUpdate.
    Behavior:
    ContentManagedFileEARUpdate retrieves predefined criteria from the instance configuration XML, evaluates them and then decides if an update to the Commerce EAR is needed. If such an action is required, it will retrieve a list of content managed files for update. And then the 
    EAR Updater
    will use these content managed files to update and commit them into the Commerce EAR. At the end of the operation the list of content managed files will be updated. This will indicate that these files have been committed to the Commerce EAR.
    Helpers and Utilities:
    • IEARUpdater
    • ContentManagedFileHandler
    • ContentManagedFile
    • UpdateContentManagedFileInEARUtil

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLASSNAME
      Define the CLASSNAME.
      static java.lang.String COPYRIGHT
      The internal copyright field.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void update()
      Call update(null, true, false).
      void update(java.lang.String astrProductionServerApplicationName, boolean aboolUpdateCurrentEAR, boolean aboolImmediateUpdate)
      Determine if content managed files need to be updated to the Commerce EAR.

      • 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
        The internal copyright field.
        See Also:
        Constant Field Values

      • CLASSNAME

        public static final java.lang.String CLASSNAME
        Define the CLASSNAME.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ContentManagedFileEARUpdateImpl

        public ContentManagedFileEARUpdateImpl()
                                throws ECException
        Default constructor for the ContentManagedFileEARUpdateImpl. The following are set with the default constructor:
        • no production server application
        • current EAR will be updated
        • update action in not immediate
        Throws:
        ECException - Any exception captured.

    • Method Detail

      • update

        public void update()
            throws ECException
        Call update(null, true, false). This will set the following parameters:
        • the product server application name to null;
        • the option to update the current EAR to true; and
        • the option to update immediately to false.

        By setting the application name to null implies that the EAR update will not be applicable to the production server.
        By setting the option to update current EAR to true implies that the current EAR will be updated.
        By setting the option to update immediately to false implies that it will try to update the EAR without first going through the evaluation.
        Specified by:
        update in interface ContentManagedFileEARUpdate
        Throws:
        ECException - Any exception captured. Possible exceptions include error in obtaining evaluation criteria or error in evaluating the criteria. Problems in updating the Commerce EAR may also cause exception.

      • update

        public void update(java.lang.String astrProductionServerApplicationName,
                   boolean aboolUpdateCurrentEAR,
                   boolean aboolImmediateUpdate)
            throws ECException
        Determine if content managed files need to be updated to the Commerce EAR. If the option to update immediate is set to false, then it will evaluate if an update to the EAR is necessary. If an update is necessary, it will update the content managed files to the Commerce EAR.
        If the option to update immediately is set to true, then it will immediately update the content managed files to the Commerce EAR. It will not go through the evaluation process.
        If the production server application name is set, then the Commerce EAR update will also be applicable to the production server as well.
        The option to update current EAR is used to determine if the current EAR should be updated.
        Specified by:
        update in interface ContentManagedFileEARUpdate
        Parameters:
        astrProductionServerApplicationName - The application name in the production server
        aboolUpdateCurrentEAR - The option to update the current EAR
        aboolImmediateUpdate - The option to update immediately
        Throws:
        ECException - Any exception captured. Possible exceptions include error in obtaining evaluation criteria or error in evaluating the criteria. Problems in updating the Commerce EAR may also cause exception.
Skip navigation links