Class CorsFilter
java.lang.Object
org.jboss.resteasy.plugins.interceptors.CorsFilter
- All Implemented Interfaces:
jakarta.ws.rs.container.ContainerRequestFilter
,jakarta.ws.rs.container.ContainerResponseFilter
@PreMatching
public class CorsFilter
extends Object
implements jakarta.ws.rs.container.ContainerRequestFilter, jakarta.ws.rs.container.ContainerResponseFilter
Handles CORS requests both preflight and simple CORS requests.
You must bind this as a singleton and set up allowedOrigins and other settings to use.
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
checkOrigin
(jakarta.ws.rs.container.ContainerRequestContext requestContext, String origin) void
filter
(jakarta.ws.rs.container.ContainerRequestContext requestContext) void
filter
(jakarta.ws.rs.container.ContainerRequestContext requestContext, jakarta.ws.rs.container.ContainerResponseContext responseContext) Will allow all by default.Put "*" if you want to accept all origins.int
boolean
Defaults to true.protected void
void
setAllowCredentials
(boolean allowCredentials) void
setAllowedHeaders
(String allowedHeaders) Will allow all by default comma delimited string for Access-Control-Allow-Headers.void
setAllowedMethods
(String allowedMethods) Will allow all by default comma delimited string for Access-Control-Allow-Methods.void
setCorsMaxAge
(int corsMaxAge) void
setExposedHeaders
(String exposedHeaders) Comma delimited list.
-
Field Details
-
allowCredentials
protected boolean allowCredentials -
allowedMethods
-
allowedHeaders
-
exposedHeaders
-
corsMaxAge
protected int corsMaxAge -
allowedOrigins
-
-
Constructor Details
-
CorsFilter
public CorsFilter()
-
-
Method Details
-
getAllowedOrigins
-
isAllowCredentials
public boolean isAllowCredentials()Defaults to true.- Returns:
- allow credentials
-
setAllowCredentials
public void setAllowCredentials(boolean allowCredentials) -
getAllowedMethods
-
setAllowedMethods
Will allow all by default comma delimited string for Access-Control-Allow-Methods.- Parameters:
allowedMethods
- allowed methods
-
getAllowedHeaders
-
setAllowedHeaders
Will allow all by default comma delimited string for Access-Control-Allow-Headers.- Parameters:
allowedHeaders
- allowed headers
-
getCorsMaxAge
public int getCorsMaxAge() -
setCorsMaxAge
public void setCorsMaxAge(int corsMaxAge) -
getExposedHeaders
-
setExposedHeaders
Comma delimited list.- Parameters:
exposedHeaders
- exposed headers
-
filter
public void filter(jakarta.ws.rs.container.ContainerRequestContext requestContext) throws IOException - Specified by:
filter
in interfacejakarta.ws.rs.container.ContainerRequestFilter
- Throws:
IOException
-
filter
public void filter(jakarta.ws.rs.container.ContainerRequestContext requestContext, jakarta.ws.rs.container.ContainerResponseContext responseContext) throws IOException - Specified by:
filter
in interfacejakarta.ws.rs.container.ContainerResponseFilter
- Throws:
IOException
-
preflight
protected void preflight(String origin, jakarta.ws.rs.container.ContainerRequestContext requestContext) throws IOException - Throws:
IOException
-
checkOrigin
protected void checkOrigin(jakarta.ws.rs.container.ContainerRequestContext requestContext, String origin)
-