Package org.opencms.ade.upload

Class CmsDefaultUploadRestriction

java.lang.Object

org.opencms.ade.upload.CmsDefaultUploadRestriction

All Implemented Interfaces:

I_CmsUploadRestriction, I_CmsConfigurationParameterHandler, I_CmsNeedsAdminCmsObject

public class CmsDefaultUploadRestriction
extends Object
implements I_CmsUploadRestriction

Default implementation for upload restrictions uses restriction entries from opencms-workplace.xml.

This class directly takes parameters configured via param elements in opencms-workplace.xml and interprets them as restriction entries. The parameter name is interpreted as the path, and the parameter value

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_UPLOAD_EXTENSIONS	Sitemap attribute to control the allowed upload extensions.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsDefaultUploadRestriction()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
CmsUploadRestrictionInfo	getUploadRestrictionInfo(CmsObject cms)	Gets the upload restriction information for the given CMS context
void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	setAdminCmsObject(CmsObject adminCms)	Sets the admin CmsObject.
static I_CmsUploadRestriction	unrestricted()	Utility method for creating an upload restriction that doesn't restrict anything.

Methods inherited from class java.lang.Object

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

Field Details

ATTR_UPLOAD_EXTENSIONS

public static final String ATTR_UPLOAD_EXTENSIONS

Sitemap attribute to control the allowed upload extensions.

See Also:

• Constant Field Values

Constructor Details

CmsDefaultUploadRestriction

public CmsDefaultUploadRestriction()

Creates a new instance.

Method Details

unrestricted

public static I_CmsUploadRestriction unrestricted()

Utility method for creating an upload restriction that doesn't restrict anything.

Returns:

the unrestricted upload restriction

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getUploadRestrictionInfo

public CmsUploadRestrictionInfo getUploadRestrictionInfo(CmsObject cms)

Description copied from interface: I_CmsUploadRestriction

Gets the upload restriction information for the given CMS context

Specified by:

getUploadRestrictionInfo in interface I_CmsUploadRestriction

Parameters:

cms - the CMS context

Returns:

the upload restriction information

See Also:

• I_CmsUploadRestriction.getUploadRestrictionInfo(org.opencms.file.CmsObject)

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

setAdminCmsObject

public void setAdminCmsObject(CmsObject adminCms)

Description copied from interface: I_CmsNeedsAdminCmsObject

Sets the admin CmsObject.

Specified by:

setAdminCmsObject in interface I_CmsNeedsAdminCmsObject

Parameters:

adminCms - a CmsObject with admin privileges

See Also:

• I_CmsNeedsAdminCmsObject.setAdminCmsObject(org.opencms.file.CmsObject)