59.3. 以编程方式添加拦截器
59.3.1. 添加拦截器的方法
拦截器可以使用以下两种方式之一附加到端点:
- InterceptorProvider API
- Java 注解
通过 InterceptorProvider API,开发人员可以将拦截器附加到具有拦截器链的任何运行时组件,但它需要使用底层的 Apache CXF 类。Java 注解只能添加到服务接口或服务实施中,但它们允许开发人员保留在 JAX-WS API 或 JAX-RS API 中。
59.3.2. 使用拦截器供应商 API
概述
可以使用实现 拦截器供应商接口 InterceptorProvider 接口的任何组件注册拦截器。
拦截器供应商接口
package org.apache.cxf.interceptor;
import java.util.List;
public interface InterceptorProvider
{
List<Interceptor<? extends Message>> getInInterceptors();
List<Interceptor<? extends Message>> getOutInterceptors();
List<Interceptor<? extends Message>> getInFaultInterceptors();
List<Interceptor<? extends Message>> getOutFaultInterceptors();
}
通过界面中的四种方法,您可以将每个端点的拦截器链作为 Java List 对象检索。使用 Java List 对象提供的方法,开发人员可以向任何链添加或删除拦截器。
流程
要使用 InterceptorProvider API,将拦截器附加到运行时组件的拦截器,您必须:
使用附加到拦截器的链获取运行时组件的访问权限。
开发人员必须使用 Apache CXF 特定的 API 从标准 Java 应用程序代码访问运行时组件。运行时组件可以通过将 JAX-WS 或 JAX-RS 工件转换为底层 Apache CXF 对象来访问。
- 创建拦截器的实例。
- 使用正确的 get 方法来检索所需的拦截器链。
使用
List对象的add ()方法,将拦截器附加到拦截器链。此步骤通常与检索拦截器链结合使用。
将拦截器附加到消费者
以编程方式将拦截器附加到消费者 显示将拦截器附加到 JAX-WS 消费者入站拦截器链的代码。
以编程方式将拦截器附加到消费者
package com.fusesource.demo;
import java.io.File;
import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import org.apache.cxf.endpoint.Client;
public class Client
{
public static void main(String args[])
{
QName serviceName = new QName("http://demo.eric.org", "stockQuoteReporter");
Service s = Service.create(serviceName);
QName portName = new QName("http://demo.eric.org", "stockQuoteReporterPort");
s.addPort(portName, "http://schemas.xmlsoap.org/soap/", "http://localhost:9000/EricStockQuote");
quoteReporter proxy = s.getPort(portName, quoteReporter.class);
Client cxfClient = (Client) proxy;
ValidateInterceptor validInterceptor = new ValidateInterceptor();
cxfClient.getInInterceptor().add(validInterceptor);
...
}
}
以编程方式将拦截器附加到消费者 中的代码执行以下操作:
为使用者创建一个 JAX-WS Service 对象。
为提供消费者的目标地址的 Service 对象添加端口。
创建用于在服务提供商上调用方法的代理。
将代理广播到 org.apache.cxf.endpoint.Client 类型。
创建拦截器的实例。
将拦截器附加到入站拦截器链。
将拦截器附加到服务提供商
以编程方式将拦截器附加到服务提供商 显示将拦截器附加到服务提供商的出站拦截器链的代码。
以编程方式将拦截器附加到服务提供商
package com.fusesource.demo;
import java.util.*;
import org.apache.cxf.endpoint.Server;
import org.apache.cxf.frontend.ServerFactoryBean;
import org.apache.cxf.frontend.EndpointImpl;
public class stockQuoteReporter implements quoteReporter
{
...
public stockQuoteReporter()
{
ServerFactoryBean sfb = new ServerFactoryBean();
Server server = sfb.create();
EndpointImpl endpt = server.getEndpoint();
AuthTokenInterceptor authInterceptor = new AuthTokenInterceptor();
endpt.getOutInterceptor().add(authInterceptor);
}
}
以编程方式将拦截器附加到服务提供商 中的代码执行以下操作:
创建一个 ServerFactoryBean 对象,它将提供对底层的 Apache CXF 对象的访问。
获取 Apache CXF 用来代表端点的服务器对象。
获取服务提供商的 Apache CXF EndpointImpl 对象。
创建拦截器的实例。
将拦截器附加到端点;s 出站拦截器链。
将拦截器附加到总线
将拦截器附加到总线 显示将拦截器附加到总线入站拦截器链的代码。
将拦截器附加到总线
import org.apache.cxf.BusFactory; org.apache.cxf.Bus; ... Bus bus = BusFactory.getDefaultBus(); WatchInterceptor watchInterceptor = new WatchInterceptor(); bus..getInInterceptor().add(watchInterceptor); ...
将拦截器附加到总线 中的代码执行以下操作:
获取运行时实例的默认总线。
创建拦截器的实例。
将拦截器附加到入站拦截器链。
WatchInterceptor 将附加到运行时实例创建的所有端点的入站拦截器链。
59.3.3. 使用 Java 注解
概述
Apache CXF 提供四个 Java 注解,允许开发人员指定端点使用的拦截器链。与将拦截器附加到端点的不同,注解会附加到应用程序级别的工件中。所用的构件决定了注解的作用范围。
放置注解的位置
注解可放在以下工件中:
定义端点的服务端点接口(SEI)
如果注解放在一个 SEI 上,则所有实现接口和使用 SEI 创建代理的用户的服务提供商都将会受到影响。
服务实施类
如果注解放在实施类中,使用实施类的所有服务提供商都将会受到影响。
注解
该注解都位于 org.apache.cxf.interceptor 软件包中,并在 表 59.2 “拦截器链注解” 中描述。
列出拦截器
拦截器列表以完全限定类名称列表形式指定,使用 在链注解中列出拦截器的语法 中显示的语法。
在链注解中列出拦截器的语法
interceptors={"interceptor1", "interceptor2", ..., "interceptorN"}
示例
将拦截器附加到服务实现中 显示将两个拦截器附加到使用 SayHiImpl 提供的逻辑的入站拦截器链的注解。
将拦截器附加到服务实现中
import org.apache.cxf.interceptor.InInterceptors;
@InInterceptors(interceptors={"com.sayhi.interceptors.FirstLast", "com.sayhi.interceptors.LogName"})
public class SayHiImpl implements SayHi
{
...
}