com.sap.cloud.server.odata

Class NetworkOptions

java.lang.Object

com.sap.cloud.server.odata.NetworkOptions

public class NetworkOptions
extends java.lang.Object

Options for interaction with a data network.

Constructor Summary

Constructors

Constructor and Description
NetworkOptions()

Method Summary

Modifier and Type	Method and Description
boolean	getAllowTunneling() Return should HTTP verb tunneling be allowed in preference to OData batch requests? Defaults to false.
boolean	getCompressRequests() Return should requests be compressed (if this is supported by the client and by the server)? True by default.
boolean	getCompressResponses() Return should responses be compressed (if this is supported by the client and by the server)? True by default.
HttpHandler	getHttpHandler() Return (nullable) A handler for all HTTP requests made by the data service.
boolean	getStreamDownloads() Return should downloads be streamed? Set this to false to force the use of non-streamed downloads.
boolean	getStreamUploads() Return should uploads be streamed? Set this to false to force the use of non-streamed uploads.
StringList	getTunneledMethods() Return which HTTP methods must be tunneled in HTTP POST due to proxy/firewall issues?
java.lang.String	getTunnelingHeader() Return which HTTP header can be used for tunneling, if it is required? Defaults to "X-HTTP-Method".
void	setAllowTunneling(boolean value) Set should HTTP verb tunneling be allowed in preference to OData batch requests? Defaults to false.
void	setCompressRequests(boolean value) Set should requests be compressed (if this is supported by the client and by the server)? True by default.
void	setCompressResponses(boolean value) Set should responses be compressed (if this is supported by the client and by the server)? True by default.
void	setHttpHandler(HttpHandler value) Set a handler for all HTTP requests made by the data service.
void	setStreamDownloads(boolean value) Set should downloads be streamed? Set this to false to force the use of non-streamed downloads.
void	setStreamUploads(boolean value) Set should uploads be streamed? Set this to false to force the use of non-streamed uploads.
void	setTunneledMethods(StringList value) Set which HTTP methods must be tunneled in HTTP POST due to proxy/firewall issues?
void	setTunnelingHeader(java.lang.String value) Set which HTTP header can be used for tunneling, if it is required? Defaults to "X-HTTP-Method".

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkOptions

public NetworkOptions()

Method Detail

getAllowTunneling

public boolean getAllowTunneling()

Return should HTTP verb tunneling be allowed in preference to OData batch requests? Defaults to false.

See Also:

NetworkOptions.tunneledMethods, NetworkOptions.tunnelingHeader.

Returns:

Should HTTP verb tunneling be allowed in preference to OData batch requests?

getCompressRequests

public boolean getCompressRequests()

Return should requests be compressed (if this is supported by the client and by the server)? True by default.

Returns:

Should requests be compressed (if this is supported by the client and by the server)?

getCompressResponses

public boolean getCompressResponses()

Return should responses be compressed (if this is supported by the client and by the server)? True by default.

Returns:

Should responses be compressed (if this is supported by the client and by the server)?

getHttpHandler

public HttpHandler getHttpHandler()

Return (nullable) A handler for all HTTP requests made by the data service.

Returns:

(nullable) A handler for all HTTP requests made by the data service.

getStreamDownloads

public boolean getStreamDownloads()

Return should downloads be streamed? Set this to false to force the use of non-streamed downloads. True by default.

See Also:

DataService.downloadMedia, DataService.downloadStream.

Returns:

Should downloads be streamed? Set this to `false` to force the use of non-streamed downloads.

getStreamUploads

public boolean getStreamUploads()

Return should uploads be streamed? Set this to false to force the use of non-streamed uploads. True by default.

See Also:

DataService.createMedia, DataService.uploadMedia, DataService.uploadStream.

Returns:

Should uploads be streamed? Set this to `false` to force the use of non-streamed uploads.

getTunneledMethods

public StringList getTunneledMethods()

Return which HTTP methods must be tunneled in HTTP POST due to proxy/firewall issues?

See Also:

NetworkOptions.allowTunneling.

Returns:

Which HTTP methods must be tunneled in HTTP POST due to proxy/firewall issues?

getTunnelingHeader

public java.lang.String getTunnelingHeader()

Return which HTTP header can be used for tunneling, if it is required? Defaults to "X-HTTP-Method".

See Also:

NetworkOptions.allowTunneling.

Returns:

Which HTTP header can be used for tunneling, if it is required?

setAllowTunneling

public void setAllowTunneling(boolean value)

Set should HTTP verb tunneling be allowed in preference to OData batch requests? Defaults to false.

See Also:

NetworkOptions.tunneledMethods, NetworkOptions.tunnelingHeader.

Parameters:

value - Should HTTP verb tunneling be allowed in preference to OData batch requests?

setCompressRequests

public void setCompressRequests(boolean value)

Set should requests be compressed (if this is supported by the client and by the server)? True by default.

Parameters:

value - Should requests be compressed (if this is supported by the client and by the server)?

setCompressResponses

public void setCompressResponses(boolean value)

Set should responses be compressed (if this is supported by the client and by the server)? True by default.

Parameters:

value - Should responses be compressed (if this is supported by the client and by the server)?

setHttpHandler

public void setHttpHandler(HttpHandler value)

Set a handler for all HTTP requests made by the data service.

Parameters:

value - A handler for all HTTP requests made by the data service.

setStreamDownloads

public void setStreamDownloads(boolean value)

Set should downloads be streamed? Set this to false to force the use of non-streamed downloads. True by default.

See Also:

DataService.downloadMedia, DataService.downloadStream.

Parameters:

value - Should downloads be streamed? Set this to `false` to force the use of non-streamed downloads.

setStreamUploads

public void setStreamUploads(boolean value)

Set should uploads be streamed? Set this to false to force the use of non-streamed uploads. True by default.

See Also:

DataService.createMedia, DataService.uploadMedia, DataService.uploadStream.

Parameters:

value - Should uploads be streamed? Set this to `false` to force the use of non-streamed uploads.

setTunneledMethods

public void setTunneledMethods(StringList value)

Set which HTTP methods must be tunneled in HTTP POST due to proxy/firewall issues?

See Also:

NetworkOptions.allowTunneling.

Parameters:

value - Which HTTP methods must be tunneled in HTTP POST due to proxy/firewall issues?

setTunnelingHeader

public void setTunnelingHeader(java.lang.String value)

Set which HTTP header can be used for tunneling, if it is required? Defaults to "X-HTTP-Method".

See Also:

NetworkOptions.allowTunneling.

Parameters:

value - Which HTTP header can be used for tunneling, if it is required?