org.eclipse.rap.rwt.service.ApplicationContext Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2011, 2012 EclipseSource and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* EclipseSource - initial API and implementation
******************************************************************************/
package org.eclipse.rap.rwt.service;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.application.ApplicationRunner;
/**
* An application context represents a running instance of a RAP application. This context is shared
* by all users who access this application. The current application context can be acquired by
* {@link RWT#getApplicationContext()}. It can be used to store any data that is shared between all
* UI sessions of an application, and to acquire application-scoped instances of framework services
* such as the resource manager.
*
* The application context is bound to the servlet context of the hosting web application. It is
* destroyed when the web application ends (i.e. the servlet context is destroyed) or when the
* application is explicitly stopped by calling {@link ApplicationRunner#stop()}.
*
*
* The application context is thread safe, it can be accessed concurrently from different
* threads.
*
*
* @see org.eclipse.rap.rwt.RWT
* @since 2.0
* @noimplement This interface is not intended to be implemented by clients.
*/
@SuppressWarnings( "deprecation" )
public interface ApplicationContext extends IApplicationStore {
/**
* Stores the given value in this application context, associated with the given name. If another
* value has already been stored with the given name, the old value is overwritten.
*
* @param name the name to associate the value with
* @param value the object to be stored
*/
void setAttribute( String name, Object value );
/**
* Returns the value which is stored under the given name in this application context.
*
* @param name the name whose associated value is requested
* @return the object that is stored, or null if no object has been stored by that
* name
*/
Object getAttribute( String name );
/**
* Removes the object which is stored under the given name in this application context. If no
* value object was stored under the given name, this method does nothing.
*/
void removeAttribute( String name );
/**
* Returns the instance of the resource manager for this application context. The resource manager
* is used to register static resources such as images of JavaScript files.
*
* @return the resource manager for this application context
* @see ResourceManager
*/
ResourceManager getResourceManager();
/**
* Returns the instance of the service manager for this application context. The service manager
* is used to register and unregister service handlers.
*
* @return the service manager instance for this application context
* @see ServiceManager
* @see ServiceHandler
*/
ServiceManager getServiceManager();
}