DataLakeCorsRule Class

Package:

com.azure.storage.file.datalake.models

Maven Artifact:

com.azure:azure-storage-file-datalake:12.23.0

• java.lang.Object
• • com.azure.storage.file.datalake.models.DataLakeCorsRule

public final class DataLakeCorsRule

CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.

Constructor Summary

Constructor	Description
DataLakeCorsRule()	Creates a new instance of DataLakeCorsRule.

Method Summary

Modifier and Type	Method and Description
String	getAllowedHeaders() Get the allowedHeaders property: the request headers that the origin domain may specify on the CORS request.
String	getAllowedMethods() Get the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request.
String	getAllowedOrigins() Get the allowedOrigins property: The origin domains that are permitted to make a request against the storage service via CORS.
String	getExposedHeaders() Get the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
int	getMaxAgeInSeconds() Get the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.
DataLakeCorsRule	setAllowedHeaders(String allowedHeaders) Set the allowedHeaders property: the request headers that the origin domain may specify on the CORS request.
DataLakeCorsRule	setAllowedMethods(String allowedMethods) Set the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request.
DataLakeCorsRule	setAllowedOrigins(String allowedOrigins) Set the allowedOrigins property: The origin domains that are permitted to make a request against the storage service via CORS.
DataLakeCorsRule	setExposedHeaders(String exposedHeaders) Set the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
DataLakeCorsRule	setMaxAgeInSeconds(int maxAgeInSeconds) Set the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataLakeCorsRule

public DataLakeCorsRule()

Creates a new instance of DataLakeCorsRule.

Method Details

getAllowedHeaders

public String getAllowedHeaders()

Get the allowedHeaders property: the request headers that the origin domain may specify on the CORS request.

Returns:

the allowedHeaders value.

getAllowedMethods

public String getAllowedMethods()

Get the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated).

Returns:

the allowedMethods value.

getAllowedOrigins

public String getAllowedOrigins()

Get the allowedOrigins property: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.

Returns:

the allowedOrigins value.

getExposedHeaders

public String getExposedHeaders()

Get the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

Returns:

the exposedHeaders value.

getMaxAgeInSeconds

public int getMaxAgeInSeconds()

Get the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.

Returns:

the maxAgeInSeconds value.

setAllowedHeaders

public DataLakeCorsRule setAllowedHeaders(String allowedHeaders)

Set the allowedHeaders property: the request headers that the origin domain may specify on the CORS request.

Parameters:

allowedHeaders - the allowedHeaders value to set.

Returns:

the DataLakeCorsRule object itself.

setAllowedMethods

public DataLakeCorsRule setAllowedMethods(String allowedMethods)

Set the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated).

Parameters:

allowedMethods - the allowedMethods value to set.

Returns:

the DataLakeCorsRule object itself.

setAllowedOrigins

public DataLakeCorsRule setAllowedOrigins(String allowedOrigins)

Set the allowedOrigins property: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.

Parameters:

allowedOrigins - the allowedOrigins value to set.

Returns:

the DataLakeCorsRule object itself.

setExposedHeaders

public DataLakeCorsRule setExposedHeaders(String exposedHeaders)

Set the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

Parameters:

exposedHeaders - the exposedHeaders value to set.

Returns:

the DataLakeCorsRule object itself.

setMaxAgeInSeconds

public DataLakeCorsRule setMaxAgeInSeconds(int maxAgeInSeconds)

Set the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.

Parameters:

maxAgeInSeconds - the maxAgeInSeconds value to set.

Returns:

the DataLakeCorsRule object itself.