/*
 * 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.uima.aae;

import org.apache.uima.aae.InProcessCache.CacheEntry;
import org.apache.uima.aae.controller.AnalysisEngineController;
import org.apache.uima.aae.controller.Endpoint;
import org.apache.uima.aae.error.AsynchAEException;
import org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData;
import org.apache.uima.cas.CAS;
import org.apache.uima.resource.metadata.ProcessingResourceMetaData;

public interface OutputChannel extends Channel {
  public void setController(AnalysisEngineController aContainer);

  public void initialize() throws AsynchAEException;

  public void sendRequest(String aCasReferenceId, Endpoint anEndpoint) throws AsynchAEException;

  public void sendRequest(String aCasReferenceId, Endpoint[] anEndpoint) throws AsynchAEException;

  public void sendRequest(int aCommand, Endpoint anEndpoint) throws AsynchAEException;

  public void sendRequest(int aCommand, String aCasReferenceId, Endpoint anEndpoint)
          throws AsynchAEException;

  public void sendReply(int aCommand, Endpoint anEndpoint) throws AsynchAEException;

  public void sendReply(int aCommand, Endpoint anEndpoint, String aCasReferenceId)
          throws AsynchAEException;

  public void sendReply(int aCommand, Endpoint anEndpoint, String aCasReferenceId, boolean notifyOnJmsException)
  throws AsynchAEException;

  public void sendReply(CAS aCas, String anInputCasReferenceId, String aNewCasReferenceId,
          Endpoint anEndpoint, long sequence) throws AsynchAEException;

  public void sendReply(String aCasReferenceId, Endpoint anEndpoint) throws AsynchAEException;

  public void sendReply(CacheEntry entry, Endpoint anEndpoint) throws AsynchAEException;

  // public void sendReply( AnalysisEngineMetaData anAnalysisEngineMetadata, Endpoint anEndpoint,
  // boolean serialize ) throws AsynchAEException;
  public void sendReply(ProcessingResourceMetaData aProcessingResourceMetadata,
          Endpoint anEndpoint, boolean serialize) throws AsynchAEException;

  public void sendReply(Throwable t, String aCasReferenceId, String aParentCasReferenceId,
          Endpoint anEndpoint, int aCommand) throws AsynchAEException;

  public void bindWithClientEndpoint(Endpoint anEndpoint) throws Exception;

  public void setServerURI(String aServerURI);

  public void stop();

  public void cancelTimers();

}