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.zip;
020
021import java.util.zip.ZipException;
022
023/**
024 * Handles extra field data that doesn't follow the recommended pattern for extra fields with a two-byte key and a two-byte length.
025 *
026 * @since 1.19
027 */
028public interface UnparseableExtraFieldBehavior {
029    /**
030     * Decides what to do with extra field data that doesn't follow the recommended pattern.
031     *
032     * @param data          the array of extra field data
033     * @param off           offset into data where the unparseable data starts
034     * @param len           the length of unparseable data
035     * @param local         whether the extra field data stems from the local file header. If this is false then the data is part if the central directory
036     *                      header extra data.
037     * @param claimedLength length of the extra field claimed by the third and forth byte if it did follow the recommended pattern
038     *
039     * @return null if the data should be ignored or an extra field implementation that represents the data
040     * @throws ZipException if an error occurs or unparseable extra fields must not be accepted
041     */
042    ZipExtraField onUnparseableExtraField(byte[] data, int off, int len, boolean local, int claimedLength) throws ZipException;
043}