taverna-server-webapp/src/main/java/org/taverna/server/master/ManagementState.java

/*
 */
package org.taverna.server.master;
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

import javax.annotation.PostConstruct;
import javax.jdo.Query;
import javax.jdo.annotations.PersistenceAware;
import javax.jdo.annotations.PersistenceCapable;
import javax.jdo.annotations.Persistent;
import javax.jdo.annotations.PrimaryKey;

import org.springframework.beans.factory.annotation.Required;
import org.taverna.server.master.api.ManagementModel;
import org.taverna.server.master.utils.JDOSupport;

/** The persistent, manageable state of the Taverna Server web application. */
@PersistenceAware
class ManagementState extends JDOSupport<WebappState> implements
		ManagementModel {
	public ManagementState() {
		super(WebappState.class);
	}

	/** Whether we should log all workflows sent to us. */
	private boolean logIncomingWorkflows = false;

	/** Whether we allow the creation of new workflow runs. */
	private boolean allowNewWorkflowRuns = true;

	/**
	 * Whether outgoing exceptions should be logged before being converted to
	 * responses.
	 */
	private boolean logOutgoingExceptions = false;

	/**
	 * The file that all usage records should be appended to, or <tt>null</tt>
	 * if they should be just dropped.
	 */
	private String usageRecordLogFile = null;

	@Override
	public void setLogIncomingWorkflows(boolean logIncomingWorkflows) {
		this.logIncomingWorkflows = logIncomingWorkflows;
		if (loadedState)
			self.store();
	}

	@Override
	public boolean getLogIncomingWorkflows() {
		self.load();
		return logIncomingWorkflows;
	}

	@Override
	public void setAllowNewWorkflowRuns(boolean allowNewWorkflowRuns) {
		this.allowNewWorkflowRuns = allowNewWorkflowRuns;
		if (loadedState)
			self.store();
	}

	@Override
	public boolean getAllowNewWorkflowRuns() {
		self.load();
		return allowNewWorkflowRuns;
	}

	@Override
	public void setLogOutgoingExceptions(boolean logOutgoingExceptions) {
		this.logOutgoingExceptions = logOutgoingExceptions;
		if (loadedState)
			self.store();
	}

	@Override
	public boolean getLogOutgoingExceptions() {
		self.load();
		return logOutgoingExceptions || true;
	}

	@Override
	public String getUsageRecordLogFile() {
		self.load();
		return usageRecordLogFile;
	}

	@Override
	public void setUsageRecordLogFile(String usageRecordLogFile) {
		this.usageRecordLogFile = usageRecordLogFile;
		if (loadedState)
			self.store();
	}

	private static final int KEY = 42; // whatever

	private WebappState get() {
		Query<WebappState> q = query("id == " + KEY);
		q.setUnique(true);
		return q.executeUnique();
	}

	private boolean loadedState;
	private ManagementState self;

	@Required
	public void setSelf(ManagementState self) {
		this.self = self;
	}

	@PostConstruct
	@WithinSingleTransaction
	public void load() {
		if (loadedState || !isPersistent())
			return;
		WebappState state = get();
		if (state == null)
			return;
		allowNewWorkflowRuns = state.getAllowNewWorkflowRuns();
		logIncomingWorkflows = state.getLogIncomingWorkflows();
		logOutgoingExceptions = state.getLogOutgoingExceptions();
		usageRecordLogFile = state.getUsageRecordLogFile();
		loadedState = true;
	}

	@WithinSingleTransaction
	public void store() {
		if (!isPersistent())
			return;
		WebappState state = get();
		if (state == null) {
			state = new WebappState();
			// save state
			state.id = KEY; // whatever...
			state = persist(state);
		}
		state.setAllowNewWorkflowRuns(allowNewWorkflowRuns);
		state.setLogIncomingWorkflows(logIncomingWorkflows);
		state.setLogOutgoingExceptions(logOutgoingExceptions);
		state.setUsageRecordLogFile(usageRecordLogFile);
		loadedState = true;
	}
}

// WARNING! If you change the name of this class, update persistence.xml as
// well!
@PersistenceCapable(table = "MANAGEMENTSTATE__WEBAPPSTATE")
class WebappState implements ManagementModel {
	public WebappState() {
	}

	@PrimaryKey
	protected int id;

	/** Whether we should log all workflows sent to us. */
	@Persistent
	private boolean logIncomingWorkflows;

	/** Whether we allow the creation of new workflow runs. */
	@Persistent
	private boolean allowNewWorkflowRuns;

	/**
	 * Whether outgoing exceptions should be logged before being converted to
	 * responses.
	 */
	@Persistent
	private boolean logOutgoingExceptions;

	/** Where to write usage records. */
	@Persistent
	private String usageRecordLogFile;

	@Override
	public void setLogIncomingWorkflows(boolean logIncomingWorkflows) {
		this.logIncomingWorkflows = logIncomingWorkflows;
	}

	@Override
	public boolean getLogIncomingWorkflows() {
		return logIncomingWorkflows;
	}

	@Override
	public void setAllowNewWorkflowRuns(boolean allowNewWorkflowRuns) {
		this.allowNewWorkflowRuns = allowNewWorkflowRuns;
	}

	@Override
	public boolean getAllowNewWorkflowRuns() {
		return allowNewWorkflowRuns;
	}

	@Override
	public void setLogOutgoingExceptions(boolean logOutgoingExceptions) {
		this.logOutgoingExceptions = logOutgoingExceptions;
	}

	@Override
	public boolean getLogOutgoingExceptions() {
		return logOutgoingExceptions;
	}

	@Override
	public String getUsageRecordLogFile() {
		return usageRecordLogFile;
	}

	@Override
	public void setUsageRecordLogFile(String usageRecordLogFile) {
		this.usageRecordLogFile = usageRecordLogFile;
	}
}