Package org.apache.flink.runtime.rest

Class RestServerEndpointConfiguration

java.lang.Object

org.apache.flink.runtime.rest.RestServerEndpointConfiguration

public final class RestServerEndpointConfiguration
extends Object

A configuration object for RestServerEndpoints.

Method Summary

Modifier and Type	Method	Description
static RestServerEndpointConfiguration	fromConfiguration(org.apache.flink.configuration.Configuration config)	Creates and returns a new RestServerEndpointConfiguration from the given Configuration.
int	getMaxContentLength()	Returns the max content length that the REST server endpoint could handle.
Map<String,String>	getResponseHeaders()	Response headers that should be added to every HTTP response.
String	getRestAddress()
String	getRestBindAddress()	Returns the address that the REST server endpoint should bind itself to.
String	getRestBindPortRange()	Returns the port range that the REST server endpoint should listen on.
SSLHandlerFactory	getSslHandlerFactory()	Returns the SSLEngine that the REST server endpoint should use.
Path	getUploadDir()	Returns the directory used to temporarily store multipart/form-data uploads.

Methods inherited from class java.lang.Object

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

Method Details

getRestAddress

public String getRestAddress()

See Also:

• RestOptions.ADDRESS

getRestBindAddress

public String getRestBindAddress()

Returns the address that the REST server endpoint should bind itself to.

Returns:

address that the REST server endpoint should bind itself to

getRestBindPortRange

public String getRestBindPortRange()

Returns the port range that the REST server endpoint should listen on.

Returns:

port range that the REST server endpoint should listen on

getSslHandlerFactory

@Nullable
public SSLHandlerFactory getSslHandlerFactory()

Returns the SSLEngine that the REST server endpoint should use.

Returns:

SSLEngine that the REST server endpoint should use, or null if SSL was disabled

getUploadDir

public Path getUploadDir()

Returns the directory used to temporarily store multipart/form-data uploads.

getMaxContentLength

public int getMaxContentLength()

Returns the max content length that the REST server endpoint could handle.

Returns:

max content length that the REST server endpoint could handle

getResponseHeaders

public Map<String,String> getResponseHeaders()

Response headers that should be added to every HTTP response.

fromConfiguration

public static RestServerEndpointConfiguration fromConfiguration(org.apache.flink.configuration.Configuration config)
                                                         throws org.apache.flink.util.ConfigurationException

Creates and returns a new RestServerEndpointConfiguration from the given Configuration.

Parameters:

config - configuration from which the REST server endpoint configuration should be created from

Returns:

REST server endpoint configuration

Throws:

org.apache.flink.util.ConfigurationException - if SSL was configured incorrectly