Package org.opencms.repository

Class CmsRepositorySession

java.lang.Object

org.opencms.repository.A_CmsRepositorySession

org.opencms.repository.CmsRepositorySession

All Implemented Interfaces:

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.

Since:

6.5.6

See Also:

• A_CmsRepositorySession
• I_CmsRepositorySession

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTERNAL_PREFIX	Prefix used for encoded property names outside the default property namespace.
static final String	PROPERTY_NAMESPACE	Default namespace for OpenCms properties.

Constructor Summary

Constructors

Constructor	Description
CmsRepositorySession(CmsObjectWrapper cms, CmsRepositoryFilter filter, CmsResourceTranslator translation)	Constructor with an initialized CmsObjectWrapper and a CmsRepositoryFilter to use.

Method Summary

Modifier and Type	Method	Description
void	copy(String src, String dest, boolean overwrite, boolean shallow)	Copies the item found at the source path to the destination path.
void	create(String path)	Creates a new item at the given path.
static String	decodeNamespace(String code)	Decodes the namespace URI.
void	delete(String path)	Deletes the item at the given path.
static String	encodeNamespace(String data)	Encodes the namespace URI.
boolean	exists(String path)	Returns if an item exists at the given path.
I_CmsRepositoryItem	getItem(String path)	Returns the item found at the given path.
CmsRepositoryLockInfo	getLock(String path)	Returns the lock for the resource at the given path.
Map<CmsPropertyName,String>	getProperties(String path)	Gets the properties for the given path.
protected boolean	isFiltered(String name)	Adds the site root to the path name and checks then if the path is filtered.
List<I_CmsRepositoryItem>	list(String path)	Returns a list with all items found directly in the given path.
boolean	lock(String path, CmsRepositoryLockInfo lock)	Creates a new lock on the item at the path with the given information in the lock info.
void	move(String src, String dest, boolean overwrite)	Moves an item from a source path to a destination path.
void	save(String path, InputStream inputStream, boolean overwrite)	Saves an item at the given path.
void	unlock(String path)	Unlocks the item found at the path.
void	updateProperties(String path, Map<CmsPropertyName,String> properties)	Updates the properties for the given path.

Methods inherited from class org.opencms.repository.A_CmsRepositorySession

getFilter, setFilter

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_NAMESPACE

public static final String PROPERTY_NAMESPACE

Default namespace for OpenCms properties.

See Also:

• Constant Field Values

EXTERNAL_PREFIX

public static final String EXTERNAL_PREFIX

Prefix used for encoded property names outside the default property namespace.

See Also:

• Constant Field Values

Constructor Details

CmsRepositorySession

public CmsRepositorySession(CmsObjectWrapper cms,
 CmsRepositoryFilter filter,
 CmsResourceTranslator translation)

Constructor with an initialized CmsObjectWrapper and a CmsRepositoryFilter to use.

Parameters:

cms - the initialized CmsObject

filter - the repository filter to use

translation - the repository specific file translations (may be null)

Method Details

decodeNamespace

public static String decodeNamespace(String code)
                              throws Exception

Decodes the namespace URI.

Parameters:

code - the encoded namespace URI

Returns:

the decoded namespace URI

Throws:

Exception - if something goes wrong

encodeNamespace

public static String encodeNamespace(String data)
                              throws Exception

Encodes the namespace URI.

Parameters:

data - a namesapce URI

Returns:

the encoded namespace URI

Throws:

Exception - if something goes wrong

copy

public void copy(String src,
 String dest,
 boolean overwrite,
 boolean shallow)
          throws CmsException

Description copied from interface: I_CmsRepositorySession

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

Parameters:

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

shallow - if true, when copying a folder, only the folder will be copied and not its contents

Throws:

CmsException - if something goes wrong

See Also:

• invalid reference

  org.opencms.repository.I_CmsRepositorySession#copy(java.lang.String, java.lang.String, boolean)

create

public void create(String path)
            throws CmsException

Description copied from interface: I_CmsRepositorySession

Creates a new item at the given path.

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

Parameters:

path - the complete path of the new collection

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsRepositorySession.create(java.lang.String)

delete

public void delete(String path)
            throws CmsException

Description copied from interface: I_CmsRepositorySession

Deletes the item at the given path.

Parameters:

path - the complete path of the item to delete

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsRepositorySession.delete(java.lang.String)

exists

public boolean exists(String path)

Description copied from interface: I_CmsRepositorySession

Returns if an item exists at the given path.

Parameters:

path - the complete path of the item to check existance

Returns:

true if the item exists otherwise false

See Also:

• I_CmsRepositorySession.exists(java.lang.String)

getItem

public I_CmsRepositoryItem getItem(String path)
                            throws CmsException

Description copied from interface: I_CmsRepositorySession

Returns the item found at the given path.

Parameters:

path - the complete path of the item to return

Returns:

the item found at the path

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsRepositorySession.getItem(java.lang.String)

getLock

public CmsRepositoryLockInfo getLock(String path)

Description copied from interface: I_CmsRepositorySession

Returns the lock for the resource at the given path.

Parameters:

path - the complete path where to return the lock for

Returns:

the found lock as CmsWebdavLockInfo or null if not found

See Also:

• I_CmsRepositorySession.getLock(java.lang.String)

getProperties

public Map<CmsPropertyName,String> getProperties(String path)
                                          throws CmsException

Description copied from interface: I_CmsRepositorySession

Gets the properties for the given path.

Parameters:

path - the path

Returns:

the properties for the path

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsRepositorySession.getProperties(java.lang.String)

list

public List<I_CmsRepositoryItem> list(String path)
                               throws CmsException

Description copied from interface: I_CmsRepositorySession

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

Parameters:

path - the complete path from which to return the items

Returns:

a list with I_CmsRepositoryItem found in the path

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsRepositorySession.list(java.lang.String)

lock

public boolean lock(String path,
 CmsRepositoryLockInfo lock)
             throws CmsException

Description copied from interface: I_CmsRepositorySession

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

Parameters:

path - the complete path of the item

lock - the information about the lock to create

Returns:

if the lock was successfully

Throws:

CmsException - if something goes wrong

See Also:

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

move

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

Description copied from interface: I_CmsRepositorySession

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

Parameters:

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

Throws:

CmsException - if something goes wrong

See Also:

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

save

public void save(String path,
 InputStream inputStream,
 boolean overwrite)
          throws CmsException,
IOException

Description copied from interface: I_CmsRepositorySession

Saves an item at the given path.

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

Parameters:

path - the complete path of the new item

inputStream - the content of the item

overwrite - should an existing item at the path be overwritten

Throws:

CmsException - if something goes wrong

IOException - if a write error occurs

See Also:

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

unlock

public void unlock(String path)

Description copied from interface: I_CmsRepositorySession

Unlocks the item found at the path.

Parameters:

path - The complete path of the item to unlock

See Also:

• I_CmsRepositorySession.unlock(java.lang.String)

updateProperties

public void updateProperties(String path,
 Map<CmsPropertyName,String> properties)
                      throws CmsException

Description copied from interface: I_CmsRepositorySession

Updates the properties for the given path.

Parameters:

path - the path

properties - the properties

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsRepositorySession.updateProperties(java.lang.String, java.util.Map)

isFiltered

protected boolean isFiltered(String name)

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

Overrides:

isFiltered in class A_CmsRepositorySession

Parameters:

name - the path of a resource to check

Returns:

true if the name matches one of the given filter patterns

See Also:

• A_CmsRepositorySession.isFiltered(java.lang.String)