org.openbp.server.model.ModelNotificationServiceImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openbp-server Show documentation
The OpenBP process engine (main module)
There is a newer version: 0.9.11
/*
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package org.openbp.server.model;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.openbp.common.CollectionUtil;
import org.openbp.core.model.ModelQualifier;
import org.openbp.core.model.modelmgr.ModelMgr;
import org.openbp.core.model.modelmgr.ModelNotificationObserver;
import org.openbp.core.model.modelmgr.ModelNotificationService;
import org.openbp.core.remote.ClientSession;
import org.openbp.server.remote.ClientSessionMgr;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;

/**
 * This class implements the methods exposed by the {@link ModelNotificationService} interface.
 *
 * @author Heiko Erhardt
 */
@Service("modelNotificationService")
@Qualifier("exportedService")
public class ModelNotificationServiceImpl
	implements ModelNotificationService
{
	/** Notification observers (list of {@link ModelNotificationObserver} objects) */
	private List notificationObservers;

	@Autowired
	private ModelMgr modelMgr;

	/**
	 * Default constructor.
	 */
	public ModelNotificationServiceImpl()
	{
	}

	/**
	 * Adds a model notification observer to the event observer list.
	 *
	 * @param observer Observer
	 */
	public void addModelNotificationObserver(ModelNotificationObserver observer)
	{
		if (notificationObservers == null)
		{
			notificationObservers = new ArrayList();
		}

		if (! notificationObservers.contains(observer))
		{
			notificationObservers.add(observer);
		}
	}

	/**
	 * Removes a model notification observer from the event observer list.
	 *
	 * @param observer Observer
	 */
	public void removeModelNotificationObserver(ModelNotificationObserver observer)
	{
		if (notificationObservers != null)
		{
			notificationObservers.remove(observer);
			if (notificationObservers.size() == 0)
			{
				notificationObservers = null;
			}
		}
	}

	/**
	 * Sets the notification observers (list of {@link ModelNotificationObserver} objects).
	 * For Spring support only.
	 */
	public void setNotificationObservers(List notificationObservers)
	{
		this.notificationObservers = notificationObservers;
	}

	/**
	 * Notification method for model updates.
	 *
	 * @param session A session permitting access
	 * @param qualifier Qualifier of the object that has been updated
	 * @param mode Type of model update ({@link ModelNotificationService#ADDED}/{@link ModelNotificationService#UPDATED}/{@link ModelNotificationService#REMOVED})
	 * @throws InvalidSessionException If the session doesn't permit accessing the model manager
	 * @throws OpenBPException On error
	 */
	public void modelUpdated(ClientSession session, ModelQualifier qualifier, int mode)
	{
		// Will throw an InvalidSessionException on invalid session
		ClientSessionMgr.getInstance().checkSession(session);

		// Delegate to the model mgr
		modelMgr.modelUpdated(qualifier, mode);

		for (Iterator it = CollectionUtil.iterator(notificationObservers); it.hasNext();)
		{
			ModelNotificationObserver observer = (ModelNotificationObserver) it.next();
			observer.modelUpdated(qualifier, mode);
		}
	}

	/**
	 * Resets all models.
	 * Re-initializes the model classloader and the model properties and reinitializes the components of the model.
	 *
	 * @param session A session permitting access
	 * @throws InvalidSessionException If the session doesn't permit accessing the model manager
	 * @throws OpenBPException On error
	 */
	public void requestModelReset(ClientSession session)
	{
		// Will throw an InvalidSessionException on invalid session
		ClientSessionMgr.getInstance().checkSession(session);

		// Delegate to the model mgr
		modelMgr.requestModelReset();

		for (Iterator it = CollectionUtil.iterator(notificationObservers); it.hasNext();)
		{
			ModelNotificationObserver observer = (ModelNotificationObserver) it.next();
			observer.requestModelReset();
		}
	}
}