1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.commons.compress.archivers.zip;
20
21 import java.util.zip.ZipException;
22
23 /**
24 * Handles extra field data that doesn't follow the recommended pattern for extra fields with a two-byte key and a two-byte length.
25 *
26 * @since 1.19
27 */
28 public interface UnparseableExtraFieldBehavior {
29 /**
30 * Decides what to do with extra field data that doesn't follow the recommended pattern.
31 *
32 * @param data the array of extra field data
33 * @param off offset into data where the unparseable data starts
34 * @param len the length of unparseable data
35 * @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
36 * header extra data.
37 * @param claimedLength length of the extra field claimed by the third and forth byte if it did follow the recommended pattern
38 *
39 * @return null if the data should be ignored or an extra field implementation that represents the data
40 * @throws ZipException if an error occurs or unparseable extra fields must not be accepted
41 */
42 ZipExtraField onUnparseableExtraField(byte[] data, int off, int len, boolean local, int claimedLength) throws ZipException;
43 }