taverna-server-webapp/src/main/java/org/apache/taverna/server/master/api/ManagementModel.java

/*
 */
package org.apache.taverna.server.master.api;
/*
 * 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.
 */

/**
 * The model of the webapp's state Java Bean.
 * 
 * @author Donal Fellows
 */
public interface ManagementModel {
	/**
	 * @return whether we allow the creation of new workflow runs.
	 */
	boolean getAllowNewWorkflowRuns();

	/**
	 * @return whether we should log all workflows sent to us.
	 */
	boolean getLogIncomingWorkflows();

	/**
	 * @return whether outgoing exceptions should be logged before being
	 *         converted to responses.
	 */
	boolean getLogOutgoingExceptions();

	/**
	 * @return the file that all usage records should be appended to, or
	 *         <tt>null</tt> if they should be just dropped.
	 */
	String getUsageRecordLogFile();

	/**
	 * @param logIncomingWorkflows
	 *            whether we should log all workflows sent to us.
	 */
	void setLogIncomingWorkflows(boolean logIncomingWorkflows);

	/**
	 * @param allowNewWorkflowRuns
	 *            whether we allow the creation of new workflow runs.
	 */
	void setAllowNewWorkflowRuns(boolean allowNewWorkflowRuns);

	/**
	 * @param logOutgoingExceptions
	 *            whether outgoing exceptions should be logged before being
	 *            converted to responses.
	 */
	void setLogOutgoingExceptions(boolean logOutgoingExceptions);

	/**
	 * @param usageRecordLogFile
	 *            the file that all usage records should be appended to, or
	 *            <tt>null</tt> if they should be just dropped.
	 */
	void setUsageRecordLogFile(String usageRecordLogFile);
}