/* * 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.tuscany.sca.invocation; import org.apache.tuscany.sca.interfacedef.Operation; /** * A wire consists of 1..n invocation chains associated with the operations of its source service contract. *
* Invocation chains may containInterceptors
that process invocations.
*
* A Message
is used to pass data associated with an invocation through the chain.
*
* @version $Rev$ $Date$
*/
public interface InvocationChain {
/**
* Returns the target operation for this invocation chain.
*
* @return The target operation for this invocation chain
*/
Operation getTargetOperation();
/**
* Updates the target operation for this invocation chain.
*
* @param operation The new target operation for this invocation chain
*/
void setTargetOperation(Operation operation);
/**
* Returns the source operation for this invocation chain.
*
* @return The source operation for this invocation chain
*/
Operation getSourceOperation();
/**
* Adds an interceptor to the chain. For reference side, it will be added to
* Phase.REFERENCE. For service side, it will be added to Phase.SERVICE
*
* @param interceptor The interceptor to add
*/
void addInterceptor(Interceptor interceptor);
/**
* Adds an invoker to the chain
*
* @param invoker The invoker to add
*/
void addInvoker(Invoker invoker);
/**
* Returns the first invoker in the chain.
*
* @return The first invoker in the chain
*/
Invoker getHeadInvoker();
/**
* @deprecated This method is not used
* Returns the last invoker in the chain.
*
* @return The last invoker in the chain
*/
@Deprecated
Invoker getTailInvoker();
/**
* @deprecated Please use void addInterceptor(String phase, Interceptor interceptor);
* Adds an interceptor at the given position in the interceptor stack
*
* @param index The position in the interceptor stack to add the interceptor
* @param interceptor The interceptor to add
*/
@Deprecated
void addInterceptor(int index, Interceptor interceptor);
/**
* Add an interceptor to the given phase
* @param phase
* @param interceptor
*/
void addInterceptor(String phase, Interceptor interceptor);
/**
* Indicate if the data can be passed in by reference as they won't be mutated.
* @return true if pass-by-reference is allowed
*/
boolean allowsPassByReference();
/**
* Force the invocation to allow pass-by-reference
* @param allowsPBR
*/
void setAllowsPassByReference(boolean allowsPBR);
}