Pack200.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.compress.java.util.jar;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Objects;
import java.util.SortedMap;
import java.util.jar.JarFile;
import java.util.jar.JarInputStream;
import java.util.jar.JarOutputStream;
import org.apache.commons.compress.harmony.archive.internal.nls.Messages;
import org.apache.commons.io.input.BoundedInputStream;
/**
* Class factory for {@link Pack200.Packer} and {@link Pack200.Unpacker}.
*/
public abstract class Pack200 {
/**
* The interface defining the API for converting a JAR file to an output stream in the Pack200 format.
*/
public interface Packer {
/**
* The format of a class attribute name.
*/
String CLASS_ATTRIBUTE_PFX = "pack.class.attribute."; //$NON-NLS-1$
/**
* The format of a code attribute name.
*/
String CODE_ATTRIBUTE_PFX = "pack.code.attribute."; //$NON-NLS-1$
/**
* The deflation hint to set in the output archive.
*/
String DEFLATE_HINT = "pack.deflate.hint"; //$NON-NLS-1$
/**
* The indicated amount of effort to use in compressing the archive.
*/
String EFFORT = "pack.effort"; //$NON-NLS-1$
/**
* a String representation for {@code error}.
*/
String ERROR = "error"; //$NON-NLS-1$
/**
* a String representation of {@code false}.
*/
String FALSE = "false"; //$NON-NLS-1$
/**
* The format of a field attribute name.
*/
String FIELD_ATTRIBUTE_PFX = "pack.field.attribute."; //$NON-NLS-1$
/**
* The String representation for {@code keep}.
*/
String KEEP = "keep"; //$NON-NLS-1$
/**
* Decide if all elements shall transmit in their original order.
*/
String KEEP_FILE_ORDER = "pack.keep.file.order"; //$NON-NLS-1$
/**
* The String representation for {@code latest}.
*/
String LATEST = "latest"; //$NON-NLS-1$
/**
* The format of a method attribute name.
*/
String METHOD_ATTRIBUTE_PFX = "pack.method.attribute."; //$NON-NLS-1$
/**
* If it shall attempt to determine the latest modification time if this is set to {@code LATEST}.
*/
String MODIFICATION_TIME = "pack.modification.time"; //$NON-NLS-1$
/**
* The String representation of {@code pass}.
*/
String PASS = "pass"; //$NON-NLS-1$
/**
* The file that will not be compressed.
*/
String PASS_FILE_PFX = "pack.pass.file."; //$NON-NLS-1$
/**
* Packer progress as a percentage.
*/
String PROGRESS = "pack.progress"; //$NON-NLS-1$
/**
* The number of bytes of each archive segment.
*/
String SEGMENT_LIMIT = "pack.segment.limit"; //$NON-NLS-1$
/**
* The String representation of {@code strip}.
*/
String STRIP = "strip"; //$NON-NLS-1$
/**
* The String representation of {@code true}.
*/
String TRUE = "true"; //$NON-NLS-1$
/**
* The action to take if an unknown attribute is encountered.
*/
String UNKNOWN_ATTRIBUTE = "pack.unknown.attribute"; //$NON-NLS-1$
/**
* Adds a listener for PropertyChange events
*
* @param listener the listener to listen if PropertyChange events occurs
*/
void addPropertyChangeListener(PropertyChangeListener listener);
/**
* Packs the specified JAR file to the specified output stream.
*
* @param in JAR file to be compressed.
* @param out stream of compressed data.
* @throws IOException if I/O exception occurs.
*/
void pack(JarFile in, OutputStream out) throws IOException;
/**
* Packs the data from the specified jar input stream to the specified output stream.
*
* @param in stream of uncompressed JAR data.
* @param out stream of compressed data.
* @throws IOException if I/O exception occurs.
*/
void pack(JarInputStream in, OutputStream out) throws IOException;
/**
* Gets a sorted map of the properties of this packer.
*
* @return the properties of the packer.
*/
SortedMap<String, String> properties();
/**
* Removes a listener
*
* @param listener listener to remove
*/
void removePropertyChangeListener(PropertyChangeListener listener);
}
/**
* The interface defining the API for converting a packed stream in the Pack200 format to a JAR file.
*/
public interface Unpacker {
/**
* The String indicating if the unpacker should ignore all transmitted values, can be replaced by either {@code true} or {@code false}.
*/
String DEFLATE_HINT = "unpack.deflate.hint"; //$NON-NLS-1$
/**
* a String representation of {@code false}.
*/
String FALSE = "false"; //$NON-NLS-1$
/**
* a String representation of {@code keep}.
*/
String KEEP = "keep"; //$NON-NLS-1$
/**
* The progress as a {@code percentage}.
*/
String PROGRESS = "unpack.progress"; //$NON-NLS-1$
/**
* a String representation of {@code true}.
*/
String TRUE = "true"; //$NON-NLS-1$
/**
* Adds a listener for {@code PropertyChange} events.
*
* @param listener the listener to listen if {@code PropertyChange} events occurs.
*/
void addPropertyChangeListener(PropertyChangeListener listener);
/**
* Gets a sorted map of the properties of this unpacker.
*
* @return the properties of unpacker.
*/
SortedMap<String, String> properties();
/**
* Removes a listener.
*
* @param listener listener to remove.
*/
void removePropertyChangeListener(PropertyChangeListener listener);
/**
* Unpacks the contents of the specified {@code File} to the specified JAR output stream.
*
* @param in file to uncompress.
* @param out JAR output stream of uncompressed data.
* @throws IOException if I/O exception occurs.
*/
void unpack(File in, JarOutputStream out) throws IOException;
/**
* Unpacks the specified stream to the specified JAR output stream.
*
* @param in stream to uncompress, preferably a {@link BoundedInputStream}.
* @param out JAR output stream of uncompressed data.
* @throws IOException if I/O exception occurs.
*/
void unpack(InputStream in, JarOutputStream out) throws IOException;
}
/**
* System property key.
*/
private static final String SYSTEM_PROPERTY_PACKER = "java.util.jar.Pack200.Packer"; //$NON-NLS-1$
/**
* System property key.
*/
private static final String SYSTEM_PROPERTY_UNPACKER = "java.util.jar.Pack200.Unpacker"; //$NON-NLS-1$
static Object newInstance(final String systemProperty, final String defaultClassName) {
return AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
final String className = System.getProperty(systemProperty, defaultClassName);
try {
// TODO Not sure if this will cause problems loading the class
ClassLoader classLoader = Pack200.class.getClassLoader();
if (classLoader == null) {
classLoader = Objects.requireNonNull(ClassLoader.getSystemClassLoader(), "ClassLoader.getSystemClassLoader()");
}
return classLoader.loadClass(className).getConstructor().newInstance();
} catch (final Exception e) {
throw new Error(Messages.getString("archive.3E", className), e); //$NON-NLS-1$
}
});
}
/**
* Returns a new instance of a packer engine.
* <p>
* The implementation of the packer engine is defined by the system property {@code 'java.util.jar.Pack200.Packer'}. If this system property is defined an
* instance of the specified class is returned, otherwise the system's default implementation is returned.
* </p>
*
* @return an instance of {@code Packer}
*/
public static Pack200.Packer newPacker() {
return (Packer) newInstance(SYSTEM_PROPERTY_PACKER, "org.apache.commons.compress.harmony.pack200.Pack200PackerAdapter"); //$NON-NLS-1$
}
/**
* Returns a new instance of an unpacker engine.
* <p>
* The implementation of the unpacker engine is defined by the system property {@link Pack200.Unpacker}. If this system property is defined an instance of
* the specified class is returned, otherwise the system's default implementation is returned.
* </p>
*
* @return an instance of {@link Pack200.Unpacker}.
*/
public static Pack200.Unpacker newUnpacker() {
return (Unpacker) newInstance(SYSTEM_PROPERTY_UNPACKER, "org.apache.commons.compress.harmony.unpack200.Pack200UnpackerAdapter"); //$NON-NLS-1$
}
/**
* Prevents this class from being instantiated.
*/
private Pack200() {
// do nothing
}
}