org.cristalise.kernel.entity.proxy.AgentProxy Maven / Gradle / Ivy
/**
* This file is part of the CRISTAL-iSE kernel.
* Copyright (c) 2001-2015 The CRISTAL Consortium. All rights reserved.
*
* 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 3 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; with out 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*
* http://www.fsf.org/licensing/licenses/lgpl.html
*/
package org.cristalise.kernel.entity.proxy;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.cristalise.kernel.common.AccessRightsException;
import org.cristalise.kernel.common.InvalidCollectionModification;
import org.cristalise.kernel.common.InvalidDataException;
import org.cristalise.kernel.common.InvalidTransitionException;
import org.cristalise.kernel.common.ObjectAlreadyExistsException;
import org.cristalise.kernel.common.ObjectNotFoundException;
import org.cristalise.kernel.common.PersistencyException;
import org.cristalise.kernel.entity.Agent;
import org.cristalise.kernel.entity.AgentHelper;
import org.cristalise.kernel.entity.C2KLocalObject;
import org.cristalise.kernel.entity.agent.Job;
import org.cristalise.kernel.graph.model.BuiltInVertexProperties;
import org.cristalise.kernel.lifecycle.instance.predefined.PredefinedStep;
import org.cristalise.kernel.lookup.AgentPath;
import org.cristalise.kernel.lookup.DomainPath;
import org.cristalise.kernel.lookup.InvalidItemPathException;
import org.cristalise.kernel.lookup.ItemPath;
import org.cristalise.kernel.lookup.Path;
import org.cristalise.kernel.lookup.RolePath;
import org.cristalise.kernel.process.Gateway;
import org.cristalise.kernel.process.auth.Authenticator;
import org.cristalise.kernel.property.Property;
import org.cristalise.kernel.property.PropertyDescriptionList;
import org.cristalise.kernel.scripting.ErrorInfo;
import org.cristalise.kernel.scripting.Parameter;
import org.cristalise.kernel.scripting.Script;
import org.cristalise.kernel.scripting.ScriptErrorException;
import org.cristalise.kernel.scripting.ScriptingEngineException;
import org.cristalise.kernel.utils.Logger;
import org.exolab.castor.mapping.MappingException;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.ValidationException;
/**
* It is a wrapper for the connection and communication with Agent It caches
* data loaded from the Agent to reduce communication
*/
public class AgentProxy extends ItemProxy {
AgentPath mAgentPath;
String mAgentName;
Authenticator auth;
/**
* Creates an AgentProxy without cache and change notification
*
* @param ior
* @param agentPath
* @throws ObjectNotFoundException
*/
protected AgentProxy(org.omg.CORBA.Object ior, AgentPath agentPath) throws ObjectNotFoundException {
super(ior, agentPath);
mAgentPath = agentPath;
}
@Override
public void finalize() throws Throwable {
if (auth != null) {
auth.disconnect();
}
super.finalize();
}
public Authenticator getAuthObj() {
return auth;
}
public void setAuthObj(Authenticator auth) {
this.auth = auth;
}
@Override
public Agent narrow() throws ObjectNotFoundException {
try {
return AgentHelper.narrow(mIOR);
}
catch (org.omg.CORBA.BAD_PARAM ex) {
}
throw new ObjectNotFoundException("CORBA Object was not an Agent, or the server is down.");
}
/**
* Extended execution of jobs when the client knows there there is a Transition to be used in case of an error.
* All execution parameters are taken from the job where they're probably going to be correct.
*
* @param job the Actual Job to be executed
* @param errorJob the erroro Job the be exeucted in case there was an exception to execute the origonal Job
* @return The outcome after processing. May have been altered by the step. Aternatively it contains
* the xml of marshalles ErrorInfo if the errorJob was exeuted
*
* @throws AccessRightsException The agent was not allowed to execute this step
* @throws InvalidDataException The parameters supplied were incorrect
* @throws InvalidTransitionException The step wasn't available
* @throws ObjectNotFoundException Thrown by some steps that try to locate additional objects
* @throws PersistencyException Problem writing or reading the database
* @throws ObjectAlreadyExistsException Thrown by steps that create additional object
* @throws ScriptErrorException Thrown by scripting classes
* @throws InvalidCollectionModification Thrown by steps that create/modify collections
*/
public String execute(Job job, Job errorJob)
throws ObjectNotFoundException, AccessRightsException, InvalidTransitionException, InvalidDataException,
PersistencyException, ObjectAlreadyExistsException, InvalidCollectionModification, ScriptErrorException
{
if (errorJob == null) throw new InvalidDataException("errorJob cannot be null");
try {
return execute(job);
}
catch (Exception ex) {
Logger.error(ex);
try {
errorJob.setAgentPath(mAgentPath);
errorJob.setOutcome(Gateway.getMarshaller().marshall(new ErrorInfo(job, ex)));
return execute(errorJob);
}
catch (MarshalException | ValidationException | IOException | MappingException e) {
Logger.error(e);
throw new InvalidDataException(e.getMessage());
}
}
}
/**
* Standard execution of jobs. Note that this method should always be the one used from clients.
* All execution parameters are taken from the job where they're probably going to be correct.
*
* @param job the Actual Job to be executed
* @return The outcome after processing. May have been altered by the step.
*
* @throws AccessRightsException The agent was not allowed to execute this step
* @throws InvalidDataException The parameters supplied were incorrect
* @throws InvalidTransitionException The step wasn't available
* @throws ObjectNotFoundException Thrown by some steps that try to locate additional objects
* @throws PersistencyException Problem writing or reading the database
* @throws ObjectAlreadyExistsException Thrown by steps that create additional object
* @throws ScriptErrorException Thrown by scripting classes
* @throws InvalidCollectionModification Thrown by steps that create/modify collections
*/
public String execute(Job job)
throws AccessRightsException, InvalidDataException, InvalidTransitionException, ObjectNotFoundException,
PersistencyException, ObjectAlreadyExistsException, ScriptErrorException, InvalidCollectionModification
{
ItemProxy item = Gateway.getProxyManager().getProxy(job.getItemPath());
Date startTime = new Date();
Logger.msg(3, "AgentProxy.execute(job) - act:" + job.getStepPath() + " agent:" + mAgentPath.getAgentName());
if (job.hasScript()) {
Logger.msg(3, "AgentProxy.execute(job) - executing script");
try {
// pre-validate outcome for script if there is one
// #196: Outcome can be invalid at this point, because Script will be executed later
//if (job.hasOutcome() && job.isOutcomeSet()) job.getOutcome().validateAndCheck();
// load script
ErrorInfo scriptErrors = callScript(item, job);
String errorString = scriptErrors.toString();
if (scriptErrors.getFatal()) {
Logger.error("AgentProxy.execute(job) - fatal script errors:"+scriptErrors);
throw new ScriptErrorException(scriptErrors);
}
if (errorString.length() > 0) Logger.warning("Script errors: " + errorString);
}
catch (ScriptingEngineException ex) {
Logger.error(ex);
throw new InvalidDataException(ex.getMessage());
}
}
else if (job.hasQuery() && !"Query".equals(job.getActProp(BuiltInVertexProperties.OUTCOME_INIT))) {
Logger.msg(3, "AgentProxy.execute(job) - executing query (OutcomeInit != Query)");
// pre-validate outcome for query if there is one
// #196: Outcome can be invalid at this point, because Query will be executed later
//if (job.hasOutcome() && job.isOutcomeSet()) job.getOutcome().validateAndCheck();
job.setOutcome(item.executeQuery(job.getQuery()));
}
if (job.hasOutcome() && job.isOutcomeSet()) job.getOutcome().validateAndCheck();
job.setAgentPath(mAgentPath);
Logger.msg(3, "AgentProxy.execute(job) - submitting job to item proxy");
String result = item.requestAction(job);
if (Logger.doLog(3)) {
Date timeNow = new Date();
long secsNow = (timeNow.getTime() - startTime.getTime()) / 1000;
Logger.msg(3, "AgentProxy.execute(job) - execution DONE in " + secsNow + " seconds");
}
return result;
}
@SuppressWarnings("rawtypes")
private ErrorInfo callScript(ItemProxy item, Job job) throws ScriptingEngineException, InvalidDataException, ObjectNotFoundException {
Script script = job.getScript();
script.setActExecEnvironment(item, this, job);
// At least one output parameter has to be ErrorInfo,
// it is either a single unnamed parameter or a parameter named 'errors'
if (script.getOutputParams().size() > 0) {
Parameter p;
if (script.getOutputParams().size() == 1) p = script.getOutputParams().values().iterator().next();
else p = script.getOutputParams().get("errors");
if (p.getType() == ErrorInfo.class ) {
Object returnVal = script.execute();
if (returnVal instanceof Map) return (ErrorInfo) ((Map)returnVal).get(p.getName());
else return (ErrorInfo) returnVal;
}
}
throw new InvalidDataException("Script "+script.getName()+" must at least one output of org.cristalise.kernel.scripting.ErrorInfo");
}
public String execute(ItemProxy item, String predefStep, C2KLocalObject obj)
throws AccessRightsException, InvalidDataException, InvalidTransitionException, ObjectNotFoundException,
PersistencyException, ObjectAlreadyExistsException, InvalidCollectionModification
{
String param;
try {
param = marshall(obj);
}
catch (Exception ex) {
Logger.error(ex);
throw new InvalidDataException("Error on marshall");
}
return execute(item, predefStep, param);
}
/**
* Multi-parameter execution. Wraps parameters up in a PredefinedStepOutcome if the schema of the requested step is such.
*
* @param item The item on which to execute the step
* @param predefStep The step name to run
* @param params An array of parameters to pass to the step. See each step's documentation for its required parameters
*
* @return The outcome after processing. May have been altered by the step.
*
* @throws AccessRightsException The agent was not allowed to execute this step
* @throws InvalidDataException The parameters supplied were incorrect
* @throws InvalidTransitionException The step wasn't available
* @throws ObjectNotFoundException Thrown by some steps that try to locate additional objects
* @throws PersistencyException Problem writing or reading the database
* @throws ObjectAlreadyExistsException Thrown by steps that create additional object
* @throws InvalidCollectionModification Thrown by steps that create/modify collections
*/
public String execute(ItemProxy item, String predefStep, String[] params)
throws AccessRightsException, InvalidDataException, InvalidTransitionException, ObjectNotFoundException,
PersistencyException, ObjectAlreadyExistsException, InvalidCollectionModification
{
String schemaName = PredefinedStep.getPredefStepSchemaName(predefStep);
String param;
if (schemaName.equals("PredefinedStepOutcome")) param = PredefinedStep.bundleData(params);
else param = params[0];
return item.getItem().requestAction(mAgentPath.getSystemKey(), "workflow/predefined/" + predefStep, PredefinedStep.DONE, param);
}
/**
* Single parameter execution. Wraps parameters up in a PredefinedStepOutcome if the schema of the requested step is such.
*
* @see #execute(ItemProxy, String, String[])
*/
public String execute(ItemProxy item, String predefStep, String param)
throws AccessRightsException, InvalidDataException, InvalidTransitionException, ObjectNotFoundException,
PersistencyException, ObjectAlreadyExistsException,InvalidCollectionModification
{
return execute(item, predefStep, new String[] { param });
}
/** Wrappers for scripts */
public String marshall(Object obj) throws Exception {
return Gateway.getMarshaller().marshall(obj);
}
public Object unmarshall(String obj) throws Exception {
return Gateway.getMarshaller().unmarshall(obj);
}
public ItemProxy searchItem(String name) throws ObjectNotFoundException {
return searchItem(new DomainPath(""), name);
}
/** Let scripts resolve items */
public ItemProxy searchItem(Path root, String name) throws ObjectNotFoundException {
Iterator results = Gateway.getLookup().search(root, name);
Path returnPath = null;
if (!results.hasNext()) {
throw new ObjectNotFoundException(name);
}
else {
while (results.hasNext()) {
Path nextMatch = results.next();
if (returnPath != null) {
// found already one but search if there are another, which is an error
if (isItemPathAndNotNull(nextMatch)) {
// test if another itemPath with same name
if (!returnPath.getItemPath().getUUID().equals(nextMatch.getItemPath().getUUID())) {
throw new ObjectNotFoundException("Too many different items with name:" + name);
}
else {
returnPath = nextMatch;
}
}
}
else {
if (isItemPathAndNotNull(nextMatch)) {
returnPath = nextMatch;
// found one but continue search
Logger.msg(5, "AgentProxy.searchItem() - found for " + name + " UUID = " + returnPath.getItemPath().getUUID());
}
}
}
}
// test if nothing found in the results
if (returnPath == null) {
throw new ObjectNotFoundException(name);
}
return Gateway.getProxyManager().getProxy(returnPath);
}
private boolean isItemPathAndNotNull(Path pPath) {
boolean ok = false;
try {
ok = pPath.getItemPath() != null;
}
catch (ObjectNotFoundException e) {
// false;
}
return ok;
}
public List searchItems(Path start, PropertyDescriptionList props) {
Iterator results = Gateway.getLookup().search(start, props);
return createItemProxyList(results);
}
public List searchItems(Path start, Property[] props) {
Iterator results = Gateway.getLookup().search(start, props);
return createItemProxyList(results);
}
private List createItemProxyList(Iterator results) {
ArrayList returnList = new ArrayList();
while (results.hasNext()) {
Path nextMatch = results.next();
try {
returnList.add(Gateway.getProxyManager().getProxy(nextMatch));
}
catch (ObjectNotFoundException e) {
Logger.error("Path '" + nextMatch + "' did not resolve to an Item");
}
}
return returnList;
}
public ItemProxy getItem(String itemPath) throws ObjectNotFoundException {
return (getItem(new DomainPath(itemPath)));
}
@Override
public AgentPath getPath() {
return mAgentPath;
}
public ItemProxy getItem(Path itemPath) throws ObjectNotFoundException {
return Gateway.getProxyManager().getProxy(itemPath);
}
public ItemProxy getItemByUUID(String uuid) throws ObjectNotFoundException, InvalidItemPathException {
return Gateway.getProxyManager().getProxy(new ItemPath(uuid));
}
public RolePath[] getRoles() {
return Gateway.getLookup().getRoles(mAgentPath);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy