org.opencms.main
Class CmsHttpAuthenticationSettings

java.lang.Object
  extended byorg.opencms.main.CmsHttpAuthenticationSettings

public class CmsHttpAuthenticationSettings
extends java.lang.Object

Contains the settings to handle HTTP basic authentication.

These settings control wheter a browser-based popup 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
Version:
$Revision: 1.7 $
Author:
Thomas Weckert

Field Summary
static java.lang.String DEFAULT_AUTHENTICATION_URI
          The URI of the default authentication form.
 
Constructor Summary
CmsHttpAuthenticationSettings()
          Default constructor.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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

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

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