    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one
    003 * or more contributor license agreements.  See the NOTICE file
    004 * distributed with this work for additional information
    005 * regarding copyright ownership.  The ASF licenses this file
    006 * to you under the Apache License, Version 2.0 (the
    007 * "License"); you may not use this file except in compliance
    008 * with the License.  You may obtain a copy of the License at
    009 *
    010 * http://www.apache.org/licenses/LICENSE-2.0
    011 *
    012 * Unless required by applicable law or agreed to in writing,
    013 * software distributed under the License is distributed on an
    014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    015 * KIND, either express or implied.  See the License for the
    016 * specific language governing permissions and limitations
    017 * under the License.
    018 */
    019package org.apache.commons.compress.archivers.jar;
    020
    021import java.io.IOException;
    022import java.io.OutputStream;
    023
    024import org.apache.commons.compress.archivers.zip.JarMarker;
    025import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
    026import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
    027
    028/**
    029 * Subclass that adds a special extra field to the very first entry
    030 * which allows the created archive to be used as an executable jar on
    031 * Solaris.
    032 *
    033 * @NotThreadSafe
    034 */
    035public class JarArchiveOutputStream extends ZipArchiveOutputStream {
    036
    037    private boolean jarMarkerAdded;
    038
    039    public JarArchiveOutputStream(final OutputStream out) {
    040        super(out);
    041    }
    042
    043    /**
    044     * Create and instance that wraps the output stream using the provided encoding.
    045     *
    046     * @param out the output stream to wrap
    047     * @param encoding the encoding to use. Use null for the platform default.
    048     * @since 1.10
    049     */
    050    public JarArchiveOutputStream(final OutputStream out, final String encoding) {
    051        super(out);
    052        setEncoding(encoding);
    053    }
    054
    055    // @throws ClassCastException if entry is not an instance of ZipArchiveEntry
    056    @Override
    057    public void putArchiveEntry(final ZipArchiveEntry entry) throws IOException {
    058        if (!jarMarkerAdded) {
    059            entry.addAsFirstExtraField(JarMarker.getInstance());
    060            jarMarkerAdded = true;
    061        }
    062        super.putArchiveEntry(entry);
    063    }
    064}