com.ibm.commerce.filepublish.util

Interface ContentManagedFileEARUpdate

  • All Known Implementing Classes:
    ContentManagedFileEARUpdateImpl


    public interface ContentManagedFileEARUpdate
    Interface for ContentManagedFileEARUpdate.
    The implementation for ContentManagedFileEARUpdate is defined in the instance configuration XML file in the ManagedFileUpdateEARConfiguration section.
    The purpose of ContentManagedFileEARUpdate is to decide and then update content managed files into the Commerce EAR.
    • Field Summary

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void update()
      Calls update(null, true, false).
      void update(java.lang.String astrProductionServerApplicationName, boolean boolUpdateCurrentEAR, boolean boolImmediateUpdate)
      Determine if content managed files need to be updated to the Commerce EAR.
    • Method Detail

      • update

        void update()
             throws ECException
        Calls 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 the current EAR 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.
        Throws:
        ECException - Any exception captured
      • update

        void update(java.lang.String astrProductionServerApplicationName,
                    boolean boolUpdateCurrentEAR,
                    boolean boolImmediateUpdate)
             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.
        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. Another possible error includes problem encountered when updating files into the Commerce EAR.