org.opencms.repository

类 CmsRepositorySession

java.lang.Object

org.opencms.repository.A_CmsRepositorySession

org.opencms.repository.CmsRepositorySession

所有已实现的接口:

I_CmsRepositorySession

public class CmsRepositorySession
extends A_CmsRepositorySession

This is the session class to work with the CmsRepository.

You can get an instance of this class by calling CmsRepository.login(String, String).

This class provides basic file and folder operations on the resources in the VFS of OpenCms.

从以下版本开始:

6.5.6

另请参阅:

A_CmsRepositorySession, I_CmsRepositorySession

构造器概要

构造器

构造器和说明
CmsRepositorySession(CmsObjectWrapper cms, CmsRepositoryFilter filter) Constructor with an initialized CmsObjectWrapper and a CmsRepositoryFilter to use.

方法概要

方法

限定符和类型	方法和说明
void	copy(java.lang.String src, java.lang.String dest, boolean overwrite) Copies the item found at the source path to the destination path.
void	create(java.lang.String path) Creates a new item at the given path.
void	delete(java.lang.String path) Deletes the item at the given path.
boolean	exists(java.lang.String path) Returns if an item exists at the given path.
I_CmsRepositoryItem	getItem(java.lang.String path) Returns the item found at the given path.
CmsRepositoryLockInfo	getLock(java.lang.String path) Returns the lock for the resource at the given path.
protected boolean	isFiltered(java.lang.String name) Adds the site root to the path name and checks then if the path is filtered.
java.util.List<I_CmsRepositoryItem>	list(java.lang.String path) Returns a list with all items found directly in the given path.
boolean	lock(java.lang.String path, CmsRepositoryLockInfo lock) Creates a new lock on the item at the path with the given information in the lock info.
void	move(java.lang.String src, java.lang.String dest, boolean overwrite) Moves an item from a source path to a destination path.
void	save(java.lang.String path, java.io.InputStream inputStream, boolean overwrite) Saves an item at the given path.
void	unlock(java.lang.String path) Unlocks the item found at the path.

从类继承的方法 org.opencms.repository.A_CmsRepositorySession

getFilter, setFilter

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

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

构造器详细资料

CmsRepositorySession

public CmsRepositorySession(CmsObjectWrapper cms,
                    CmsRepositoryFilter filter)

Constructor with an initialized CmsObjectWrapper and a CmsRepositoryFilter to use.

参数:

cms - the initialized CmsObject

filter - the repository filter to use

方法详细资料

copy

public void copy(java.lang.String src,
        java.lang.String dest,
        boolean overwrite)
          throws CmsException

从接口复制的说明: I_CmsRepositorySession

Copies the item found at the source path to the destination path.

参数:

src - the path of the item which should be copied

dest - the destination path where to copy to

overwrite - should any existing item be overwritten

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsRepositorySession.copy(java.lang.String, java.lang.String, boolean)

create

public void create(java.lang.String path)
            throws CmsException

从接口复制的说明: I_CmsRepositorySession

Creates a new item at the given path.

In this case this should be a collection (directory).

参数:

path - the complete path of the new collection

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsRepositorySession.create(java.lang.String)

delete

public void delete(java.lang.String path)
            throws CmsException

从接口复制的说明: I_CmsRepositorySession

Deletes the item at the given path.

参数:

path - the complete path of the item to delete

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsRepositorySession.delete(java.lang.String)

exists

public boolean exists(java.lang.String path)

从接口复制的说明: I_CmsRepositorySession

Returns if an item exists at the given path.

参数:

path - the complete path of the item to check existance

返回:

true if the item exists otherwise false

另请参阅:

I_CmsRepositorySession.exists(java.lang.String)

getItem

public I_CmsRepositoryItem getItem(java.lang.String path)
                            throws CmsException

从接口复制的说明: I_CmsRepositorySession

Returns the item found at the given path.

参数:

path - the complete path of the item to return

返回:

the item found at the path

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsRepositorySession.getItem(java.lang.String)

getLock

public CmsRepositoryLockInfo getLock(java.lang.String path)

从接口复制的说明: I_CmsRepositorySession

Returns the lock for the resource at the given path.

参数:

path - the complete path where to return the lock for

返回:

the found lock as CmsWebdavLockInfo or null if not found

另请参阅:

I_CmsRepositorySession.getLock(java.lang.String)

list

public java.util.List<I_CmsRepositoryItem> list(java.lang.String path)
                                         throws CmsException

从接口复制的说明: I_CmsRepositorySession

Returns a list with all items found directly in the given path.

参数:

path - the complete path from which to return the items

返回:

a list with I_CmsRepositoryItem found in the path

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsRepositorySession.list(java.lang.String)

lock

public boolean lock(java.lang.String path,
           CmsRepositoryLockInfo lock)
             throws CmsException

从接口复制的说明: I_CmsRepositorySession

Creates a new lock on the item at the path with the given information in the lock info.

参数:

path - the complete path of the item

lock - the information about the lock to create

返回:

if the lock was successfully

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsRepositorySession.lock(java.lang.String, org.opencms.repository.CmsRepositoryLockInfo)

move

public void move(java.lang.String src,
        java.lang.String dest,
        boolean overwrite)
          throws CmsException

从接口复制的说明: I_CmsRepositorySession

Moves an item from a source path to a destination path.

参数:

src - the complete path to the item which should be copied

dest - the complete destination path where to copy to

overwrite - should any existing item should be overwritten

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsRepositorySession.move(java.lang.String, java.lang.String, boolean)

save

public void save(java.lang.String path,
        java.io.InputStream inputStream,
        boolean overwrite)
          throws CmsException,
                 java.io.IOException

从接口复制的说明: I_CmsRepositorySession

Saves an item at the given path.

This creates a new single item (file) if it does not exist.

参数:

path - the complete path of the new item

inputStream - the content of the item

overwrite - should an existing item at the path be overwritten

抛出:

CmsException - if something goes wrong

java.io.IOException - if a write error occurs

另请参阅:

I_CmsRepositorySession.save(java.lang.String, java.io.InputStream, boolean)

unlock

public void unlock(java.lang.String path)

从接口复制的说明: I_CmsRepositorySession

Unlocks the item found at the path.

参数:

path - The complete path of the item to unlock

另请参阅:

I_CmsRepositorySession.unlock(java.lang.String)

isFiltered

protected boolean isFiltered(java.lang.String name)

Adds the site root to the path name and checks then if the path is filtered.

覆盖:

isFiltered 在类中 A_CmsRepositorySession

参数:

name - the path of a resource to check

返回:

true if the name matches one of the given filter patterns

另请参阅:

A_CmsRepositorySession.isFiltered(java.lang.String)