Class Migration

java.lang.Object
org.apache.tomcat.jakartaee.Migration

public class Migration extends Object
The main class for the Migration tool.
  • Field Details

    • logger

      private static final Logger logger
    • sm

      private static final StringManager sm
    • DEFAULT_EXCLUDES

      private static final Set<String> DEFAULT_EXCLUDES
    • EXTRA_FIELD_ZIP64

      private static final org.apache.commons.compress.archivers.zip.ZipShort EXTRA_FIELD_ZIP64
    • ZIP64_THRESHOLD_LENGTH

      private static final long ZIP64_THRESHOLD_LENGTH
      See Also:
    • profile

      private EESpecProfile profile
    • enableDefaultExcludes

      private boolean enableDefaultExcludes
    • matchExcludesAgainstPathName

      private boolean matchExcludesAgainstPathName
    • zipInMemory

      private boolean zipInMemory
    • converted

      private boolean converted
    • state

      private Migration.State state
    • source

      private File source
    • destination

      private File destination
    • converters

      private final List<Converter> converters
    • excludes

      private final Set<String> excludes
  • Constructor Details

    • Migration

      public Migration()
      Construct a new migration tool instance.
  • Method Details

    • setEESpecProfile

      public void setEESpecProfile(EESpecProfile profile)
      Set the Jakarta EE specifications that should be used.
      Parameters:
      profile - the Jakarta EE specification profile
    • getEESpecProfile

      public EESpecProfile getEESpecProfile()
      Get the Jakarta EE profile being used.
      Returns:
      the profile
    • setEnableDefaultExcludes

      public void setEnableDefaultExcludes(boolean enableDefaultExcludes)
      Enable the default exclusion list for the tool.
      Parameters:
      enableDefaultExcludes - true to enable the default
    • setMatchExcludesAgainstPathName

      public void setMatchExcludesAgainstPathName(boolean matchExcludesAgainstPathName)
      Enable exclude matching against the path name.
      Parameters:
      matchExcludesAgainstPathName - true to match excludes against the path name instead of the file name
    • setZipInMemory

      public void setZipInMemory(boolean zipInMemory)
      Buffer all conversion operations for compressed archives in memory.
      Parameters:
      zipInMemory - true to buffer in memory
    • addExclude

      public void addExclude(String exclude)
      Add specified resource exclusion.
      Parameters:
      exclude - the exclude to add
    • setSource

      public void setSource(File source)
      Set source file.
      Parameters:
      source - the source file
    • setDestination

      public void setDestination(File destination)
      Set destination file.
      Parameters:
      destination - the destination file
    • hasConverted

      public boolean hasConverted()
      NOTE: this method is not to indicate that no changes were made, but that the source can be used and satisfy the selected profile.
      Returns:
      true if converted occurs
    • execute

      public void execute() throws IOException
      Execute migration operation.
      Throws:
      IOException - when an exception occurs
    • migrateDirectory

      private void migrateDirectory(File src, File dest) throws IOException
      Throws:
      IOException
    • migrateFile

      private void migrateFile(File src, File dest) throws IOException
      Throws:
      IOException
    • migrateArchiveStreaming

      private void migrateArchiveStreaming(InputStream src, OutputStream dest) throws IOException
      Throws:
      IOException
    • migrateArchiveInMemory

      private void migrateArchiveInMemory(InputStream src, OutputStream dest) throws IOException
      Throws:
      IOException
    • isSignatureFile

      private boolean isSignatureFile(String sourceName)
    • migrateStream

      private void migrateStream(String name, InputStream src, OutputStream dest) throws IOException
      Throws:
      IOException
    • isArchive

      private boolean isArchive(String fileName)
    • isExcluded

      private boolean isExcluded(String name)