...

2006年 7月 25日 火曜日

why document/literal

2006年 6月 14日 水曜日

Accessing JAX-WS 2.0 with SSL in Glassfish

   SSLを使い、GlassfishでのWeb Serviceと相互認証を通してアクセスしてみました、以下はそのメモです。 プログラム自体は単純でサーバーサイドにメッセージを送り、レスが返って出力します。

   作業ディレクトリは、図１になります。

図 1.

1.サーバー側

package endpoint;

import javax.jws.WebService;
import javax.jws.WebMethod;
import javax.annotation.Resource;
import javax.xml.ws.WebServiceContext;

@WebService(
    name="MyHelloWorld",
    serviceName="MyHelloWorldService",
    targetNamespace="http://javaee5.com/jaxws/helloworld"
)
public class HelloWorld{
    
    //the implementation class must have a default public constructor
    public HelloWorld() {};

    //
    @Resource WebServiceContext wsContext;

    @WebMethod(operationName="mySayHello", action="urn:mySayHello")
    public String sayHello(String name){
	return name + "'s user principal is " 
                   + wsContext.getUserPrincipal();
    }
}

JAX-WS 2.0からJSR 181のannotationを使って、直接にサービスクラスを実装するだけで、開発はとてもシンプルとなってます。 List 1.をコンパイルして、 Glassfishから提供されているユーティリティwsgenを用いて、対応したWSDLファイルを生成できます。

~/ssl> javac -classpath %GLASSFISH_HOME%/lib/javaee.jar -d ./build/classes/service -g endpoint/HelloWorld.java

~/ssl> wsgen.bat -cp ./build/classes/service -keep -d ./build/classes/service -r ./build/generated -wsdl endpoint.HelloWorld

warファイルをパッケージするには、List 2.のweb.xmlを使います。相互認証を行うため、<auth-method>ではCLIENT-CERTと設定します。サービスクラスはWebServiceContext.getUserPrincipal()を読んでるため、その設定はList 3.のsun-web.xmlの<security-role-mapping>で行います。

<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:j2ee="http://java.sun.com/xml/ns/javaee"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.5"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
   http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">  

      <description>WebTier for the HelloWorld Service</description>
        <display-name>HelloWorldWAR</display-name>  <servlet>
        <description>Endpoint for HelloWorld Web Service</description>
        <display-name>HelloWorldWebService</display-name>
        <servlet-name>MyHelloWorld</servlet-name>
        <servlet-class>endpoint.HelloWorld</servlet-class>
        <load-on-startup>0</load-on-startup>
      </servlet>  <servlet-mapping>
        <servlet-name>MyHelloWorld</servlet-name>
        <url-pattern>/HelloWorldService</url-pattern>
      </servlet-mapping>  <security-constraint>
        <web-resource-collection>
        <web-resource-name>Secure Area</web-resource-name>
        <url-pattern>/HelloWorldService</url-pattern>
        <http-method>POST</http-method>
        </web-resource-collection>
        <auth-constraint>
        <role-name>ENGINEER</role-name>
        </auth-constraint>
        <user-data-constraint>
        <transport-guarantee>CONFIDENTIAL</transport-guarantee>
        </user-data-constraint>
      </security-constraint>
      <login-config>
        <auth-method>CLIENT-CERT</auth-method>
        <realm-name>certificate</realm-name>
      </login-config>
      <security-role>
        <role-name>ENGINEER</role-name>
      </security-role>
</web-app>

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sun-web-app 
  PUBLIC "-//Sun Microsystems, 
  Inc.//DTD Application Server 9.0 Servlet 2.5//EN"
  "http://www.sun.com/software/appserver/dtds/sun-web-app_2_5-0.dtd">  
<sun-web-app>
     <context-root>/HelloWorldService</context-root>
     <security-role-mapping>
        <role-name>ENGINEER</role-name>
        <principal-name>
          CN=zerra, OU=JPE, O=Sun, L=HaiDian, S=Beijing, C=China
        </principal-name>
     </security-role-mapping>
</sun-web-app>

asadminコマンドツールを使ってデプロイします。

~/ssl/archive> jar cvf helloworld-webservice.war WEB-INF/

~/ssl/archive> asadmin.bat deploy --user admin --passwordfile s1as_password.txt --host localhost --port 4848 --contextroot helloworld-webservice --upload=true --target server helloworld-webservice.war

2.クライアント側

サーバーで公開されているサービス(WSDL)から、Glassfishのユーティリティwsimportを使い、アクセスするためのクラスを生成します。

~/ssl> wsimport.bat -keep -d ./build/classes/client https://zerra:8181/helloworld-webservice/HelloWorldService?WSDL

生成されたクラスをimportして、クライアントのクラス(List 4.)を作ります。WebServiceRefのwsdlLocationでhttpsの指定にご注目。そしてクラスパスを指定し、クラスをコンパイルします。

package client;
   
import javax.xml.ws.WebServiceRef;
import com.javaee5.jaxws.helloworld.MyHelloWorldService;
import com.javaee5.jaxws.helloworld.MyHelloWorld;
   
public class WSClient{
   
  @WebServiceRef(wsdlLocation=
  "https://zerra:8181/helloworld-webservice/HelloWorldService?WSDL")
   static MyHelloWorldService service;
	   
   public static void main(String[] args){
	   try{
		   WSClient client = new WSClient();
		   client.callEndpoint(args[0]);
	   }catch(Exception e){
		   e.printStackTrace();
	   }
   }
	   
   public void callEndpoint(String name){
	   try{
		   MyHelloWorld port = service.getMyHelloWorldPort();
		   System.out.println(port.mySayHello(name));
	   }catch(Exception e){
		   e.printStackTrace();
	   }
   }
   
}

~/ssl> javac -d ./build/classes/client -classpath %GLASSFISH_HOME%/lib/javaee.jar\;$GLASSFISH_HOME/lib/appserv-ws.jar\;./build/classes/client client/WSClient.java

サーバーと相互認証を行うには、クライアントが自分のキーを生成する必要があり、それをサーバーにあるトラストストーアに導入します。具体的な手順はImport Client's cert into Glassfishに書いてあります。

準備が整ったら、サーバーのトラストストーアとクライアントのキーストーアをVMARGSという環境変数に設定し、実行します。

~/ssl/build/classes/client> set VMARGS=-Djavax.net.ssl.trustStore=%GLASSFISH_HOME%/domains/domain1/config/cacerts.jks -Djavax.net.ssl.trustStorePassword=changeit -Djavax.net.ssl.keyStore=E:\ssl\clientCertificate\xiaojunkeystore.jks -Djavax.net.ssl.keyStorePassword=changeit

~/ssl/build/classes/client> appclient.bat client.WSClient Duke
Duke's user principal is CN=zerra, OU=JPE, O=Sun, L=HaiDian, S=Beijing, C=China

2006年 6月 07日 水曜日

Import Client's cert into Glassfish

2006年 2月 24日 金曜日

JAX-WS 2.0 Java<===>WSDL1.1 mappings (written in Japanese)

別のスレッドで書いたサンプルをいじって（文章が中国語となってますが、クラスやコマンドが化けないと思うが）、Java<===>WSDL1.1のマッピングをみていきたいと思います。

まず、List１を使って、annotationsのWebServiceとWebMethodの属性のデフォルト値を確認します。Glassfishに提供されているwsgenを使って、WSDLファイル(List2)を生成します。

@WebService()   
public class HelloWorld{
    
    //the implementation class must have a default public constructor
    public HelloWorld() {};

    @WebMethod()
    public String sayHello(String name){
  	return "Hello "+ name + "!";
    }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions targetNamespace="http://endpoint/" 
   name="HelloWorldService" xmlns:tns="http://endpoint/" 
   xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
   xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
   xmlns="http://schemas.xmlsoap.org/wsdl/">

  <types>
    <xsd:schema>
      <xsd:import namespace="http://endpoint/" 
                   schemaLocation="HelloWorldService_schema1.xsd"/>
    </xsd:schema>
  </types>
  <message name="sayHello">
    <part name="parameters" element="tns:sayHello"/>
  </message>
  <message name="sayHelloResponse">
    <part name="parameters" element="tns:sayHelloResponse"/>
  </message>
  <portType name="HelloWorld">
    <operation name="sayHello">
      <input message="tns:sayHello"/>
      <output message="tns:sayHelloResponse"/>
    </operation>
  </portType>
  <binding name="HelloWorldPortBinding" type="tns:HelloWorld">
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http" 
                   style="document"/>
    <operation name="sayHello">
      <soap:operation soapAction=""/>
      <input>
        <soap:body use="literal"/>
      </input>
      <output>
        <soap:body use="literal"/>
      </output>
    </operation>
  </binding>
  <service name="HelloWorldService">
    <port name="HelloWorldPort" binding="tns:HelloWorldPortBinding">
      <soap:address location="REPLACE_WITH_ACTUAL_URL"/>
    </port>
  </service>
</definitions>

クラスHelloWorldがportTypeのnameに、メソッド名sayHelloがportTypeの子要素operationの名前にそれぞれとマッピングされているのが分かります。

ここで、annotationsのWebService、WebMethodの属性を指定して(List 3)、List 4のWSDLが生成されます。

@WebService(
    name="MyHelloWorld",
    serviceName="MyHelloWorldService",
    targetNamespace="http://javaee5.com/jaxws/helloworld"
)   
public class HelloWorld{
    
    //the implementation class must have a default public constructor
    public HelloWorld() {};

    @WebMethod(operationName="mySayHello", action="urn:mySayHello")
    public String sayHello(String name){
	return "Hello "+ name + "!";
    }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions 
   targetNamespace="http://javaee5.com/jaxws/helloworld" 
   name="MyHelloWorldService" 
   xmlns:tns="http://javaee5.com/jaxws/helloworld" 
   xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
   xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
   xmlns="http://schemas.xmlsoap.org/wsdl/">
  
  <types>
    <xsd:schema>
      <xsd:import namespace="http://javaee5.com/jaxws/helloworld"
                  schemaLocation="MyHelloWorldService_schema1.xsd"/>
    </xsd:schema>
  </types>

  <message name="mySayHello">
    <part name="parameters" element="tns:mySayHello"/>
  </message>
  <message name="mySayHelloResponse">
    <part name="parameters" element="tns:mySayHelloResponse"/>
  </message>
  <portType name="MyHelloWorld">
    <operation name="mySayHello">
      <input message="tns:mySayHello"/>
      <output message="tns:mySayHelloResponse"/>
    </operation>
  </portType>
  <binding name="MyHelloWorldPortBinding" type="tns:MyHelloWorld">
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http" 
	        style="document"/>
    <operation name="mySayHello">
      <soap:operation soapAction="urn:mySayHello"/>
      <input>
        <soap:body use="literal"/>
      </input>
      <output>
        <soap:body use="literal"/>
      </output>
    </operation>
  </binding>
  <service name="MyHelloWorldService">
    <port name="MyHelloWorldPort" 
            binding="tns:MyHelloWorldPortBinding">
      <soap:address location="REPLACE_WITH_ACTUAL_URL"/>
    </port>
  </service>
</definitions>

グラフ１にマッピング関係を示しています。

ここで見た例はstyle/useに関して暗黙でDocument/Literalが使用されますが、

@WebService
@SOAPBinding(style=SOAPBinding.Style.RPC, use=SOAPBinding.Use.ENCODED)
public class HelloWorld{

  //the implementation class must have a default public constructor
  public HelloWorld() {};
 　
　　@WebMethod(operationName="mySayHello", 
    　　　　　　　　　action="urn:mySayHello")
  public String sayHello(String name){
    return "Hello "+ name + "!";
  }
}

List 5のようにSOAPBinding属性の指定を通して、RPC/Encodedに変えられます。

他にも、Oneway、WebParamなどがありますので、用途に応じてカスタマイズできます。

2006年 2月 20日 月曜日

JAX-WS 2.0, an HelloWorld例子 (written in Chinese)