org.opencms.repository
Interface I_CmsRepository

All Known Implementing Classes:

A_CmsRepository, CmsRepository

public interface I_CmsRepository

Represents the entry point into the repository.

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

Since:

6.2.4

Version:

$Revision: 1.8 $

Author:

Michael Moossen, Peter Bonrad

Method Summary

java.lang.String	getName() Returns the name of the repository.
I_CmsRepositorySession	login(java.lang.String userName, java.lang.String password) Login a user given the username and the password.
void	setName(java.lang.String name) Sets the name for this repository.

Method Detail

getName

java.lang.String getName()

Returns the name of the repository.

Returns:

the name of the repository

login

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

Login a user given the username and the password.

Parameters:

userName - the user name

password - the user's password

Returns:

the authenticated session

Throws:

CmsException - if the login was not succesful

setName

void setName(java.lang.String name)

Sets the name for this repository.

Parameters:

name - the name to use for the repository