How to handle CORS using JAX-RS with Jersey

How to handle CORS using JAX-RS with Jersey

Cross-Origin Resource Sharing (CORS) is a security feature implemented in web browsers to control which web domains are allowed to make requests to a given web domain. If you are using JAX-RS with Jersey to build a RESTful web service and you need to handle CORS, you can do so by configuring CORS filters or interceptors. Here's how you can handle CORS using Jersey:

  1. Add Jersey-CORS Dependency:

    First, make sure you have the Jersey-CORS dependency in your project. You can add it to your pom.xml if you're using Maven:

    <dependency> <groupId>org.glassfish.jersey.ext</groupId> <artifactId>jersey-cors-headers</artifactId> <version>3.0.2</version> <!-- Use the latest version --> </dependency>

    Or add it to your Gradle build file if you're using Gradle:

    implementation group: 'org.glassfish.jersey.ext', name: 'jersey-cors-headers', version: '3.0.2' // Use the latest version

  2. Configure CORS Filter:

    Next, you need to configure a CORS filter in your JAX-RS application. You can create a class that extends org.glassfish.jersey.server.ResourceConfig and register the CorsFilter from Jersey-CORS:

    import org.glassfish.jersey.server.ResourceConfig; import org.glassfish.jersey.server.filter.CorsFilter; public class MyApplication extends ResourceConfig { public MyApplication() { // Register your JAX-RS resources here // Register the CORS filter register(CorsFilter.class); // Set CORS configuration if needed property("jersey.config.server.provider.classnames", "org.glassfish.jersey.media.multipart.MultiPartFeature"); } }

    In the above code:

    • register(CorsFilter.class) registers the Jersey-CORS filter.
    • You can specify additional properties as needed. For example, if you're using file uploads, you may need to register the MultiPartFeature.

  3. Configure CORS Settings:

    To configure CORS settings, you can use annotations on your JAX-RS resource classes or methods. For example, you can use the @CrossOriginResourceSharing annotation to specify allowed origins, methods, headers, and other CORS settings:

    import org.glassfish.jersey.server.mvc.Viewable; import org.glassfish.jersey.server.mvc.ErrorTemplate; import javax.ws.rs.*; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import javax.ws.rs.core.UriInfo; @Path("/example") @Produces(MediaType.TEXT_HTML) @ErrorTemplate(name = "/error.html") public class ExampleResource { @GET @Path("hello") @CrossOriginResourceSharing(allowAllOrigins = true, allowCredentials = true) public Response sayHello() { return Response.ok(new Viewable("/index.jsp")).build(); } // Other resource methods... }

    In this example, the @CrossOriginResourceSharing annotation is used to specify that all origins are allowed (allowAllOrigins = true) and credentials are allowed (allowCredentials = true). You can customize these settings as needed.

  4. Run the Application:

    Finally, you can deploy and run your JAX-RS application as usual. The CORS filter will handle CORS-related headers, and the annotations on your resource methods will control CORS behavior for specific endpoints.

With these steps, you can configure and handle CORS in your JAX-RS application built with Jersey. This allows you to control which domains can access your RESTful API resources from the client side.

More Tags

python-unittest.mock background-fetch spring-oauth2 kotlin variable-assignment ms-access-2007 android-image spring-cloud conda wkhtmltoimage

More Java Questions

More Fitness-Health Calculators

More Bio laboratory Calculators

More Chemistry Calculators

More Trees & Forestry Calculators