org.opencms.ugc

Class CmsUgcConfigurationReader

java.lang.Object

org.opencms.ugc.CmsUgcConfigurationReader

public class CmsUgcConfigurationReader
extends java.lang.Object

Parser for form configuration files.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTENSIONS_SEPARATOR The separator used for separating the configured valid file name extensions for uploaded files.
static java.lang.String	N_AUTO_PUBLISH XML content value name.
static java.lang.String	N_CONTENT_PATH XML content value name.
static java.lang.String	N_CONTENT_TYPE XML content value name.
static java.lang.String	N_LOCALE XML content value name.
static java.lang.String	N_MAX_NUM_CONTENTS XML content value name.
static java.lang.String	N_MAX_UPLOAD_SIZE XML content value name.
static java.lang.String	N_NAME_PATTERN XML content value name.
static java.lang.String	N_PROJECT_GROUP XML content value name.
static java.lang.String	N_QUEUE_MAX_LENGTH XML content value name.
static java.lang.String	N_QUEUE_WAIT_TIME XML content value name.
static java.lang.String	N_UPLOAD_PATH XML content value name.
static java.lang.String	N_USER_FOR_GUEST XML content value name.
static java.lang.String	N_VALID_EXTENSIONS XML content value name.

Constructor Summary

Constructors

Constructor and Description
CmsUgcConfigurationReader(CmsObject cms) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
CmsUgcConfiguration	readConfiguration(CmsFile configFile) Reads the given configuration file.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSIONS_SEPARATOR

public static final java.lang.String EXTENSIONS_SEPARATOR

The separator used for separating the configured valid file name extensions for uploaded files.

See Also:

Constant Field Values

N_AUTO_PUBLISH

public static final java.lang.String N_AUTO_PUBLISH

XML content value name.

See Also:

Constant Field Values

N_CONTENT_PATH

public static final java.lang.String N_CONTENT_PATH

XML content value name.

See Also:

Constant Field Values

N_CONTENT_TYPE

public static final java.lang.String N_CONTENT_TYPE

XML content value name.

See Also:

Constant Field Values

N_LOCALE

public static final java.lang.String N_LOCALE

XML content value name.

See Also:

Constant Field Values

N_MAX_NUM_CONTENTS

public static final java.lang.String N_MAX_NUM_CONTENTS

XML content value name.

See Also:

Constant Field Values

N_MAX_UPLOAD_SIZE

public static final java.lang.String N_MAX_UPLOAD_SIZE

XML content value name.

See Also:

Constant Field Values

N_NAME_PATTERN

public static final java.lang.String N_NAME_PATTERN

XML content value name.

See Also:

Constant Field Values

N_PROJECT_GROUP

public static final java.lang.String N_PROJECT_GROUP

XML content value name.

See Also:

Constant Field Values

N_QUEUE_MAX_LENGTH

public static final java.lang.String N_QUEUE_MAX_LENGTH

XML content value name.

See Also:

Constant Field Values

N_QUEUE_WAIT_TIME

public static final java.lang.String N_QUEUE_WAIT_TIME

XML content value name.

See Also:

Constant Field Values

N_UPLOAD_PATH

public static final java.lang.String N_UPLOAD_PATH

XML content value name.

See Also:

Constant Field Values

N_USER_FOR_GUEST

public static final java.lang.String N_USER_FOR_GUEST

XML content value name.

See Also:

Constant Field Values

N_VALID_EXTENSIONS

public static final java.lang.String N_VALID_EXTENSIONS

XML content value name.

See Also:

Constant Field Values

Constructor Detail

CmsUgcConfigurationReader

public CmsUgcConfigurationReader(CmsObject cms)

Creates a new instance.

Parameters:

cms - the CMS context to use

Method Detail

readConfiguration

public CmsUgcConfiguration readConfiguration(CmsFile configFile)
                                      throws CmsException

Reads the given configuration file.

Parameters:

configFile - the configuration file to read

Returns:

the configuration data read from the file

Throws:

CmsException - if something goes wrong