info.magnolia.context
Interface Context

All Superinterfaces:
Context, Map
All Known Subinterfaces:
SystemContext, ThreadDependentSystemContext, UserContext, WebContext
All Known Implementing Classes:
AbstractSystemContext, JCRSessionPerThreadSystemContext, SingleJCRSessionSystemContext, UserContextImpl, WebContextImpl

public interface Context
extends Context

This interface defines all the methods which should be implemented by any configured magnolia context. Implementing class should never be accessible directly but only via MgnlContext static methods which work on a local (Thread) copy of the implementation.

Version:
$Revision $ ($Author $)
Author:
Sameer Charles

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
static int APPLICATION_SCOPE
          Attribute visibility scope, its visible to all sessions of this application.
static String ATTRIBUTE_COMMENT
           
static String ATTRIBUTE_EXCEPTION
           
static String ATTRIBUTE_MESSAGE
           
static String ATTRIBUTE_PATH
           
static String ATTRIBUTE_RECURSIVE
           
static String ATTRIBUTE_REPOSITORY
           
static String ATTRIBUTE_UUID
           
static String ATTRIBUTE_VERSION
           
static String ATTRIBUTE_VERSION_MAP
           
static int LOCAL_SCOPE
          Attribute visibility scope.
static int SESSION_SCOPE
          Attribute visibility scope Shared by all requests from this session.
 
Method Summary
 AccessManager getAccessManager(String name)
          Get a an AccessManager for logical entities.
<T> T
getAttribute(String name)
          Get attribute value without passing a scope.
<T> T
getAttribute(String name, int scope)
          Get attribute value.
 Map<String,Object> getAttributes()
          Get an over all map.
 Map<String,Object> getAttributes(int scope)
          Get a map of a attributes set in the scope.
 HierarchyManager getHierarchyManager(String workspaceName)
          Deprecated. since 4.5 - use getJCRSession(String)
 javax.jcr.Session getJCRSession(String workspaceName)
           
 Locale getLocale()
          Get the current locale.
 Messages getMessages()
          Get the default messages.
 Messages getMessages(String basename)
          Get the messages of the named bundle.
 QueryManager getQueryManager(String workspaceName)
          Deprecated. since 4.5 - use getJCRSession(String) and acquire the JCR query manager directly from the session.
 Subject getSubject()
           
 User getUser()
          If this is not a UserContext this method will very likely return the system user.
 void release()
          Release any resource used by this Context (e.g.
 void removeAttribute(String name, int scope)
          Remove an attribute.
 void setAttribute(String name, Object value, int scope)
          Set attribute value, scope of the attribute is defined.
 void setLocale(Locale locale)
           
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

LOCAL_SCOPE

static final int LOCAL_SCOPE
Attribute visibility scope.

See Also:
Constant Field Values

SESSION_SCOPE

static final int SESSION_SCOPE
Attribute visibility scope Shared by all requests from this session.

See Also:
Constant Field Values

APPLICATION_SCOPE

static final int APPLICATION_SCOPE
Attribute visibility scope, its visible to all sessions of this application.

See Also:
Constant Field Values

ATTRIBUTE_REPOSITORY

static final String ATTRIBUTE_REPOSITORY
See Also:
Constant Field Values

ATTRIBUTE_PATH

static final String ATTRIBUTE_PATH
See Also:
Constant Field Values

ATTRIBUTE_VERSION

static final String ATTRIBUTE_VERSION
See Also:
Constant Field Values

ATTRIBUTE_VERSION_MAP

static final String ATTRIBUTE_VERSION_MAP
See Also:
Constant Field Values

ATTRIBUTE_UUID

static final String ATTRIBUTE_UUID
See Also:
Constant Field Values

ATTRIBUTE_RECURSIVE

static final String ATTRIBUTE_RECURSIVE
See Also:
Constant Field Values

ATTRIBUTE_COMMENT

static final String ATTRIBUTE_COMMENT
See Also:
Constant Field Values

ATTRIBUTE_MESSAGE

static final String ATTRIBUTE_MESSAGE
See Also:
Constant Field Values

ATTRIBUTE_EXCEPTION

static final String ATTRIBUTE_EXCEPTION
See Also:
Constant Field Values
Method Detail

getUser

User getUser()
If this is not a UserContext this method will very likely return the system user.


getSubject

Subject getSubject()

setLocale

void setLocale(Locale locale)
Parameters:
locale -

getLocale

Locale getLocale()
Get the current locale.


getJCRSession

javax.jcr.Session getJCRSession(String workspaceName)
                                throws javax.jcr.LoginException,
                                       javax.jcr.RepositoryException
Throws:
javax.jcr.LoginException
javax.jcr.RepositoryException

getHierarchyManager

@Deprecated
HierarchyManager getHierarchyManager(String workspaceName)
Deprecated. since 4.5 - use getJCRSession(String)

Get hierarchy manager initialized for this user.

Parameters:
workspaceName -
Returns:
hierarchy manager

getAccessManager

AccessManager getAccessManager(String name)
Get a an AccessManager for logical entities. The accesses to the repository are handled by the repository itself.


getQueryManager

@Deprecated
QueryManager getQueryManager(String workspaceName)
Deprecated. since 4.5 - use getJCRSession(String) and acquire the JCR query manager directly from the session.

Get QueryManager created for this user on the specified repository.


setAttribute

void setAttribute(String name,
                  Object value,
                  int scope)
Set attribute value, scope of the attribute is defined.

Parameters:
name - is used as a key
scope - , highest level of scope from which this attribute is visible

getAttribute

<T> T getAttribute(String name,
                   int scope)
Get attribute value.

Parameters:
name - to which value is associated to
scope - the scope (request, session, application)
Returns:
attribute value

getAttribute

<T> T getAttribute(String name)
Get attribute value without passing a scope. the scopes are searched from bottom up (request, session, application)

Parameters:
name - to which value is associated to
Returns:
attribute value

getAttributes

Map<String,Object> getAttributes(int scope)
Get a map of a attributes set in the scope.

Parameters:
scope -
Returns:
the map

removeAttribute

void removeAttribute(String name,
                     int scope)
Remove an attribute.

Parameters:
name -
scope -

getAttributes

Map<String,Object> getAttributes()
Get an over all map.

Returns:
the map

getMessages

Messages getMessages()
Get the default messages. It uses the locale set on this context TODO: This duplicates methods from MessagesManager : remove either


getMessages

Messages getMessages(String basename)
Get the messages of the named bundle. It uses the locale set on this context

Parameters:
basename - name of the bundle TODO: This duplicates methods from MessagesManager : remove either

release

void release()
Release any resource used by this Context (e.g. jcr sessions).



Copyright © 2003-2013 Magnolia International Ltd.. All Rights Reserved.