Package com.linecorp.armeria.server.cors

Class CorsService

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Service<HttpRequest,HttpResponse>>

com.linecorp.armeria.server.DecoratingService<HttpRequest,HttpResponse,HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingService<HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingHttpService

com.linecorp.armeria.server.cors.CorsService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public final class CorsService
extends SimpleDecoratingHttpService

Decorates an HttpService to add the Cross-Origin Resource Sharing (CORS) support.

See Also:

• CorsServiceBuilder

Method Summary

Modifier and Type	Method	Description
static CorsServiceBuilder	builder(Iterable<String> origins)	Returns a new CorsServiceBuilder with the specified origins.
static CorsServiceBuilder	builder(String... origins)	Returns a new CorsServiceBuilder with the specified origins.
static CorsServiceBuilder	builder(Predicate<? super String> originPredicate)	Returns a new CorsServiceBuilder with origins matching the originPredicate.
static CorsServiceBuilder	builderForAnyOrigin()	Returns a new CorsServiceBuilder with its origin set with "*" (any origin).
static CorsServiceBuilder	builderForOriginRegex(String originRegex)	Returns a new CorsServiceBuilder with origins matching the originRegex.
static CorsServiceBuilder	builderForOriginRegex(Pattern originRegex)	Returns a new CorsServiceBuilder with origins matching the originRegex.
CorsConfig	config()	Returns the CorsConfig.
HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.

Methods inherited from class com.linecorp.armeria.server.SimpleDecoratingHttpService

exchangeType, options

Methods inherited from class com.linecorp.armeria.server.DecoratingService

serviceAdded, shouldCachePath

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap, unwrapAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.server.HttpService

decorate, decorate

Methods inherited from interface com.linecorp.armeria.server.Service

as, serviceAdded, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

builderForAnyOrigin

public static CorsServiceBuilder builderForAnyOrigin()

Returns a new CorsServiceBuilder with its origin set with "*" (any origin).

builder

public static CorsServiceBuilder builder(String... origins)

Returns a new CorsServiceBuilder with the specified origins.

builder

public static CorsServiceBuilder builder(Iterable<String> origins)

Returns a new CorsServiceBuilder with the specified origins.

builder

@UnstableApi
public static CorsServiceBuilder builder(Predicate<? super String> originPredicate)

Returns a new CorsServiceBuilder with origins matching the originPredicate.

builderForOriginRegex

@UnstableApi
public static CorsServiceBuilder builderForOriginRegex(String originRegex)

Returns a new CorsServiceBuilder with origins matching the originRegex.

builderForOriginRegex

@UnstableApi
public static CorsServiceBuilder builderForOriginRegex(Pattern originRegex)

Returns a new CorsServiceBuilder with origins matching the originRegex.

config

public CorsConfig config()

Returns the CorsConfig.

serve

public HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest req)
                   throws Exception

Description copied from interface: Service

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception