org.opencms.db
Class CmsDbContext

java.lang.Object
  org.opencms.db.CmsDbContext

public class CmsDbContext
extends Object

Warps context information to access the OpenCms database.

Since:

6.0.0

Version:

$Revision: 1.14 $

Author:

Alexander Kandzior

Field Summary

protected CmsFlexRequestContextInfo	m_flexRequestContextInfo The current Flex request context info (if available).
protected CmsRequestContext	m_requestContext The wrapped user request context.

Constructor Summary

CmsDbContext()
Creates a new, empty database context.

CmsDbContext(CmsRequestContext context)
Creates a new database context initialized with the given user request context.

Method Summary

void	clear() Clears this database context.
CmsProject	currentProject() Returns the current users project.
CmsUser	currentUser() Returns the current user.
CmsFlexRequestContextInfo	getFlexRequestContextInfo() Returns the current Flex request context info.
CmsRequestContext	getRequestContext() Returns the request context.
boolean	isDefaultDbContext() Returns true if the database context uses the default implementation.
void	pop() Processes the current database context.
String	removeSiteRoot(String resourcename) Removes the current site root prefix from the absolute path in the resource name, that is adjusts the resource name for the current site root.
void	report(I_CmsReport report, CmsMessageContainer message, Throwable throwable) Reports an error to the given report (if available) and to the OpenCms log file.

Methods inherited from class java.lang.Object

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

Field Detail

m_flexRequestContextInfo

protected CmsFlexRequestContextInfo m_flexRequestContextInfo

The current Flex request context info (if available).

m_requestContext

protected CmsRequestContext m_requestContext

The wrapped user request context.

Constructor Detail

CmsDbContext

public CmsDbContext()

Creates a new, empty database context.

CmsDbContext

public CmsDbContext(CmsRequestContext context)

Creates a new database context initialized with the given user request context.

Parameters:

context - the current users request context

Method Detail

clear

public void clear()

Clears this database context.

currentProject

public CmsProject currentProject()

Returns the current users project.

Returns:

the current users project

currentUser

public CmsUser currentUser()

Returns the current user.

Returns:

the current user

getFlexRequestContextInfo

public CmsFlexRequestContextInfo getFlexRequestContextInfo()

Returns the current Flex request context info.

Returns:

the current Flex request context info

getRequestContext

public CmsRequestContext getRequestContext()

Returns the request context.

Returns:

the request context

isDefaultDbContext

public boolean isDefaultDbContext()

Returns true if the database context uses the default implementation.

Returns:

true if the database context uses the default implementation

pop

public void pop()
         throws CmsException

Processes the current database context.

Throws:

CmsException - if something goes wrong

removeSiteRoot

public String removeSiteRoot(String resourcename)

Removes the current site root prefix from the absolute path in the resource name, that is adjusts the resource name for the current site root.

If no user request context is available, the given resource name is returned unchanged.

Parameters:

resourcename - the resource name

Returns:

the resource name adjusted for the current site root

report

public void report(I_CmsReport report,
                   CmsMessageContainer message,
                   Throwable throwable)
            throws CmsVfsException,
                   CmsException

Reports an error to the given report (if available) and to the OpenCms log file.

Parameters:

report - the report to write the error to

message - the message to write to the report / log

throwable - the exception to write to the report / log

Throws:

CmsException - if the throwable parameter is not null and a CmsException

CmsVfsException - if the throwable parameter is not null and no CmsException