com.caucho.v5.amp.stub.StubAmp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of baratine Show documentation
A reactive Java web server.
There is a newer version: 1.0.1
/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.v5.amp.stub;

import java.lang.reflect.AnnotatedType;
import java.util.List;

import com.caucho.v5.amp.ServiceRefAmp;
import com.caucho.v5.amp.deliver.QueueDeliver;
import com.caucho.v5.amp.journal.JournalAmp;
import com.caucho.v5.amp.spi.HeadersAmp;
import com.caucho.v5.amp.spi.InboxAmp;
import com.caucho.v5.amp.spi.LoadState;
import com.caucho.v5.amp.spi.MessageAmp;
import com.caucho.v5.amp.spi.ShutdownModeAmp;

import io.baratine.service.Result;
import io.baratine.service.ServiceRef;

/**
 * StubAmp marshals message calls to a service implementation.
 */
public interface StubAmp
{
  String name();

  AnnotatedType api();
  
  boolean isPublic();
  
  Object bean();
  Object loadBean();
  
  /**
   * Returns a child service
   */
  Object onLookup(String path, ServiceRefAmp parentRef);
  
  //
  // pub/sub
  //

  //void consume(ServiceRef consumer);
  //void subscribe(ServiceRef consumer);
  //void unsubscribe(ServiceRef consumer);

  /**
   * Returns an stub method.
   * 
   * @param methodName the name of the method
   */
  default MethodAmp method(String methodName, Class []param)
  {
    throw new UnsupportedOperationException(getClass().getName());
  }
  
  default MethodAmp methodByName(String methodName)
  {
    throw new UnsupportedOperationException(getClass().getName());
  }
  
  MethodAmp []getMethods();

  void queryReply(HeadersAmp headers, 
                  StubAmp stub,
                  long qid, 
                  Object value);
  
  void queryError(HeadersAmp headers, 
                  StubAmp stub,
                  long qid,
                  Throwable exn);

  /**
   * Conditional completion depending on the stub type.
   * 
   * The journal uses this to skip its own completion, leaving the processing
   * for the main stub.
   */
  default  boolean ok(Result result, T value)
  {
    result.ok(value);
    
    return true;
  }
  
  /**
   * Conditional completion depending on the stub type.
   * 
   * The journal uses this to skip its own completion, leaving the processing
   * for the main stub.
   */
  default boolean fail(Result result, Throwable exn)
  {
    result.fail(exn);
    
    return true;
  }

  void streamReply(HeadersAmp headers, 
                   StubAmp stub,
                   long qid,
                   int sequence,
                   List