1.2.5. Webサービスのカスタマイズ

1.2.5.1. JAX-WS準拠Webサービスのカスタマイズ

ハンドラの利用

• Logical Handler
  Logical Handlerはメッセージコンテキストおよびメッセージの本体を扱うことができます。メッセージのプロトコル固有部分は扱うことができません。
  
• Protocol Handler
  Protocol Handlerはメッセージコンテキストおよびプロトコル固有メッセージを扱うことができます。
  

public boolean handleMessage(LogicalMessageContext context);
public boolean handleFault(LogicalMessageContext context);
public void close(MessageContext ctx);

package sample; 

import javax.xml.ws.handler.*; 

public class HelloLogicalHandler implements LogicalHandler<LogicalMessageContext> { 
  public boolean handleMessage(LogicalMessageContext context) { 
    //通常のメッセージの送受信ごとに呼び出されます。 
    return true; 
  } 

  public boolean handleFault(LogicalMessageContext context) { 
    //Faultメッセージの送受信ごとに呼び出されます。
    return true; 
  } 

  public void close(MessageContext context) { 
    //メッセージ、Faultメッセージ、例外をディスパッチする直前に呼び出されます。 
  } 
}

public Set<QName> getHeaders();
public boolean handleMessage(SOAPMessageContext context);
public boolean handleFault(SOAPMessageContext context);
public void close(MessageContext ctx);

package sample;

import java.util.Set;
import javax.xml.namespace.QName;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.handler.soap.SOAPHandler;
import javax.xml.ws.handler.soap.SOAPMessageContext;

public class HelloSOAPHandler implements SOAPHandler<SOAPMessageContext> { 
  public Set<QName> getHeaders() {
    return null; 
  } 

  public boolean handleMessage(SOAPMessageContext context) { 
    //通常のメッセージの送受信ごとに呼び出されます。
    return true;
  }

  public boolean handleFault(SOAPMessageContext context) { 
    //Faultメッセージの送受信ごとに呼び出されます。
    return true;
  }

  public void close(MessageContext context) { 
    //メッセージ、Faultメッセージ、例外をディスパッチする直前に呼び出されます。
  }
}

• アプリケーションでBindingを取得してBinding.setHandlerChain()で登録する
• バインディングファイル(handlers.xml)に記述して登録する

Handler handler = new HelloLogicalHandler(); 
Handler handler2 = new HelloSOAPHandler(); 
List<Handler> handlerList = new ArrayList<Handler>(); 
handlerList.add(handler); 
handlerList.add(handler2); 
Binding binding =((BindingProvider)port).getBinding(); 
binding.setHandlerChain(handlerList);

<?xml version="1.0" encoding="UTF-8"?> 
<handler-chains xmlns="http://java.sun.com/xml/ns/javaee"> 
  <handler-chain>
    <handler>
      <handler-name>HelloLogicalHandler</handler-name>
      <handler-class>sample.HelloLogicalHandler</handler-class>
    </handler>
    <handler>
      <handler-name>HelloSOAPHandler</handler-name>
      <handler-class>sample.HelloSOAPHandler</handler-class>
    </handler>
  </handler-chain>
</handler-chains>

import javax.jws.HandlerChain;
@HandlerChain(file="handlers.xml")

• アウトバウンドメッセージの場合
  Logical Handlerが登録されていれば、登録された順番に呼び出されます。 その後、Protocol Handlerが登録されていれば、登録された順番に呼び出されます。
  
• インバウンドメッセージの場合
  Protocol Handlerが登録されていれば、登録された逆順で呼び出されます。 その後、Logical Handlerが登録されていれば、登録された逆順で呼び出されます。
  

SOAP1.2の利用

<?xml version="1.0" encoding="UTF-8"?>
<endpoints xmlns='http://www.nec.com/WebOTX/xml/ns/jax-ws/ri/runtime'version='2.0'>
  <endpoint
    name='hellows-soap12'
    implementation='sample.Hello'
    binding="http://java.sun.com/xml/ns/jaxws/2003/05/soap/bindings/HTTP/"
    url-pattern='/hello'/>
</endpoints>

import javax.jws.WebService;
import javax.xml.ws.BindingType;
@WebService
@BindingType(value="http://java.sun.com/xml/ns/jaxws/2003/05/soap/bindings/HTTP/")
public class Hello {
       :
}

MTOM (Message Transmission and OptimizationMechanism)の利用

<?xml version="1.0" encoding="UTF-8"?>
<endpoints xmlns='http://www.nec.com/WebOTX/xml/ns/jax-ws/ri/runtime' version='2.0'>
  <endpoint name="Mtom" implementation="sample.HelloImpl" 
   url-pattern="/hello"
   enable-mtom="true"/>
</endpoints>

<endpoint ...
    binding="http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true"
/>

<endpoint ...
    binding="http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true"
 />

import javax.xml.ws.soap.MTOM;

@MTOM

import javax.xml.ws.BindingType;
@BindingType(value="http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true")

import javax.xml.ws.BindingType;
@BindingType(value="http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true")

クライアントのカスタマイズ

HelloService service = new HelloService();
Hello port = service.getHelloPort();
((javax.xml.ws.BindingProvider)port).getRequestContext().put(<キー>,<値>);

クライアント側でMTOMを有効にする場合

MtomSample port = new MtomService().getMtomPort(new MTOMFeature());

javax.xml.ws.Service.createDispatch(....,newjavax.xml.ws.soap.MTOMFeature())

Hello port = new HelloService.getHelloPort();
SOAPBinding binding = (SOAPBinding)((BindingProvider)port).getBinding();
binding.setMTOMEnabled(true);

リクエスト送信先のアドレス変更方法

リクエストタイムアウト の設定方法

Fast Infoset の設定方法

[設定例]

-Dcom.nec.webotx.webservice.xml.ws.client.ContentNegotiation=[ none | pessimistic | optimistic ] クライアントクラス

チャンク形式転送の設定方法

1.2.5.2. JAX-RPC準拠Webサービスのカスタマイズ

Memo
JAX-RPCは旧互換のための機能です。

Web形式のカスタマイズ

実装クラスのカスタマイズ

• javax.xml.rpc.server.ServiceLifecycleをimplementsに加える。
• init、destroyメソッドを実装する。
• initメソッドの引数をjavax.xml.rpc.server.ServletEndpointContextでキャストし、コンテキスト情報などを取り出す。

import javax.xml.rpc.server.ServiceLifecycle;
import javax.xml.rpc.server.ServletEndpointContext;

public class TestSoapBindingImpl implements com.nec.webotx.webservice.director.hello.hello_PortType,ServiceLifecycle {

  private ServletEndpointContext jaxrpcContext;

  public void init(Object context) throws ServiceException {
    jaxrpcContext =(ServletEndpointContext) context;
  }

  public void destroy() {
    jaxrpcContext = null;
  }

  public void getMessageContext() {
    jaxrpcContext.getMessageContext();
  }

}

EJBサービスエンドポイントのカスタマイズ

実装クラスのカスタマイズ

• javax.ejb.SessionContextをimplementsに加える。
• getMessageContext()を実装し、コンテキストを取得する。

クライアントのカスタマイズ

添付ファイルを使用する場合

Fast Infoset の利用方法

_setProperty(com.nec.webotx.webservice.xml.rpc.client.StubPropertyConstants.CONTENT_NEGOTIATION_PROPERTY, "***value***");

[設定例]

[foo@webotx ~]$ java -Dcom.nec.webotx.webservice.xml.rpc.client.ContentNegotiation=***value*** クライアントクラス

ビジネスロジックの置換

Caution
インタフェースが変更になる場合は、Webサービス作成ウィザードをやり直す必要があります。

ビジネスロジックがプロジェクトの場合

ビジネスロジックがJARファイルの場合

ビジネスロジックがWAR・EJB-JARファイルの場合

クラスパスに追加するライブラリに指定したJAR・ZIPファイルの置換

HTML・JSPファイルなどの追加・置換