org.opencms.repository

类 A_CmsRepository

java.lang.Object

org.opencms.repository.A_CmsRepository

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsRepository

直接已知子类:

CmsRepository

public abstract class A_CmsRepository
extends java.lang.Object
implements I_CmsRepository

Abstract implementation of the repository interface I_CmsRepository.

Get a I_CmsRepositorySession through login in with the username and password (login(String, String)).

Handles the functionality of basic configuration. This is actually the configuration of param/values and the filters (CmsRepositoryFilter) to use of the repository.

从以下版本开始:

6.2.4

字段概要

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

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
A_CmsRepository() Default constructor initializing member variables.

方法概要

方法

限定符和类型	方法和说明
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration() Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
CmsRepositoryFilter	getFilter() Returns the filter.
java.lang.String	getName() Returns the name of the repository.
void	initConfiguration() Initializes a configuration after all parameters have been added.
abstract I_CmsRepositorySession	login(java.lang.String userName, java.lang.String password) Login a user given the username and the password.
void	setFilter(CmsRepositoryFilter filter) Sets the filter.
void	setName(java.lang.String name) Sets the name for this repository.

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

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

从接口继承的方法 org.opencms.repository.I_CmsRepository

initializeCms

构造器详细资料

A_CmsRepository

public A_CmsRepository()

Default constructor initializing member variables.

方法详细资料

addConfigurationParameter

public void addConfigurationParameter(java.lang.String paramName,
                             java.lang.String paramValue)

从接口复制的说明: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

指定者:

addConfigurationParameter 在接口中 I_CmsConfigurationParameterHandler

参数:

paramName - the name of the parameter

paramValue - the value for the parameter

另请参阅:

I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

指定者:

getConfiguration 在接口中 I_CmsConfigurationParameterHandler

返回:

the parameters of this configurable class instance, or null if the class does not need any parameters

另请参阅:

I_CmsConfigurationParameterHandler.getConfiguration()

getFilter

public CmsRepositoryFilter getFilter()

Returns the filter.

指定者:

getFilter 在接口中 I_CmsRepository

返回:

the filter

getName

public java.lang.String getName()

从接口复制的说明: I_CmsRepository

Returns the name of the repository.

指定者:

getName 在接口中 I_CmsRepository

返回:

the name of the repository

另请参阅:

I_CmsRepository.getName()

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

抛出:

CmsConfigurationException - if something goes wrong

另请参阅:

I_CmsConfigurationParameterHandler.initConfiguration()

login

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

Login a user given the username and the password.

参数:

userName - the user name

password - the user's password

返回:

the authenticated session

抛出:

CmsException - if the login was not succesful

setFilter

public void setFilter(CmsRepositoryFilter filter)

Sets the filter.

指定者:

setFilter 在接口中 I_CmsRepository

参数:

filter - the filter to set

setName

public void setName(java.lang.String name)

从接口复制的说明: I_CmsRepository

Sets the name for this repository.

指定者:

setName 在接口中 I_CmsRepository

参数:

name - the name to use for the repository

另请参阅:

I_CmsRepository.setName(String)