/*
* Timer: The timer class
* Copyright (C) 2006-2007 Rift IT Contracting
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* JythonDaemon.java
*/
package com.rift.coad.daemon.jython;
import java.rmi.Remote;
import java.rmi.RemoteException;
import java.util.Map;
/**
* The Jython Daemon integrates Jython into Coadunation which give a user the
* ability to run Python scripts within Coadunation.
*
* @author Glynn Chaldecott
*/
public interface JythonDaemon extends Remote {
/**
* This method is called when a user wants to run a stored script. It will
* then return the requested value.
*
* @param name This is the name of the script that a user wishes to run.
* Please note that on a windows installation this will need to include
* the file extension ".py".
* @param returnValue This is the name of the value a user wishes to have
* returned.
* @param javaclass This is the type of object a user wants the returned
* value to returned as.
* @return Returns a value from the script.
*/
public Object runScript(String name, String returnValue, Class javaclass)
throws RemoteException;
/**
* This method is called when a user wants to run a stored script. It will
* then return the requested value. A user can also specify value for
* variables within the script.
*
* @param name This is the name of the script that a user wishes to run.
* Please note that on a windows installation this will need to include
* the file extension ".py".
* @param returnValue This is the name of the value a user wishes to have
* returned.
* @param javaclass This is the type of object a user wants the returned
* value to returned as.
* @param arguments This is a Map object containing as the key the name of
* the variable and the value for that variable.
* @return Returns a value from the script.
*/
public Object runScript(String name, String returnValue, Class javaclass,
Map arguments) throws RemoteException;
/**
* This script is called in order to register a new script within
* Coadunation.
*
* @param script This is a string containing the script that will be
* inserted in a python file.
* @param name This is what the script will be called as well as what the
* python file will be named. Please note that on a windows installation
* this will need to include the file extension ".py".
*/
public void registerScript(byte[] file, String name)
throws RemoteException, JythonDaemonException;
}
|