| /* |
| * 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. |
| */ |
| package org.apache.ode.jacob; |
| |
| import java.lang.reflect.Method; |
| |
| import org.apache.ode.jacob.oo.Channel; |
| import org.apache.ode.jacob.oo.ChannelListener; |
| import org.apache.ode.jacob.soup.CommChannel; |
| |
| /** |
| * Class exposing the JACOB operations. |
| * <p> |
| * Note: these operations represent a subset of a process algebra mapped into |
| * Java invocations; other aspects of the syntax are represented natively in Java. |
| * In particular, parallel composition is modeled as sequential Java invocation |
| * and if-else are modeled using Java's if-else statement. Note also that the |
| * scoping rules for channel names are simply the Java object visibility rules. |
| */ |
| public interface JacobThread { |
| |
| public Object getExtension(Class<?> extensionClass); |
| |
| // calculus oriented API |
| |
| /** |
| * Create a new calculus channel. |
| * |
| * @param channelType |
| * @param creator |
| * @param description |
| * @return |
| */ |
| public ChannelRef newCommChannel(Class<?> channelType, String creator, String description); |
| |
| /** |
| * DOCUMENT ME |
| * @param channel |
| * @return |
| */ |
| public String exportCommChannel(CommChannel channel); |
| |
| /** |
| * DOCUMENT ME |
| * @param channel |
| * @return |
| */ |
| public ChannelRef importCommChannel(String channelId, Class<?> channelType); |
| |
| /** |
| * Send a message. |
| * |
| * @param message |
| * self-contained message |
| */ |
| public void sendMessage(Message message); |
| |
| public void subscribe(boolean replicate, ChannelRef channel, MessageListener methodList) throws IllegalArgumentException; |
| public void subscribe(boolean replicate, ChannelRef channel, MessageListener[] methodList) throws IllegalArgumentException; |
| |
| // OO oriented API |
| |
| public String exportChannel(Channel channel); |
| |
| public Channel importChannel(String channelId, Class<?> channelClass); |
| |
| /** |
| * Create a process instance i.e. a concretion of a process abstraction. |
| */ |
| public void instance(Runnable concretion); |
| |
| /** |
| * Send a message (object invocation). This method shouldn't really be used |
| * as {@link Channel} objects may be used as proxies in this respect. |
| * |
| * @param channel |
| * channel on which to send the message |
| * @param method |
| * method to apply |
| * @param args |
| * arguments |
| */ |
| public Channel message(Channel channel, Method method, Object[] args); |
| |
| /** |
| * Create a new channel. |
| */ |
| public Channel newChannel(Class<?> channelType, String creator, String description); |
| |
| /** |
| * <p> |
| * Receive a message on a channel, allowing for possible replication. The |
| * effect of this method is to register a listener (the method list) for a |
| * message on the channel to consume either one or an infinite number of |
| * messages on the channel (depending on the value of the |
| * <code>replicate</code> argument. |
| * </p> |
| * |
| * <p> |
| * With respect to process terms, the Java expression <code>object(false, x, |
| * ChannelListener)</code> |
| * corresponds to the process term <code> x ? { ChannelListener }</code>; |
| * if in the same expression the initial <code>replicate</code> parameter |
| * were instead set to <code>true</code>, corresponding term would be |
| * <code> ! x ? { ChannelListener }</code>. |
| * </p> |
| * |
| * @param replicate |
| * if set the a replication operator is present |
| * @param methodList |
| * object representation of the method list |
| * @throws IllegalArgumentException |
| * if the method list does not match the channel kind |
| */ |
| public void object(boolean replicate, ChannelListener methodList) throws IllegalArgumentException; |
| |
| /** |
| * <p> |
| * Receive a message on a channel, allowing for possible replication. The |
| * effect of this method is to register a list of listeners (the method list) for a |
| * message on the channel to consume either one or an infinite number of |
| * messages on the channel (depending on the value of the |
| * <code>replicate</code> argument. |
| * </p> |
| * |
| * <p> |
| * With respect to process terms, the Java expression <code>object(false, x, |
| * ChannelListener)</code> |
| * corresponds to the process term <code> x ? { ChannelListener[] }</code>; |
| * if in the same expression the initial <code>replicate</code> parameter |
| * were instead set to <code>true</code>, corresponding term would be |
| * <code> ! x ? { ChannelListener }</code>. |
| * </p> |
| * |
| * @param replicate |
| * if set the a replication operator is present |
| * @param methodList |
| * object representation of the method list |
| * @throws IllegalArgumentException |
| * if the method list does not match the channel kind |
| */ |
| public void object(boolean reaplicate, ChannelListener[] methodLists) throws IllegalArgumentException; |
| |
| } |