org.apache.pekko.http.cors.javadsl.settings

Class CorsSettings

java.lang.Object

org.apache.pekko.http.cors.javadsl.settings.CorsSettings

Direct Known Subclasses:

CorsSettings

public abstract class CorsSettings
extends java.lang.Object

Public API but not intended for subclassing

Constructor Summary

Constructors

Constructor and Description
CorsSettings()

Method Summary

Modifier and Type	Method and Description
static CorsSettings	create(org.apache.pekko.actor.ActorSystem system) Creates an instance of CorsSettings using the configuration provided by the given ActorSystem.
static CorsSettings	create(com.typesafe.config.Config config) Creates an instance of settings using the given Config.
static CorsSettings	create(java.lang.String configOverrides) Creates an instance of settings using the given String of config overrides to override settings set in the class loader of this class (i.e. by application.conf or reference.conf files in the class loader of this class).
static CorsSettings	defaultSettings() Deprecated. Use other CorsSettings constructors. Since 1.0.0.
abstract boolean	getAllowCredentials()
abstract HttpHeaderRange	getAllowedHeaders()
abstract java.lang.Iterable<HttpMethod>	getAllowedMethods()
abstract HttpOriginMatcher	getAllowedOrigins()
abstract boolean	getAllowGenericHttpRequests()
abstract java.lang.Iterable<java.lang.String>	getExposedHeaders()
abstract java.util.OptionalLong	getMaxAge()
abstract CorsSettings	withAllowCredentials(boolean newValue)
abstract CorsSettings	withAllowedHeaders(HttpHeaderRange newValue)
abstract CorsSettings	withAllowedMethods(java.lang.Iterable<HttpMethod> newValue)
abstract CorsSettings	withAllowedOrigins(HttpOriginMatcher newValue)
abstract CorsSettings	withAllowGenericHttpRequests(boolean newValue)
abstract CorsSettings	withExposedHeaders(java.lang.Iterable<java.lang.String> newValue)
abstract CorsSettings	withMaxAge(java.util.OptionalLong newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

CorsSettings

public CorsSettings()

Method Detail

create

public static CorsSettings create(com.typesafe.config.Config config)

Creates an instance of settings using the given Config.

Parameters:

config - (undocumented)

Returns:

(undocumented)

create

public static CorsSettings create(java.lang.String configOverrides)

Creates an instance of settings using the given String of config overrides to override settings set in the class loader of this class (i.e. by application.conf or reference.conf files in the class loader of this class).

Parameters:

configOverrides - (undocumented)

Returns:

(undocumented)

create

public static CorsSettings create(org.apache.pekko.actor.ActorSystem system)

Creates an instance of CorsSettings using the configuration provided by the given ActorSystem.

Parameters:

system - (undocumented)

Returns:

(undocumented)

defaultSettings

public static CorsSettings defaultSettings()

Deprecated. Use other CorsSettings constructors. Since 1.0.0.

Settings from the default loaded configuration. Note that application code may want to use the apply() methods instead to have more control over the source of the configuration.

Returns:

(undocumented)

getAllowGenericHttpRequests

public abstract boolean getAllowGenericHttpRequests()

getAllowCredentials

public abstract boolean getAllowCredentials()

getAllowedOrigins

public abstract HttpOriginMatcher getAllowedOrigins()

getAllowedHeaders

public abstract HttpHeaderRange getAllowedHeaders()

getAllowedMethods

public abstract java.lang.Iterable<HttpMethod> getAllowedMethods()

getExposedHeaders

public abstract java.lang.Iterable<java.lang.String> getExposedHeaders()

getMaxAge

public abstract java.util.OptionalLong getMaxAge()

withAllowGenericHttpRequests

public abstract CorsSettings withAllowGenericHttpRequests(boolean newValue)

withAllowCredentials

public abstract CorsSettings withAllowCredentials(boolean newValue)

withAllowedOrigins

public abstract CorsSettings withAllowedOrigins(HttpOriginMatcher newValue)

withAllowedHeaders

public abstract CorsSettings withAllowedHeaders(HttpHeaderRange newValue)

withAllowedMethods

public abstract CorsSettings withAllowedMethods(java.lang.Iterable<HttpMethod> newValue)

withExposedHeaders

public abstract CorsSettings withExposedHeaders(java.lang.Iterable<java.lang.String> newValue)

withMaxAge

public abstract CorsSettings withMaxAge(java.util.OptionalLong newValue)