Package org.apache.wicket.coop

Class CrossOriginOpenerPolicyConfiguration

java.lang.Object

org.apache.wicket.coop.CrossOriginOpenerPolicyConfiguration

public class CrossOriginOpenerPolicyConfiguration
extends Object

Specifies the configuration for Cross-Origin Opener Policy to be used by CrossOriginOpenerPolicyRequestCycleListener when adding COOP headers. Users can specify the paths that should be exempt from COOP and one of 4 modes (UNSAFE_NONE, SAME_ORIGIN, SAME_ORIGIN_ALLOW_POPUPS, DISABLED) for the policy. The config object lives in SecuritySettings, users can specify their COOP preferences with the following lines in their application's WebApplication.init() method:

 @Override
 protected void init()
 {
        // ...
        getSecuritySettings().setCrossOriginOpenerPolicyConfiguration(CoopMode.SAME_ORIGIN,
                "EXEMPTED PATHS");
        // ...
 }
 

The config value will be read once at startup in Application.initApplication(), changing the configuration at runtime will have no effect of the COOP headers set.

Author:

Santiago Diaz - saldiaz@google.com, Ecenaz Jen Ozmen - ecenazo@google.com

See Also:

CrossOriginOpenerPolicyRequestCycleListener, SecuritySettings

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CrossOriginOpenerPolicyConfiguration.CoopMode

Constructor Summary

Constructors

Constructor	Description
CrossOriginOpenerPolicyConfiguration(CrossOriginOpenerPolicyConfiguration.CoopMode mode)
CrossOriginOpenerPolicyConfiguration(CrossOriginOpenerPolicyConfiguration.CoopMode mode, String... exemptions)

Method Summary

Modifier and Type	Method	Description
CrossOriginOpenerPolicyConfiguration	addExemptedPath(String path)
Set<String>	getExemptions()
String	getHeaderValue()
CrossOriginOpenerPolicyConfiguration.CoopMode	getMode()
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossOriginOpenerPolicyConfiguration

public CrossOriginOpenerPolicyConfiguration(CrossOriginOpenerPolicyConfiguration.CoopMode mode,
                                            String... exemptions)

CrossOriginOpenerPolicyConfiguration

public CrossOriginOpenerPolicyConfiguration(CrossOriginOpenerPolicyConfiguration.CoopMode mode)

Method Detail

addExemptedPath

public CrossOriginOpenerPolicyConfiguration addExemptedPath(String path)

getExemptions

public Set<String> getExemptions()

getMode

public CrossOriginOpenerPolicyConfiguration.CoopMode getMode()

getHeaderValue

public String getHeaderValue()

isEnabled

public boolean isEnabled()