org.opencms.file.wrapper

类 CmsResourceWrapperPreventCreateNameCI

java.lang.Object

org.opencms.file.wrapper.A_CmsResourceWrapper

org.opencms.file.wrapper.CmsResourceWrapperPreventCreateNameCI

所有已实现的接口:

I_CmsResourceWrapper

public class CmsResourceWrapperPreventCreateNameCI
extends A_CmsResourceWrapper

Resource wrapper class which is used to prevent resources with a certain name from being created.

This can be used to prevent file browsers accessing the repository from creating thumbnail files. This class does not distinguish between upper case and lower case letters in file names.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	NAME_SEPARATOR File name separator.

从类继承的字段 org.opencms.file.wrapper.A_CmsResourceWrapper

m_isWrappedResource

构造器概要

构造器

构造器和说明
CmsResourceWrapperPreventCreateNameCI()

方法概要

方法

限定符和类型	方法和说明
void	configure(java.lang.String configString) If there is a configuration string for the wrapper, this method will be called with the configuration string before it is used.
CmsResource	createResource(CmsObject cms, java.lang.String resourcepath, int type, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
boolean	isWrappedResource(CmsObject cms, CmsResource res) Is called to check if the given resource is handled by this wrapper.
boolean	moveResource(CmsObject cms, java.lang.String source, java.lang.String destination) Moves a resource to the given destination.

从类继承的方法 org.opencms.file.wrapper.A_CmsResourceWrapper

addResourcesToFolder, copyResource, deleteResource, getLock, lockResource, readFile, readResource, restoreLink, rewriteLink, unlockResource, wrapResource, writeFile

从类继承的方法 java.lang.Object

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

字段详细资料

NAME_SEPARATOR

public static final java.lang.String NAME_SEPARATOR

File name separator.

另请参阅:

常量字段值

构造器详细资料

CmsResourceWrapperPreventCreateNameCI

public CmsResourceWrapperPreventCreateNameCI()

方法详细资料

configure

public void configure(java.lang.String configString)

从接口复制的说明: I_CmsResourceWrapper

If there is a configuration string for the wrapper, this method will be called with the configuration string before it is used.

Otherwise, it will not be called.

指定者:

configure 在接口中 I_CmsResourceWrapper

覆盖:

configure 在类中 A_CmsResourceWrapper

参数:

configString - the configuration string for the wrapper

另请参阅:

A_CmsResourceWrapper.configure(java.lang.String)

createResource

public CmsResource createResource(CmsObject cms,
                         java.lang.String resourcepath,
                         int type,
                         byte[] content,
                         java.util.List<CmsProperty> properties)
                           throws CmsException,
                                  CmsIllegalArgumentException

从接口复制的说明: I_CmsResourceWrapper

Creates a new resource of the given resource type with the provided content and properties.

First should be a check if the resourcename is handled by this resource wrapper.

It is possible that the path in the resourcename is a virtual path and so has to be translated into a valid path existing in the VFS to create the resource.

指定者:

createResource 在接口中 I_CmsResourceWrapper

覆盖:

createResource 在类中 A_CmsResourceWrapper

参数:

cms - the initialized CmsObject

resourcepath - the name of the resource to create (full path)

type - the type of the resource to create

content - the content for the new resource

properties - the properties for the new resource

返回:

the created resource or null if not handled by this resource wrapper

抛出:

CmsException - if something goes wrong

CmsIllegalArgumentException - if the source argument is null or of length 0

另请参阅:

A_CmsResourceWrapper.createResource(org.opencms.file.CmsObject, java.lang.String, int, byte[], java.util.List)

isWrappedResource

public boolean isWrappedResource(CmsObject cms,
                        CmsResource res)

从接口复制的说明: I_CmsResourceWrapper

Is called to check if the given resource is handled by this wrapper.

参数:

cms - the initialized CmsObject

res - the resource to check

返回:

true if the resource will be handled by the wrapper otherwise false

另请参阅:

I_CmsResourceWrapper.isWrappedResource(org.opencms.file.CmsObject, org.opencms.file.CmsResource)

moveResource

public boolean moveResource(CmsObject cms,
                   java.lang.String source,
                   java.lang.String destination)
                     throws CmsException,
                            CmsIllegalArgumentException

从接口复制的说明: I_CmsResourceWrapper

Moves a resource to the given destination.

First should be a check if the source and/or the destination are handled by this resource wrapper.

It is possible that the path in the source or in the destination are virtual paths and so has to be translated into valid paths existing in the VFS to move the resource.

指定者:

moveResource 在接口中 I_CmsResourceWrapper

覆盖:

moveResource 在类中 A_CmsResourceWrapper

参数:

cms - the current cms context

source - the name of the resource to move

destination - the destination resource name

返回:

true if the move action was handled by this resource wrapper otherwise false

抛出:

CmsException - if something goes wrong

CmsIllegalArgumentException - if the source argument is null or of length 0

另请参阅:

A_CmsResourceWrapper.moveResource(org.opencms.file.CmsObject, java.lang.String, java.lang.String)