Modifier and Type	Class and Description
private static class	Migration.MigrationZipArchiveEntry
public static enum	Migration.State The tool state.

Field Summary

Modifier and Type	Field and Description
private boolean	converted
private final List<Converter>	converters
private static final Set<String>	DEFAULT_EXCLUDES
private File	destination
private boolean	enableDefaultExcludes
private final Set<String>	excludes
private static final ZipShort	EXTRA_FIELD_ZIP64
private static final Logger	logger
private boolean	matchExcludesAgainstPathName
private EESpecProfile	profile
private static final StringManager	sm
private File	source
private Migration.State	state
private static final long	ZIP64_THRESHOLD_LENGTH
private boolean	zipInMemory

Constructor Summary

Access	Constructor and Description
public	Migration() Construct a new migration tool instance.

Method Summary

Modifier and Type	Method and Description
public void	addExclude(String the exclude to add exclude) Add specified resource exclusion.
public void	execute() Execute migration operation.
public EESpecProfile	Returns: the profile getEESpecProfile() Get the Jakarta EE profile being used.
public boolean	Returns: true if converted occurs 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.
private boolean	isArchive(String fileName)
private boolean	isExcluded(String name)
private boolean	isSignatureFile(String sourceName)
private void	migrateArchiveInMemory(InputStream src, OutputStream dest)
private void	migrateArchiveStreaming(InputStream src, OutputStream dest)
private void	migrateDirectory(File src, File dest)
private void	migrateFile(File src, File dest)
private void	migrateStream(String name, InputStream src, OutputStream dest)
public void	setDestination(File the destination file destination) Set destination file.
public void	setEESpecProfile(EESpecProfile the Jakarta EE specification profile profile) Set the Jakarta EE specifications that should be used.
public void	setEnableDefaultExcludes(boolean true to enable the default enableDefaultExcludes) Enable the default exclusion list for the tool.
public void	setMatchExcludesAgainstPathName(boolean true to match excludes against the path name instead of the file name matchExcludesAgainstPathName) Enable exclude matching against the path name.
public void	setSource(File the source file source) Set source file.
public void	setZipInMemory(boolean true to buffer in memory zipInMemory) Buffer all conversion operations for compressed archives in memory.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

converted	back to summary
private boolean converted

converters	back to summary
private final List<Converter> converters

DEFAULT_EXCLUDES	back to summary
private static final Set<String> DEFAULT_EXCLUDES

destination	back to summary
private File destination

enableDefaultExcludes	back to summary
private boolean enableDefaultExcludes

excludes	back to summary
private final Set<String> excludes

EXTRA_FIELD_ZIP64	back to summary
private static final ZipShort EXTRA_FIELD_ZIP64

logger	back to summary
private static final Logger logger

matchExcludesAgainstPathName	back to summary
private boolean matchExcludesAgainstPathName

profile	back to summary
private EESpecProfile profile

sm	back to summary
private static final StringManager sm

source	back to summary
private File source

state	back to summary
private Migration.State state

ZIP64_THRESHOLD_LENGTH	back to summary
private static final long ZIP64_THRESHOLD_LENGTH

zipInMemory	back to summary
private boolean zipInMemory

Constructor Detail

Migration	back to summary
public Migration() Construct a new migration tool instance.

Method Detail

addExclude	back to summary
public void addExclude(String exclude) Add specified resource exclusion. Parameters exclude:String the exclude to add

addExclude

back to summary

public void addExclude(String exclude)

Add specified resource exclusion.

Parameters

exclude:String: the exclude to add

execute	back to summary
public void execute() throws IOException Execute migration operation. Exceptions IOException: when an exception occurs

execute

back to summary

public void execute() throws IOException

Execute migration operation.

Exceptions

IOException:: when an exception occurs

getEESpecProfile	back to summary
public EESpecProfile getEESpecProfile() Get the Jakarta EE profile being used. Returns:EESpecProfile the profile

getEESpecProfile

back to summary

public EESpecProfile getEESpecProfile()

Get the Jakarta EE profile being used.

Returns:EESpecProfile: the profile

hasConverted	back to summary
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:boolean true if converted occurs

hasConverted

back to summary

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:boolean: true if converted occurs

isArchive	back to summary
private boolean isArchive(String fileName)

isExcluded	back to summary
private boolean isExcluded(String name)

isSignatureFile	back to summary
private boolean isSignatureFile(String sourceName)

migrateArchiveInMemory	back to summary
private void migrateArchiveInMemory(InputStream src, OutputStream dest) throws IOException

migrateArchiveStreaming	back to summary
private void migrateArchiveStreaming(InputStream src, OutputStream dest) throws IOException

migrateDirectory	back to summary
private void migrateDirectory(File src, File dest) throws IOException

migrateFile	back to summary
private void migrateFile(File src, File dest) throws IOException

migrateStream	back to summary
private void migrateStream(String name, InputStream src, OutputStream dest) throws IOException

setDestination	back to summary
public void setDestination(File destination) Set destination file. Parameters destination:File the destination file

setDestination

back to summary

public void setDestination(File destination)

Set destination file.

Parameters

destination:File: the destination file

setEESpecProfile	back to summary
public void setEESpecProfile(EESpecProfile profile) Set the Jakarta EE specifications that should be used. Parameters profile:EESpecProfile the Jakarta EE specification profile

setEESpecProfile

back to summary

public void setEESpecProfile(EESpecProfile profile)

Set the Jakarta EE specifications that should be used.

Parameters

profile:EESpecProfile: the Jakarta EE specification profile

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

setEnableDefaultExcludes

back to summary

public void setEnableDefaultExcludes(boolean enableDefaultExcludes)

Enable the default exclusion list for the tool.

Parameters

enableDefaultExcludes:boolean: true to enable the default

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

setMatchExcludesAgainstPathName

back to summary

public void setMatchExcludesAgainstPathName(boolean matchExcludesAgainstPathName)

Enable exclude matching against the path name.

Parameters

matchExcludesAgainstPathName:boolean: true to match excludes against the path name instead of the file name

setSource	back to summary
public void setSource(File source) Set source file. Parameters source:File the source file

setSource

back to summary

public void setSource(File source)

Set source file.

Parameters

source:File: the source file

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

setZipInMemory

back to summary

public void setZipInMemory(boolean zipInMemory)

Buffer all conversion operations for compressed archives in memory.

Parameters

zipInMemory:boolean: true to buffer in memory

org.apache.tomcat.jakartaee back to summary

private Class Migration.MigrationZipArchiveEntry

Class Inheritance

extends ZipArchiveEntry

java.lang.Object
java.util.zip.ZipEntry
org.apache.commons.compress.archivers.zip.ZipArchiveEntry
org.apache.tomcat.jakartaee.Migration.MigrationZipArchiveEntry

Field Summary

Inherited from org.apache.commons.compress.archivers.zip.ZipArchiveEntry:: CRC_UNKNOWN PLATFORM_FAT PLATFORM_UNIX

Constructor Summary

Access	Constructor and Description
pack-priv	MigrationZipArchiveEntry(ZipArchiveEntry entry)

Method Summary

Modifier and Type	Method and Description
public void	setName(String the name to use name) Overrides org.apache.commons.compress.archivers.zip.ZipArchiveEntry.setName. Sets the name of the entry.

Inherited from org.apache.commons.compress.archivers.zip.ZipArchiveEntry:: addAsFirstExtraField addExtraField clone equals getAlignment getCentralDirectoryExtra getCommentSource getDataOffset getDiskNumberStart getExternalAttributes getExtraField getExtraFields getExtraFields getExtraFields getGeneralPurposeBit getInternalAttributes getLastModifiedDate getLocalFileDataExtra getLocalHeaderOffset getMethod getName getNameSource getPlatform getRawFlag getRawName getSize getTime getUnixMode getUnparseableExtraFieldData getVersionMadeBy getVersionRequired hashCode isDirectory isStreamContiguous isUnixSymlink removeExtraField removeUnparseableExtraFieldData setAlignment setCentralDirectoryExtra setCommentSource setCreationTime setDataOffset setDiskNumberStart setExternalAttributes setExtra setExtra setExtraFields setGeneralPurposeBit setInternalAttributes setLastAccessTime setLastModifiedTime setLocalHeaderOffset setMethod setName setNameSource setPlatform setRawFlag setSize setStreamContiguous setTime setTime setUnixMode setVersionMadeBy setVersionRequired

Constructor Detail

MigrationZipArchiveEntry	back to summary
pack-priv MigrationZipArchiveEntry(ZipArchiveEntry entry) throws ZipException

Method Detail

setName	back to summary
public void setName(String name) Overrides org.apache.commons.compress.archivers.zip.ZipArchiveEntry.setName. Doc from org.apache.commons.compress.archivers.zip.ZipArchiveEntry.setName. Sets the name of the entry. Parameters name:String the name to use Annotations @Override

setName

back to summary

public void setName(String name)

Overrides org.apache.commons.compress.archivers.zip.ZipArchiveEntry.setName.

Doc from org.apache.commons.compress.archivers.zip.ZipArchiveEntry.setName.

Sets the name of the entry.

Parameters

name:String: the name to use

Annotations

@Override

org.apache.tomcat.jakartaee back to summary

public final Enum Migration.State

Class Inheritance

extends Enum<Migration.State>

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

The tool state.

Field Summary

Modifier and Type	Field and Description
public static final Migration.State	COMPLETE Migration complete.
public static final Migration.State	NOT_STARTED Migration not started yet.
public static final Migration.State	RUNNING Migration in progress.

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static Migration.State	valueOf(String name)
public static Migration.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMPLETE	back to summary
public static final Migration.State COMPLETE Migration complete.

NOT_STARTED	back to summary
public static final Migration.State NOT_STARTED Migration not started yet.

RUNNING	back to summary
public static final Migration.State RUNNING Migration in progress.

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static Migration.State valueOf(String name)

values	back to summary
public static Migration.State[] values()

public Class Migration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Migration.MigrationZipArchiveEntry

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum Migration.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail