org.glassfish.jersey.server.internal.scanning.JarFileScanner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-server Show documentation
Show all versions of jersey-server Show documentation
Jersey core server implementation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.server.internal.scanning;
import java.io.IOException;
import java.io.InputStream;
import java.util.NoSuchElementException;
import java.util.jar.JarEntry;
import java.util.jar.JarInputStream;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
import org.glassfish.jersey.server.internal.LocalizationMessages;
/**
* A utility class that scans entries in jar files.
*
* @author Paul Sandoz
*/
public final class JarFileScanner extends AbstractResourceFinderAdapter {
private static final Logger LOGGER = Logger.getLogger(JarFileScanner.class.getName());
// platform independent file separator within the jar file
private static final char JAR_FILE_SEPARATOR = '/';
private final JarInputStream jarInputStream;
private final String parent;
private final boolean recursive;
/**
* Create new JAR file scanner.
*
* @param inputStream JAR file input stream
* @param parent JAR file entry prefix.
* @param recursive if ({@code true} the packages will be scanned recursively together with any nested packages, if
* {@code false} only the explicitly listed packages will be scanned.
* @throws IOException if wrapping given input stream into {@link JarInputStream} failed.
*/
public JarFileScanner(final InputStream inputStream, final String parent, final boolean recursive) throws IOException {
this.jarInputStream = new JarInputStream(inputStream);
this.parent = (parent.isEmpty() || parent.endsWith(String.valueOf(JAR_FILE_SEPARATOR)))
? parent : parent + JAR_FILE_SEPARATOR;
this.recursive = recursive;
}
private JarEntry next = null;
@Override
public boolean hasNext() {
if (next == null) {
try {
do {
this.next = jarInputStream.getNextJarEntry();
if (next == null) {
break;
}
if (!next.isDirectory() && next.getName().startsWith(parent)) {
if (recursive || next.getName().substring(parent.length()).indexOf(JAR_FILE_SEPARATOR) == -1) {
break;
}
}
} while (true);
} catch (final IOException | SecurityException e) {
LOGGER.log(Level.CONFIG, LocalizationMessages.JAR_SCANNER_UNABLE_TO_READ_ENTRY(), e);
return false;
}
}
if (next == null) {
close();
return false;
}
return true;
}
@Override
public String next() {
if (next != null || hasNext()) {
final String name = next.getName();
next = null;
return name;
}
throw new NoSuchElementException();
}
@Override
public void reset() {
throw new UnsupportedOperationException();
}
@Override
public InputStream open() {
//noinspection NullableProblems
return new InputStream() {
@Override
public int read() throws IOException {
return jarInputStream.read();
}
@Override
public int read(final byte[] bytes) throws IOException {
return jarInputStream.read(bytes);
}
@Override
public int read(final byte[] bytes, final int i, final int i2) throws IOException {
return jarInputStream.read(bytes, i, i2);
}
@Override
public long skip(final long l) throws IOException {
return jarInputStream.skip(l);
}
@Override
public int available() throws IOException {
return jarInputStream.available();
}
@Override
public void close() throws IOException {
jarInputStream.closeEntry();
}
@Override
public synchronized void mark(final int i) {
jarInputStream.mark(i);
}
@Override
public synchronized void reset() throws IOException {
jarInputStream.reset();
}
@Override
public boolean markSupported() {
return jarInputStream.markSupported();
}
};
}
@Override
public void close() {
try {
jarInputStream.close();
} catch (final IOException ioe) {
LOGGER.log(Level.FINE, LocalizationMessages.JAR_SCANNER_UNABLE_TO_CLOSE_FILE(), ioe);
}
}
}