org.opencms.repository

类 CmsRepository

java.lang.Object

org.opencms.repository.A_CmsRepository

org.opencms.repository.CmsRepository

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsRepository

public class CmsRepository
extends A_CmsRepository

Creates a repository session to access OpenCms.

The configuration of the used I_CmsResourceWrapper is done here. This is the main class to get access to the resources in the VFS of OpenCms. The method login(String, String) logs in to OpenCms and returns a CmsRepositorySession to use for basic file and folder operations.

The project and the site to use for the access to OpenCms is read out of the user settings.

从以下版本开始:

6.5.6

另请参阅:

CmsObjectWrapper

字段概要

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
CmsRepository() Empty default constructor.

方法概要

方法

限定符和类型	方法和说明
void	initConfiguration() Initializes a configuration after all parameters have been added.
void	initializeCms(CmsObject cms) Initializes this repository with an admin CMS object.
I_CmsRepositorySession	login(java.lang.String userName, java.lang.String password) Login a user given the username and the password.

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

addConfigurationParameter, getConfiguration, getFilter, getName, setFilter, setName

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

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

构造器详细资料

CmsRepository

public CmsRepository()

Empty default constructor.

方法详细资料

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

覆盖:

initConfiguration 在类中 A_CmsRepository

抛出:

CmsConfigurationException - if something goes wrong

另请参阅:

A_CmsRepository.initConfiguration()

initializeCms

public void initializeCms(CmsObject cms)

从接口复制的说明: I_CmsRepository

Initializes this repository with an admin CMS object.

参数:

cms - an admin CMS object

另请参阅:

I_CmsRepository.initializeCms(org.opencms.file.CmsObject)

login

public I_CmsRepositorySession login(java.lang.String userName,
                           java.lang.String password)
                             throws CmsException

从类复制的说明: A_CmsRepository

Login a user given the username and the password.

指定者:

login 在类中 A_CmsRepository

参数:

userName - the user name

password - the user's password

返回:

the authenticated session

抛出:

CmsException - if the login was not succesful

另请参阅:

A_CmsRepository.login(java.lang.String, java.lang.String)