Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PathProvider supports Path entities, in preparation for future default support in JAX-RS 4.1 / Jersey 4.1 #5674

Merged
merged 1 commit into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/*
* Copyright (c) 2024 Markus KARG and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/

package org.glassfish.jersey.message.internal;

import static jakarta.ws.rs.core.MediaType.APPLICATION_OCTET_STREAM;
import static jakarta.ws.rs.core.MediaType.WILDCARD;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;

import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;

import jakarta.inject.Singleton;

/**
* Provider for marshalling/un-marshalling of {@code application/octet-stream}
* entity type to/from a {@link Path} instance.
*
* @author Markus KARG
*/
@Produces({APPLICATION_OCTET_STREAM, WILDCARD})
@Consumes({APPLICATION_OCTET_STREAM, WILDCARD})
@Singleton
public final class PathProvider extends AbstractMessageReaderWriterProvider<Path> {

@Override
public final boolean isReadable(final Class<?> type,
final Type genericType,
final Annotation[] annotations,
final MediaType mediaType) {
return Path.class == type;
}

@Override
public final Path readFrom(final Class<Path> type,
final Type genericType,
final Annotation[] annotations,
final MediaType mediaType,
final MultivaluedMap<String, String> httpHeaders,
final InputStream entityStream) throws IOException {
final var path = Utils.createTempFile().toPath();
Files.copy(entityStream, path, StandardCopyOption.REPLACE_EXISTING);
return path;
}

@Override
public final boolean isWriteable(final Class<?> type,
final Type genericType,
final Annotation[] annotations,
final MediaType mediaType) {
return Path.class.isAssignableFrom(type);
}

@Override
public final void writeTo(final Path t,
final Class<?> type,
final Type genericType,
final Annotation[] annotations,
final MediaType mediaType,
final MultivaluedMap<String, Object> httpHeaders,
final OutputStream entityStream) throws IOException {
Files.copy(t, entityStream);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
"allDeclaredMethods":true,
"allDeclaredConstructors":true
},
{
"name":"org.glassfish.jersey.message.internal.PathProvider",
"allDeclaredFields":true,
"allDeclaredMethods":true,
"allDeclaredConstructors":true
},
{
"name":"org.glassfish.jersey.message.internal.FormMultivaluedMapProvider",
"allDeclaredFields":true,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2022 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2010, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
Expand Down Expand Up @@ -72,6 +72,7 @@
import org.glassfish.jersey.internal.util.collection.MultivaluedStringMap;
import org.glassfish.jersey.jettison.JettisonFeature;
import org.glassfish.jersey.message.internal.FileProvider;
import org.glassfish.jersey.message.internal.PathProvider;
import org.glassfish.jersey.server.ResourceConfig;

import org.codehaus.jettison.json.JSONArray;
Expand Down Expand Up @@ -325,13 +326,13 @@ public JaxbBean post(final JaxbBeanType t) {

@Override
protected Application configure() {
return ((ResourceConfig) super.configure()).register(new JettisonFeature());
return ((ResourceConfig) super.configure()).register(new JettisonFeature()).register(new PathProvider());
}

@Override
protected void configureClient(final ClientConfig config) {
super.configureClient(config);
config.register(new JettisonFeature());
config.register(new JettisonFeature()).register(new PathProvider());
}

@Test
Expand Down Expand Up @@ -431,6 +432,20 @@ public void testFileRepresentation() throws IOException {
_test(in, FileResource.class);
}

@Path("PathResource")
public static class PathResource extends AResource<java.nio.file.Path> {
}

@Test
@Execution(ExecutionMode.CONCURRENT)
public void testPathRepresentation() throws IOException {
final var pp = new PathProvider();
final var in = pp.readFrom(java.nio.file.Path.class, java.nio.file.Path.class, null, null, null,
new ByteArrayInputStream("CONTENT".getBytes()));

_test(in, PathResource.class);
}

@Produces("application/x-www-form-urlencoded")
@Consumes("application/x-www-form-urlencoded")
@Path("FormResource")
Expand Down