開発者は、サービスに関する情報を公開しないようにするため、リソースの Web アプリケーション記述言語 (WADL) 文書を公開しないことを選択できます。
サービスに関する情報は、開発者によってサービスの外部で提供される文書から取得する方が適している場合があります。
このタスクについて
デフォルトでは、任意の Java™ API for RESTful Web Services (JAX-RS) URL に対して HTTP OPTIONS 要求を呼び出すことによって、特定のリソースで WADL 文書を要求できます。
ほとんどの HTTP クライアントで OPTIONS 要求を発行できます。
しかしまれなことではありますが、この動作をさせずに、OPTIONS 要求に対してデフォルトで空の文書を戻すようにしたい場合は、アプリケーションに対するデフォルトの WADL 生成を無効にできます。
以下の例を使用して、アプリケーションに対するデフォルトの WADL 生成を無効にできます。
手順
- アプリケーションのカスタム・プロパティーを含むプロパティー・ファイルを作成します。 以下の例は、単純なプロパティー・ファイルを示しています。
org.apache.wink.server.options.handler=none
- プロパティー・ファイルをアプリケーションに配置します。
- web.xml ファイル内で propertiesLocation 初期化パラメーターを使用します。 以下の例は、propertiesLocation 初期化パラメーターが含まれる web.xml ファイルを示しています。
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/
j2ee/web-app_3_0.xsd"
version="3.0">
<servlet>
<servlet-name>javax.ws.rs.core.Application</servlet-name>
<load-on-startup>1</load-on-startup>
<init-param>
<param-name>propertiesLocation</param-name>
<param-value>path/to/file.properties</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>javax.ws.rs.core.Application</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
タスクの結果
アプリケーションに対するデフォルトの WADL 生成を無効にしました。