io.micronaut.views.csp

Class CspConfiguration

java.lang.Object

io.micronaut.views.csp.CspConfiguration

All Implemented Interfaces:

Toggleable

@ConfigurationProperties(value="micronaut.views.csp")
public class CspConfiguration
extends Object
implements Toggleable

Defines CSP configuration properties.

Since:

1.1

Author:

Arul Dhesiaseelan

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED
static String	DEFAULT_FILTER_PATH
static boolean	DEFAULT_REPORT_ONLY
static String	FILTER_PATH The path for endpoints settings.
static String	PREFIX The prefix for csp configuration.

Constructor Summary

Constructors

Constructor and Description
CspConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getFilterPath()
Optional<String>	getPolicyDirectives()
boolean	isEnabled()
boolean	isReportOnly()
void	setEnabled(boolean enabled) Sets whether CSP is enabled.
void	setFilterPath(String filterPath) Sets the path the CSP filter should apply to.
void	setPolicyDirectives(String policyDirectives) Sets the policy directives.
void	setReportOnly(boolean reportOnly) If true, the Content-Security-Policy-Report-Only header will be sent instead of Content-Security-Policy.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

The prefix for csp configuration.

See Also:

Constant Field Values

FILTER_PATH

public static final String FILTER_PATH

The path for endpoints settings.

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

DEFAULT_REPORT_ONLY

public static final boolean DEFAULT_REPORT_ONLY

See Also:

Constant Field Values

DEFAULT_FILTER_PATH

public static final String DEFAULT_FILTER_PATH

See Also:

Constant Field Values

Constructor Detail

CspConfiguration

public CspConfiguration()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether csp headers will be sent

getPolicyDirectives

public Optional<String> getPolicyDirectives()

Returns:

The policy directives

isReportOnly

public boolean isReportOnly()

Returns:

Whether the report only header should be set

setEnabled

public void setEnabled(boolean enabled)

Sets whether CSP is enabled. Default false.

Parameters:

enabled - True if CSP is enabled

setPolicyDirectives

public void setPolicyDirectives(@Nullable
                                String policyDirectives)

Sets the policy directives.

Parameters:

policyDirectives - CSP policy directives

setReportOnly

public void setReportOnly(boolean reportOnly)

If true, the Content-Security-Policy-Report-Only header will be sent instead of Content-Security-Policy. Default false.

Parameters:

reportOnly - set to true for reporting purpose only

getFilterPath

public String getFilterPath()

Returns:

The path the CSP filter should apply to

setFilterPath

public void setFilterPath(String filterPath)

Sets the path the CSP filter should apply to. Default value "/**".

Parameters:

filterPath - The filter path