Package org.apache.maven.plugins.war.util

Interface WebappStructure.RegistrationCallback

  • Enclosing class:
    WebappStructure
    public static interface WebappStructure.RegistrationCallback
    Callback interface to handle events related to filepath registration in the webapp.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void alreadyRegistered​(java.lang.String ownerId, java.lang.String targetFilename)
      Called if the targetFilename for the specified ownerId has already been registered.
      void refused​(java.lang.String ownerId, java.lang.String targetFilename, java.lang.String actualOwnerId)
      Called if the registration of the targetFilename for the specified ownerId has been refused since the path already belongs to the actualOwnerId.
      void registered​(java.lang.String ownerId, java.lang.String targetFilename)
      Called if the targetFilename for the specified ownerId has been registered successfully.
      void superseded​(java.lang.String ownerId, java.lang.String targetFilename, java.lang.String deprecatedOwnerId)
      Called if the targetFilename for the specified ownerId has been registered successfully by superseding a deprecatedOwnerId, that is the previous owner of the file.
      void supersededUnknownOwner​(java.lang.String ownerId, java.lang.String targetFilename, java.lang.String unknownOwnerId)
      Called if the targetFilename for the specified ownerId has been registered successfully by superseding a unknownOwnerId, that is an owner that does not exist anymore in the current project.

    • Method Detail

      • registered

        void registered​(java.lang.String ownerId,
                java.lang.String targetFilename)
         throws java.io.IOException
        Called if the targetFilename for the specified ownerId has been registered successfully. This means that the targetFilename was unknown and has been registered successfully.
        Parameters:
        ownerId - the ownerId
        targetFilename - the relative path according to the root of the webapp
        Throws:
        java.io.IOException - if an error occurred while handling this event

      • alreadyRegistered

        void alreadyRegistered​(java.lang.String ownerId,
                       java.lang.String targetFilename)
                throws java.io.IOException
        Called if the targetFilename for the specified ownerId has already been registered. This means that the targetFilename was known and belongs to the specified owner.
        Parameters:
        ownerId - the ownerId
        targetFilename - the relative path according to the root of the webapp
        Throws:
        java.io.IOException - if an error occurred while handling this event

      • refused

        void refused​(java.lang.String ownerId,
             java.lang.String targetFilename,
             java.lang.String actualOwnerId)
      throws java.io.IOException

        Called if the registration of the targetFilename for the specified ownerId has been refused since the path already belongs to the actualOwnerId.

        This means that the targetFilename was known and does not belong to the specified owner.
        Parameters:
        ownerId - the ownerId
        targetFilename - the relative path according to the root of the webapp
        actualOwnerId - the actual owner
        Throws:
        java.io.IOException - if an error occurred while handling this event

      • superseded

        void superseded​(java.lang.String ownerId,
                java.lang.String targetFilename,
                java.lang.String deprecatedOwnerId)
         throws java.io.IOException
        Called if the targetFilename for the specified ownerId has been registered successfully by superseding a deprecatedOwnerId, that is the previous owner of the file. This means that the targetFilename was known but for another owner. This usually happens after a project's configuration change. As a result, the file has been registered successfully to the new owner.
        Parameters:
        ownerId - the ownerId
        targetFilename - the relative path according to the root of the webapp
        deprecatedOwnerId - the previous owner that does not exist anymore
        Throws:
        java.io.IOException - if an error occurred while handling this event

      • supersededUnknownOwner

        void supersededUnknownOwner​(java.lang.String ownerId,
                            java.lang.String targetFilename,
                            java.lang.String unknownOwnerId)
                     throws java.io.IOException
        Called if the targetFilename for the specified ownerId has been registered successfully by superseding a unknownOwnerId, that is an owner that does not exist anymore in the current project. This means that the targetFilename was known but for an owner that does not exist anymore. Hence the file has been registered successfully to the new owner.
        Parameters:
        ownerId - the ownerId
        targetFilename - the relative path according to the root of the webapp
        unknownOwnerId - the previous owner that does not exist anymore
        Throws:
        java.io.IOException - if an error occurred while handling this event