Package org.opencms.main
Class CmsHttpAuthenticationSettings
- java.lang.Object
-
- org.opencms.main.CmsHttpAuthenticationSettings
-
public class CmsHttpAuthenticationSettings extends java.lang.Object
Contains the settings to handle HTTP basic authentication.These settings control whether a browser-based pop-up dialog should be used for authentication, or of the user should be redirected to an OpenCms URI for a form-based authentication.
Since the URI for the form-based authentication is a system wide setting, users are able to specify different authentication forms in a property "login-form" on resources that require authentication.
- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
AUTHENTICATION_BASIC
The mechanism name for basic HTTP authentication.static java.lang.String
AUTHENTICATION_FORM
The mechanism name for form based authentication.static java.lang.String
DEFAULT_AUTHENTICATION_URI
The URI of the default authentication form.
-
Constructor Summary
Constructors Constructor Description CmsHttpAuthenticationSettings()
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getBrowserBasedAuthenticationMechanism()
Returns the browser based authentication mechanism ornull
if unused.java.lang.String
getConfigBrowserBasedAuthentication()
Returns the browser based authentication text for the configuration.java.lang.String
getFormBasedHttpAuthenticationUri()
Returns the URI of the system wide login form if browser-based HTTP basic authentication is disabled.void
setFormBasedHttpAuthenticationUri(java.lang.String uri)
Sets the URI of the system wide login form if browser-based HTTP basic authentication is disabled.void
setUseBrowserBasedHttpAuthentication(boolean value)
Sets if browser-based HTTP basic authentication is enabled or disabled.void
setUseBrowserBasedHttpAuthentication(java.lang.String value)
Sets if browser-based HTTP basic authentication is enabled or disabled.boolean
useBrowserBasedHttpAuthentication()
Tests if browser-based HTTP basic authentication is enabled or disabled.
-
-
-
Field Detail
-
AUTHENTICATION_BASIC
public static final java.lang.String AUTHENTICATION_BASIC
The mechanism name for basic HTTP authentication.- See Also:
- Constant Field Values
-
AUTHENTICATION_FORM
public static final java.lang.String AUTHENTICATION_FORM
The mechanism name for form based authentication.- See Also:
- Constant Field Values
-
DEFAULT_AUTHENTICATION_URI
public static final java.lang.String DEFAULT_AUTHENTICATION_URI
The URI of the default authentication form.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsHttpAuthenticationSettings
public CmsHttpAuthenticationSettings()
Default constructor.
-
-
Method Detail
-
getBrowserBasedAuthenticationMechanism
public java.lang.String getBrowserBasedAuthenticationMechanism()
Returns the browser based authentication mechanism ornull
if unused.- Returns:
- "BASIC" in case of browser based basic authentication, "FORM" in case of form based authentication or the alternative mechanism or
null
if unused.
-
getConfigBrowserBasedAuthentication
public java.lang.String getConfigBrowserBasedAuthentication()
Returns the browser based authentication text for the configuration.- Returns:
- the browser based authentication text for the configuration
-
getFormBasedHttpAuthenticationUri
public java.lang.String getFormBasedHttpAuthenticationUri()
Returns the URI of the system wide login form if browser-based HTTP basic authentication is disabled.- Returns:
- the URI of the system wide login form if browser-based HTTP basic authentication is disabled
-
setFormBasedHttpAuthenticationUri
public void setFormBasedHttpAuthenticationUri(java.lang.String uri)
Sets the URI of the system wide login form if browser-based HTTP basic authentication is disabled.- Parameters:
uri
- the URI of the system wide login form if browser-based HTTP basic authentication is disabled to set
-
setUseBrowserBasedHttpAuthentication
public void setUseBrowserBasedHttpAuthentication(boolean value)
Sets if browser-based HTTP basic authentication is enabled or disabled.- Parameters:
value
- a boolean value to specifiy if browser-based HTTP basic authentication should be enabled
-
setUseBrowserBasedHttpAuthentication
public void setUseBrowserBasedHttpAuthentication(java.lang.String value)
Sets if browser-based HTTP basic authentication is enabled or disabled.- Parameters:
value
- a string {"true"
|"false"
} to specify if browser-based HTTP basic authentication should be enabled; if another string is provided, the flag for browser based basic authentication is disabled and the value is stored as authentication mechanism.
-
useBrowserBasedHttpAuthentication
public boolean useBrowserBasedHttpAuthentication()
Tests if browser-based HTTP basic authentication is enabled or disabled.- Returns:
- true if browser-based HTTP basic authentication is enabled
-
-