Module io.helidon.cors

Package io.helidon.cors

Class CrossOriginConfig.Builder

java.lang.Object

io.helidon.cors.CrossOriginConfig.Builder

All Implemented Interfaces:

Builder<CrossOriginConfig.Builder,CrossOriginConfig>, CorsSetter<CrossOriginConfig.Builder>, Supplier<CrossOriginConfig>

Enclosing class:

CrossOriginConfig

public static class CrossOriginConfig.Builder
extends Object
implements CorsSetter<CrossOriginConfig.Builder>, Builder<CrossOriginConfig.Builder,CrossOriginConfig>

Builder for CrossOriginConfig.

Method Summary

Modifier and Type	Method	Description
CrossOriginConfig.Builder	allowCredentials(boolean allowCredentials)	Sets the allow credentials flag.
CrossOriginConfig.Builder	allowHeaders(String... allowHeaders)	Sets the allow headers.
CrossOriginConfig.Builder	allowMethods(String... allowMethods)	Sets the allow methods.
CrossOriginConfig.Builder	allowOrigins(String... origins)	Sets the allowOrigins.
CrossOriginConfig	build()	Build the instance from this builder.
CrossOriginConfig.Builder	config(Config corsConfig)	Augment or override existing settings using the provided Config node.
CrossOriginConfig.Builder	enabled(boolean enabled)	Sets whether this config should be enabled or not.
CrossOriginConfig.Builder	exposeHeaders(String... exposeHeaders)	Sets the expose headers.
CrossOriginConfig.Builder	maxAgeSeconds(long maxAgeSeconds)	Sets the maximum age.
CrossOriginConfig.Builder	pathPattern(String pathPattern)	Updates the path prefix for this cross-origin config.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Method Details

pathPattern

public CrossOriginConfig.Builder pathPattern(String pathPattern)

Updates the path prefix for this cross-origin config.

Parameters:

pathPattern - new path prefix

Returns:

updated builder

enabled

public CrossOriginConfig.Builder enabled(boolean enabled)

Description copied from interface: CorsSetter

Sets whether this config should be enabled or not.

Specified by:

enabled in interface CorsSetter<CrossOriginConfig.Builder>

Parameters:

enabled - true for this config to have effect; false for it to be ignored

Returns:

updated setter

allowOrigins

public CrossOriginConfig.Builder allowOrigins(String... origins)

Description copied from interface: CorsSetter

Sets the allowOrigins.

Specified by:

allowOrigins in interface CorsSetter<CrossOriginConfig.Builder>

Parameters:

origins - the origin value(s)

Returns:

updated setter

allowHeaders

public CrossOriginConfig.Builder allowHeaders(String... allowHeaders)

Description copied from interface: CorsSetter

Sets the allow headers.

Specified by:

allowHeaders in interface CorsSetter<CrossOriginConfig.Builder>

Parameters:

allowHeaders - the allow headers value(s)

Returns:

updated setter

exposeHeaders

public CrossOriginConfig.Builder exposeHeaders(String... exposeHeaders)

Description copied from interface: CorsSetter

Sets the expose headers.

Specified by:

exposeHeaders in interface CorsSetter<CrossOriginConfig.Builder>

Parameters:

exposeHeaders - the expose headers value(s)

Returns:

updated setter

allowMethods

public CrossOriginConfig.Builder allowMethods(String... allowMethods)

Description copied from interface: CorsSetter

Sets the allow methods.

Specified by:

allowMethods in interface CorsSetter<CrossOriginConfig.Builder>

Parameters:

allowMethods - the allow method value(s)

Returns:

updated setter

allowCredentials

public CrossOriginConfig.Builder allowCredentials(boolean allowCredentials)

Description copied from interface: CorsSetter

Sets the allow credentials flag.

Specified by:

allowCredentials in interface CorsSetter<CrossOriginConfig.Builder>

Parameters:

allowCredentials - the allow credentials flag

Returns:

updated setter

maxAgeSeconds

public CrossOriginConfig.Builder maxAgeSeconds(long maxAgeSeconds)

Description copied from interface: CorsSetter

Sets the maximum age.

Specified by:

maxAgeSeconds in interface CorsSetter<CrossOriginConfig.Builder>

Parameters:

maxAgeSeconds - the maximum age

Returns:

updated setter

config

public CrossOriginConfig.Builder config(Config corsConfig)

Augment or override existing settings using the provided Config node.

Parameters:

corsConfig - config node containing CORS information

Returns:

updated builder

build

public CrossOriginConfig build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<CrossOriginConfig.Builder,CrossOriginConfig>

Returns:

instance of the built type

toString

public String toString()

Overrides:

toString in class Object