/*
* Copyright 2012 Bill La Forge
*
* This file is part of AgileWiki and is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License (LGPL) as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This code 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
* or navigate to the following url http://www.gnu.org/licenses/lgpl-2.1.txt
*
* Note however that only Scala, Java and JavaScript files are being covered by LGPL.
* All other files are covered by the Common Public License (CPL).
* A copy of this license is also included and can be
* found as well at http://www.opensource.org/licenses/cpl1.0.txt
*/
package org.agilewiki.jactor.lpc;
import org.agilewiki.jactor.Actor;
import org.agilewiki.jactor.JAEvent;
import org.agilewiki.jactor.JAFuture;
import org.agilewiki.jactor.RP;
import org.agilewiki.jactor.apc.APCRequestSource;
/**
* A request.
*/
abstract public class Request<RESPONSE_TYPE, TARGET_TYPE extends TargetActor> {
/**
* Returns true when targetActor is an instanceof TARGET_TYPE
*
* @param targetActor The actor to be called.
* @return True when targetActor is an instanceof TARGET_TYPE.
*/
abstract public boolean isTargetType(Actor targetActor);
/**
* Searches the parent stack for the matching TARGET_TYPE.
*
* @param parent A stack of actors, or null.
* @return The matching parent, or null.
*/
final public TARGET_TYPE getTargetActor(Actor parent) {
while (parent != null && !isTargetType(parent)) {
parent = parent.getParent();
}
return (TARGET_TYPE) parent;
}
/**
* Send a request and waits for a response.
*
* @param future The future.
* @param targetActor The target actor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public RESPONSE_TYPE send(JAFuture future, Actor targetActor)
throws Exception {
if (isTargetType(targetActor))
return (RESPONSE_TYPE) future.send(targetActor, this);
Actor parent = targetActor.getParent();
while (parent != null) {
if (isTargetType(parent))
return (RESPONSE_TYPE) future.send(parent, this);
parent = parent.getParent();
}
throw new UnsupportedOperationException(
"request: " + getClass().getName() +
" target actor: " + targetActor.getClass().getName());
}
/**
* Send a request and waits for a response.
*
* @param future The future.
* @param targetActor The target actor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public RESPONSE_TYPE send(JAFuture future, TARGET_TYPE targetActor)
throws Exception {
return (RESPONSE_TYPE) future.send((Actor) targetActor, this);
}
/**
* Send a request.
*
* @param requestSource The sender of the request.
* @param targetActor The target actor.
* @param rp The response processor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public void send(APCRequestSource requestSource, Actor targetActor, RP<RESPONSE_TYPE> rp)
throws Exception {
if (isTargetType(targetActor)) {
targetActor.acceptRequest(requestSource, this, rp);
return;
}
Actor parent = targetActor.getParent();
while (parent != null) {
if (isTargetType(parent)) {
parent.acceptRequest(requestSource, this, rp);
return;
}
parent = parent.getParent();
}
throw new UnsupportedOperationException(
"request: " + getClass().getName() +
" target actor: " + targetActor.getClass().getName());
}
/**
* Send a request.
*
* @param requestSource The sender of the request.
* @param targetActor The target actor.
* @param rp The response processor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public void send(APCRequestSource requestSource, TARGET_TYPE targetActor, RP<RESPONSE_TYPE> rp)
throws Exception {
((Actor) targetActor).acceptRequest(requestSource, this, rp);
}
/**
* Send a request event.
*
* @param targetActor The target actor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public void sendEvent(Actor targetActor)
throws Exception {
if (isTargetType(targetActor)) {
targetActor.acceptEvent(JAEvent.requestSource, this);
return;
}
Actor parent = targetActor.getParent();
if (parent != null) {
if (isTargetType(parent)) {
parent.acceptEvent(JAEvent.requestSource, this);
return;
}
parent = parent.getParent();
}
throw new UnsupportedOperationException(
"request: " + getClass().getName() +
" target actor: " + targetActor.getClass().getName());
}
/**
* Send a request event.
*
* @param targetActor The target actor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public void sendEvent(TARGET_TYPE targetActor)
throws Exception {
((Actor) targetActor).acceptEvent(JAEvent.requestSource, this);
}
/**
* Send a request event.
*
* @param requestSource The sender of the request.
* @param targetActor The target actor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public void sendEvent(APCRequestSource requestSource, Actor targetActor)
throws Exception {
if (isTargetType(targetActor)) {
targetActor.acceptEvent(requestSource, this);
return;
}
Actor parent = targetActor.getParent();
if (parent != null) {
if (isTargetType(parent)) {
parent.acceptEvent(requestSource, this);
return;
}
parent = parent.getParent();
}
throw new UnsupportedOperationException(
"request: " + getClass().getName() +
" target actor: " + targetActor.getClass().getName());
}
/**
* Send a request event.
*
* @param requestSource The sender of the request.
* @param targetActor The target actor.
* @throws Exception Any uncaught exceptions raised while processing the request.
*/
final public void sendEvent(APCRequestSource requestSource, TARGET_TYPE targetActor)
throws Exception {
((Actor) targetActor).acceptEvent(requestSource, this);
}
public abstract void processRequest(JLPCActor targetActor, RP rp) throws Exception; /* {
targetActor.processRequest(this, rp);
} */
}