xproxy.properties設定

概要

このファイルではx-Servlet全般に関わる設定を行っています。


場所

x-Servletインストールディレクトリ

└ xproxy.properties

形式

##### x-Servletの設定ファイル
##

#########################################################
### 環境によって必ず変更する必要がある項目
#########################################################
## x-Servletをインストールしたディレクトリを指定します。
## パスの区切りは'/'で記述します。
xproxyBaseDir=d:/work/xproxy

## x-Servletを動作させるサーバのホスト名もしくはIPアドレスを指定します。
xproxyHost=192.168.0.128

## x-Servletを動作させるサーバのPORTを指定します。
## ","で区切って複数のポートを記述することができます。
xproxyPort=80

## x-Servletを動作させる際にxproxyHostで指定した値に
## バインドするか指定します。
strictBind=false

#########################################################
### 環境によっては変更することが必要となる項目
#########################################################
## 負荷分散機の背後にxServletをおく場合に指定する
#serverID=xServlet
#requestExchanger.serverIDPrefix=_-
#requestExchanger.serverIDSuffix=-_

## httpで元コンテンツを取得する際に用いるプロキシのIPアドレスを指定します。
#httpProxyHost=192.168.0.138

## httpで元コンテンツを取得する際に用いるプロキシのポート番号を指定します。

(以下省略)

説明

※用語について
"Default"とは、x-Servletをインストールした時点でxproxy.propertiesで有効となっている値です。
"省略時"とは、xproxy.propertiesに記述がない又は、コメント化されている状態で使用される値です。

必ず変更する必要がある項目

  • xproxyBaseDir
    x-Servletをインストールしたディレクトリを指定します。
    パスの区切りは'/'で記述します。
    例)xproxyBaseDir=d:/work/xproxy
  • xproxyHost
    x-Servletを動作させるサーバのホスト名もしくはIPアドレスを指定します。
    例)xproxyHost=192.168.0.128
  • xproxyPort
    x-Servletを動作させるサーバのPORTを指定します。
    ","で区切って複数のポートを記述することができます。
    例)xproxyPort=80,443
  • strictBind
    x-Servletを動作させる際にxproxyHostで指定した値にバインドするか指定します。"true"もしくは"false"が指定可能です。
    true : xproxyHostで指定した値にバインドします。
    false(省略時) : "0.0.0.0" にバインドします。
    例)strictBind=false
    xproxyHostとxproxyPortをそれぞれ
       xproxyHost=192.168.0.128
       xproxyPort=80,443
    という指定を行っている場合、strictBindの動作は以下のようになります。

    【strictBind=true の場合】
       192.168.0.128:80
       192.168.0.128:443
    で起動します。

    【strictBind=false の場合】
       0.0.0.0:80
       0.0.0.0:443
    で起動します。

環境によっては変更することが必要となる項目

  • serverID
    URLリライトを行う際のサーバ識別文字列を指定します。
    例)serverID=A
    ※詳細は「二重化機能」を参照ください。
  • requestExchanger.serverIDPrefix
    URLリライトを行う際にサーバ識別文字列の前につける文字列(サーバIDに付加するプレフィックス)を指定します。
    例)requestExchanger.serverIDPrefix=_-
    ※Version2.8.3 までは初期値が "(_" でしたが、Version2.9.0 以降では "_-" となります。
    ※詳細は「二重化機能」を参照ください。
  • requestExchanger.serverIDSuffix
    URLリライトを行う際にサーバ識別文字列の後につける文字列(サーバIDに付加するサフィックス)を指定します。
    例)requestExchanger.serverIDSuffix=-_
    ※Version2.8.3 までは初期値が "_)" でしたが、Version2.9.0 以降では "-_" となります。
    ※詳細は「二重化機能」を参照ください。
    requestExchanger.serverIDPrefix と requestExchanger.serverIDSuffix に同じ値を指定することはできません。
  • httpProxyHost
    httpで元コンテンツを取得する際に用いるプロキシのIPアドレスを指定します。
    例)httpProxyHost=192.168.0.138
  • httpProxyPort
    httpで元コンテンツを取得する際に用いるプロキシのポート番号を指定します。
    例)httpProxyPort=8000

    ※httpProxyHost、httpProxyPort共に指定できる値は1つのみとなります。
    ※これらが指定されているとWebサーバへのリクエストは指定されているプロキシサーバへ接続しますが、Host ヘッダに指定される内容は <ContentsRule> の <Host><Port> となります。

  • httpsProxyHost
    httpsで元コンテンツを取得する際に用いるプロキシのIPアドレスを指定します。
    例)httpsProxyHost=192.168.0.138
  • httpsProxyPort
    httpsで元コンテンツを取得する際に用いるプロキシのポート番号を指定します。
    例)httpsProxyPort=10080

    ※httpsProxyHost、httpsProxyPort共に指定できる値は1つのみとなります。
    ※これらが指定されているとWebサーバへのリクエストは指定されているプロキシサーバへ接続しますが、Host ヘッダに指定される内容は <ContentsRule> の <Host><Port> となります。

  • UAUpdateProxyHost
    機種情報を取得する際に用いるプロキシのIPアドレスを指定します。
    例)UAUpdateProxyHost=192.168.0.138
  • UAUpdateProxyPort
    機種情報を取得する際に用いるプロキシのポート番号を指定します。
    例)UAUpdateProxyPort=8000
  • userAgent.update
    ネットワーク経由で機種情報を更新するか指定します。"true"もしくは"false"が指定可能です。
    true : ネットワーク経由で機種情報を更新します。
    false(省略時) : ネットワーク経由で機種情報を更新しません。
    例)userAgent.update=true
  • userAgent.update.time
    機種情報のネットワーク更新時刻を指定します。
    "HH:mm"で指定します。HHは24時間表記です。
    (省略時:x-Servletを起動した時刻)
    例)userAgent.update.time=04:00
  • logSurvivalDate
    ログファイルの保存日数を指定します。x-Servletは毎日0時以降で最初にリクエストを受けた際にログファイルのチェックを行い、ここで指定された日数より過去のファイルを削除します。指定しない場合にはログファイルの削除を行いません。
    例)logSurvivalDate=7
  • exceptionIpAddresses
    access.logに出力させたくないIPアドレスを指定します。","で区切って複数のIPアドレスを指定することができます。
    例)exceptionIpAddresses=192.168.0.128,192.168.0.129
  • suppressLogParameterN
    特定のURLパラメータがaccess.logに出力されることを抑制します。複数指定することにより複数のパラメータ出力を抑制することが可能です。
    例)suppressLogParameter1=id
    例)suppressLogParameter2=pass
    通常access.logは
    127.0.0.1 [23/Jan/2004:20:50:12 JST] "/loginCheck?id=0123456&pass=password&type=1"
    "http://192.168.0.128:8000/loginCheck?id=0123456&pass=password&type=1" 200 2129 - W11K[XHTMLBASIC]
    というように出力されますが上記の例のような指定がされている場合は
    127.0.0.1 [23/Jan/2004:20:50:47 JST] "/loginCheck?type=1"
    "http://192.168.0.128:8000/loginCheck?type=1" 200 2129 - W11K[XHTMLBASIC]
    というようにidパラメータとpassパラメータが削除された状態で出力されます。
  • log.accessLog.withSubNo
    個体識別情報が取得できた場合にaccess.logに個体識別情報を出力するか指定します。"true"もしくは"false"が指定可能です。
    true : access.logの「端末名」と「ML名」の間に個体識別情報文字列を'()'に囲まれた形式で出力します。フォーマットに関しましては特殊HTTPリクエストヘッダのX-Xp-Uidを参照ください。
    false(省略時) : 個体識別情報文字列は出力しません。
    例)log.accessLog.withSubNo=true
  • log.accessLog.loggingSessionID [Version2.9.0以上]
    access.logにセッションIDを出力するか指定します。"true"もしくは"false"が指定可能です。
    true : access.log の末尾にセッションIDを出力します。
    false(省略時) : セッションIDは出力しません。
    例)log.accessLog.loggingSessionID=false
  • log.debugLog.disableBody
    debug.logにResponseのボディを出力しないかどうか指定します。"true"もしくは"false"が指定可能です
    true : Responseのボディを出力しません。
    false(省略時) : Responseのボディを出力します。
    例)log.debugLog.disableBody=true
  • maxClientLimit
    同時に受付けても処理が可能なリクエスト数を指定します(省略時:50)。
    Keep-Alive を有効にしている場合(xproxyAcceptType=2)はリクエスト数ではなくコネクション数となります。
    受け付ける数を多くすると同時に処理する数が増えるため、x-Servlet の負荷が高まるので注意が必要です。
    例)maxClientLimit=50
    ※詳細は受け付け可能な同時リクエスト数を参照ください。
  • contentsSocketTimeout
    Webサーバからコンテンツを取得する時に待つ秒数を指定します(省略時:30)。
    例)contentsSocketTimeout=30
  • contentsSocketRetryLimit [Version2.8.3以上]
    Webサーバからコンテンツを取得する時の接続に失敗した際の、リトライ回数を指定します(省略時:10)。
    例)contentsSocketRetryLimit=10
  • contentsSocketRetryInterval [Version2.8.3以上]
    Webサーバからコンテンツを取得する時の接続に失敗した際の、リトライ間隔をミリ秒で指定します(省略時:500)。
    例)contentsSocketRetryInterval=500
  • loggingWebResponseTime [Version2.9.0以上]
    Webサーバからのコンテンツを取得する時間をaccess.logに出力します(省略時:false)。
    例)loggingWebResponseTime=false
    xproxyAcceptType=2 の場合のみ有効です。
  • requestSocketTimeout
    ブラウザからのリクエストを待つ秒数を指定します(省略時:60)。
    例)requestSocketTimeout=60
    xproxyAcceptType=1 の場合のみ有効です。
  • statsInterval [Version2.8.2以上]
    x-Servletのステータス統計ログを出力する間隔を指定します(省略時:0 単位:分)。
    0分で指定した場合はログは出力されません。
    例)statsInterval=60
  • TrackerController.cacheContainer [Version2.8.2以上]
    セッション情報のキャッシュ方法を指定します。
    例)TrackerController.cacheContainer=jp.co.flexfirm.xproxy.common.MemoryCacheContainer
  • MLCacheController.cacheContainer [Version2.8.2以上]
    テキストコンテンツのキャッシュ方法を指定します。
    例)MLCacheController.cacheContainer=jp.co.flexfirm.xproxy.common.MemoryCacheContainer
  • ImageCacheController.cacheContainer [Version2.8.2以上]
    画像コンテンツのキャッシュ方法を指定します。
    例)ImageCacheController.cacheContainer=jp.co.flexfirm.xproxy.common.MemoryCacheContainer
  • FlashCacheController.cacheContainer [Version2.8.2以上]
    FLASHコンテンツのキャッシュ方法を指定します。
    例)FlashCacheController.cacheContainer=jp.co.flexfirm.xproxy.common.MemoryCacheContainer
  • ScriptCacheController.cacheContainer [Version2.10.0以上]
    JavaScriptコンテンツのキャッシュ方法を指定します。
    例)ScriptCacheController.cacheContainer=jp.co.flexfirm.xproxy.common.MemoryCacheContainer
  • CssCacheController.cacheContainer [Version2.10.0以上]
    外部CSSコンテンツのキャッシュ方法を指定します。
    例)CssCacheController.cacheContainer=jp.co.flexfirm.xproxy.common.MemoryCacheContainer

    ※Version2.8.2からセッション情報、およびコンテンツのキャッシュ管理方法として新たな方法が追加されました。
    【設定できる項目】
    • TrackerController.cacheContainer
    • MLCacheController.cacheContainer
    • ImageCacheController.cacheContainer
    • FlashCacheController.cacheContainer
    • ScriptCacheController.cacheContainer  [Version2.10.0以上]
    • CssCacheController.cacheContainer     [Version2.10.0以上]

    【設定できる値】
    以下のどちらかを指定する必要があります。省略、もしくは異なる値を指定した場合はエラーとなりx-Servletが起動しません。

    • jp.co.flexfirm.xproxy.common.MemoryCacheContainer
      新たに追加された管理方法です。
    • jp.co.flexfirm.xproxy.common.LegacyMemoryCacheContainer
      従来と同様の管理方法です。※ScriptCacheController.cacheContainer、CssCacheController.cacheContainerでは非奨励です。
  • sessionTerm
    セッションの有効時間をミリ秒単位で指定します(省略時:600000)。
    最終リクエストを受け付けた時刻からの有効時間となりますのでリクエストするたびに経過時間はリセットされます。
    この時間が長くするとセッション情報を保持するための必要メモリが増大するので注意が必要です。
    例)sessionTerm=600000
  • ※キャッシュ管理方法が MemoryCacheContainer と LegacyMemoryCacheContainer では動作が異なります。
    • MemoryCacheContainer
      sessionTerm + sessionRefreshInterval がセッションの最大時間となります。
    • LegacyMemoryCacheContainer
      sessionTerm がセッションの最大時間となります。(旧バージョンと同じ動作)
  • cacheTerm
    コンテンツキャッシュの保持時間をミリ秒単位で指定します(省略時:600000)。
    例)cacheTerm=600000
  • ※キャッシュ管理方法が MemoryCacheContainer と LegacyMemoryCacheContainer では動作が異なります。
    • MemoryCacheContainer
      cacheTerm + cacheRefreshInterval がコンテンツキャッシュの最大時間となります。
    • LegacyMemoryCacheContainer
      cacheTerm がコンテンツキャッシュの最大時間となります。(旧バージョンと同じ動作)
  • sessionRefreshInterval
    古くなったセッションをクリーンアップする間隔をミリ秒単位で指定します(省略時:60000)。
    例)sessionRefreshInterval=30000
  • cacheRefreshInterval
    コンテンツキャッシュクリア間隔をミリ秒単位で指定します(省略時:60000)。
    例)cacheRefreshInterval=60000
    ※標準では全てのコンテンツキャッシュクリアの間隔はcacheRefreshIntervalで制御されますが、以下の指定を行うことで個別にクリア間隔を指定することもできます。[Version2.8.2以上]
    • MLCacheController.refreshInterval=30000
      テキストコンテンツのキャッシュをクリアする間隔を指定します。
    • ImageCacheController.refreshInterval=30000
      画像コンテンツのキャッシュをクリアする間隔を指定します。
    • FlashCacheController.refreshInterval=30000
      FLASHコンテンツのキャッシュをクリアする間隔を指定します。
    • ScriptCacheController.refreshInterval=30000
      JavaScriptコンテンツのキャッシュをクリアする間隔を指定します。  [Version2.10.0以上]
    • CssCacheController.refreshInterval=30000
      外部CSSコンテンツのキャッシュをクリアする間隔を指定します。  [Version2.10.0以上]

    この設定はcacheRefreshIntervalよりも優先されます。

  • sessionMaxCount
    保持するセッションの保持可能数を指定します(省略時:3000)。
    x-Servlet 内で保持するセッション数を指定します。
    セッション数を増やすと必要メモリが増大するので注意が必要です。
    例)sessionMaxCount=3000
    ※キャッシュ管理方法が MemoryCacheContainer と LegacyMemoryCacheContainer では動作が異なります。
    • MemoryCacheContainer
      この値を超えた時点で最終アクセス時刻が古い順にキャッシュが削除されます。
    • LegacyMemoryCacheContainer
      キャッシュクリア間隔まで得られたキャッシュを全て保持し、キャッシュクリアの動作でこの値以上のキャッシュが削除されます。(旧バージョンと同じ動作)
  • cacheMaxCount
    変換前のtext/htmlファイルをキャッシュする最大数を指定します(省略時:200)。
    例)cacheMaxCount=100
    ※Version2.8.1 までは初期値が "200" でしたが、Version2.8.2 以降では "100" となります。
  • cacheMaxCountConvert
    1つの text/htmlキャッシュあたり、変換済みのキャッシュを何機種分残すかを指定します(省略時:無制限(旧バージョンと同様))。
    例)cacheMaxCountConvert=100
  • cacheMaxCountImage
    変換済みの画像ファイルをキャッシュする最大数を指定します(省略時:1600)。
    例)cacheMaxCountImage=1600
  • cacheMaxCountFlash
    変換前のFlashファイルをキャッシュする最大数を指定します(省略時:100)。
    例)cacheMaxCountFlash=100
  • cacheMaxCountScript  [Version2.10.0以上]
    変換前のJavaScriptファイルをキャッシュする最大数を指定します(省略時:100)。
    例)cacheMaxCountScript=100
  • cacheMaxCountCss  [Version2.10.0以上]
    変換前の外部CSSファイルをキャッシュする最大数を指定します(省略時:100)。
    例)cacheMaxCountCss=100
  • cacheMaxCountCss=0 と指定するとキャッシュが無効となり外部CSS変換機能も無効となります。
  • tracker.historySize
    遷移したページを管理できる数を指定します(1以上、省略時:3)。
    ページ分割や <form> で入力された値を保持しておくバッファです。
    指定されたページ数分だけブラウザバックが行えます。
    例)tracker.historySize=5
    • セッションごとに指定されたページ数のバッファを確保するため値を大きくすると使用メモリが増大します。
      Version2.8.3 以降では動的なページなど保持する必要のないページ分は解放されるためVersion2.8.2 以前と比べると使用メモリは少なくなりますが 10~20 程度の値を推奨します。
    • Version2.9.0 以降でセッションIDワンタイム化機能を使用している場合はブラウザバックが使用できないためこの設定は無効となります。
  • flashCacheEnable
    Flashコンテンツのキャッシュを行うか指定します。"true"もしくは"false"が指定可能です。
    true : Flashコンテンツのキャッシュを行います。
    false(省略時) : Flashコンテンツのキャッシュを行いません。
    例)flashCacheEnable=true
  • XHTMLSupportAccessKey
    XHTML Basic端末にaccesskeyの"0#*"を出力するか指定します。"true"もしくは"false"が指定可能です。
    true : accesskeyの"0#*"を出力します。
    false(省略時) : accesskeyの"0#*"を出力しません。
    例)XHTMLSupportAccessKey=true
    ※Version2.8.1 までは初期値が "false" でしたが、Version2.8.2 以降では "true" となります。
  • HDMLSupportAccessKey ※現在はHDML端末のサービスは終了しているため変更の必要はありません。
    HDML端末にaccesskeyの"0#*"を出力するか指定します。"true"もしくは"false"が指定可能です。
    true : accesskeyの"0#*"を出力します。
    false(省略時) : accesskeyの"0#*"を出力しません。
    例)HDMLSupportAccessKey=false
  • XHTMLSupportTextAreaCRLF
    XHTML Basic端末の<TEXTAREA>タグ変換のCRLF->LF変換を行うか指定します。"true"もしくは"false"が指定可能です。
    true : 変換を行いません。
    false(省略時) : 変換を行います。
    例)XHTMLSupportTextAreaCRLF=true
  • URISanitizing [Version2.4.0以上]
    リンク変換時にサニタイジングを行うかどうか指定します。"true"もしくは"false"が指定可能です。
    true(省略時) : サニタイジングを行います。
    false : サニタイジングを行いません。
    例)URISanitizing=true
    ※詳細はサニタイジングを参照ください。
  • fragmentThrough [Version2.8.1以上]
    ページ内リンク(<a href=”#TOP”>等)を変換するかどうか指定します。"true"もしくは"false"が指定可能です。
    true : ページ内リンクは変換せず、そのまま出力します。
    false(省略時) : ページ内リンクを変換します。
  • response.force.pragma.no-cache
    レスポンスヘッダに"Pragma: no-cache"を付けるか指定します。"true"もしくは"false"が指定可能です。
    true(省略時) : "Pragma: no-cache"を付けます。
    false : "Pragma: no-cache"を付けません。
    例)response.force.pragma.no-cache=false
  • serverXproxyVersion
    x-Servletが出力するレスポンスにServerヘッダを付与するか指定します。"true"もしくは"false"が指定可能です。
    true(省略時) : Serverヘッダを付与します。
    false : Serverヘッダを付与しません。
    例)serverXproxyVersion=true
  • fullHeaderRequest
    先読み時にコンテンツ取得に使用したヘッダを復元するか指定します。"true"もしくは"false"が指定可能です。
    true : ヘッダを復元します。
    false(省略時) : ヘッダを復元しません。
    例)fullHeaderRequest=true
  • sendCookieOnPreRequest [Version2.9.0以上]
    先読み時にセッションで保持しているCookieを付加するか指定します。"true"もしくは"false"が指定可能です。
    true : 先読みのリクエストに Cookie を付与します。
    false(省略時) : 先読みのリクエストに Cookie を付与しません。
    例)sendCookieOnPreRequest=true
  • setSessionHeader
    ヘッダに X-Xp-Session-Header および X-Xp-Unique-Session-Header を付与するか指定します。
    "true"もしくは"false"が指定可能です。
    true : X-Xp-Session-Header と X-Xp-Unique-Session-Header を付与します。
    false(省略時) : X-Xp-Session-Header と X-Xp-Unique-Session-Header を付与しません。
    例)setSessionHeader=true

初期設定のままで動作する項目

  • licenseFile
    x-Servletのライセンスファイル名を xproxyBaseDir からの相対パスで指定します。
    例)licenseFile=xservlet.license
  • logDir
    以下のいずれかの方法でログファイルを出力するディレクトリ名を指定します。
    1.xproxyBaseDir からの相対パスで指定(例:"logs")
    2.絶対パスで指定(例:"d:/logs/xproxy","/var/log/xproxy")
    例)logDir=logs
  • logConfigFileName
    出力するログに関する設定を行うファイルを指定します。
    例)logConfigFileName=conf/log4j.properties
  • userAgent.staticFile
    常に有効となる機種情報を格納しているファイル名の格納場所を指定します。
    例)userAgent.staticFile=conf/staticUA.xml
  • userAgent.file
    x-Servletが起動した際に読み込む機種情報を格納したファイル名を指定します。
    例)userAgent.file=conf/useragent.xml
  • rule.defaultFile
    元コンテンツの取得方法に適用されるデフォルト値を定義しているファイル名を指定します。
    例)rule.defaultFile=conf/contentsRuleDefault.xml
  • rule.position
    元コンテンツの取得方法を定義したファイル名を指定します。
    例)rule.position=conf/contentsRule.xml
  • pictogram.file
    絵文字に関する情報を定義しているファイル名を指定します。
    例)pictogram.file=conf/pictogram.xml
  • uagroup.file
    端末グループを定義しているファイル名を指定します。
    例)uagroup.file=conf/UAGroupSetting.xml
  • tagExpressionType
    SELECTタグの表現方法を指定します。"1"もしくは"2"が指定可能です。
    1 : Version1.2x系の変換を行う
    2 : Version2.x系の変換を行う
    例)tagExpressionType=2
    ※Version1.2x系以前の設定で使用したい場合のみ"1"を設定してください。
  • sessionIDType
    セッション文字列の表現方法を指定します。"1"~"4"が指定可能です。
    1(省略時) : Version2.1.2以前と同様の形式(6桁)
    2 : "1"の初期値をランダムにし、値にスクランブルをかけ推測を困難にしたもの(6桁)
    3 : "2"の桁数を11桁に増やしたもの(11桁)
    4 : "2"のハッシュ値を採用し、更に推測を困難にしたもの(22桁) [Version2.8.0以上]
    例)sessionIDType=4
  • detectSessionWithTE [Version2.8.0以上]
    セッションの判定にセッション文字列以外に機種名を使用するか指定します。"true"もしくは"false"が指定可能です。
    true : セッション文字列が同じでも異なる端末名からのリクエストは違うセッションと見なします。
    false(省略時) : セッション文字列が同じであれば異なる端末名からのリクエストでも同じセッションと見なします。
    例)detectSessionWithTE=true
  • newSessionIDFlag [Version2.4.1以上]
    セッションが重複しない強化されたセッション文字列を使用するかどうかを指定します。"true"もしくは"false"が指定可能です。
    この指定はsessionIDType=2の場合のみ有効です。
    セッション文字列を重複させないためにも、trueに指定することを推奨します。
    true : セッション文字列を使用します。
    false(省略時) : セッション文字列を使用しません。
    例)newSessionIDFlag=true
    • Version2.4.1未満のx-Servletではリクエスト毎に生成した一意IDを元にx-Servletのセッション文字列(_xpxi)を生成していたため、セッション文字列が重複する可能性がありました。
      本パラメータにtrueを指定した場合、一意ID,シリアルNo,リクエスト受信時間を用いてセッション文字列を生成しますので、セッション文字列が重複する可能性が皆無となります。
    • 本パラメータをtrueに指定した場合、x-Servletのセッション文字列長が20文字となるためURL長に制限のある旧端末を対象とする場合はセッション文字列を含めた全URL文字列が512バイト以下になるようご注意ください。
  • getFormRedirect [Version2.8.3まで]
    <form method="get">タグでリダイレクトを行うかどうかを指定します。"true"もしくは"false"が指定可能です。
    true(省略時) : リダイレクトを行います。
    false : リダイレクトを行いません。
    例)getFormRedirect=true
    • この設定は Version2.9.0 で削除され、"false" と同様の動作となりました。Version2.9.0以上でこの指定を行っても無効となります。
    • FORM の GET リクエストがキャリアGWを通過しなくなるため "uid=NULLGWDOCOMO" などを使用している場合はVersion2.9.0以降では動作しなくなります。
      この場合は FORM のメソッドを POST に変えて "formActionUIDThrough=true" を使用するなどの対策が必要となります。
  • inputValueSanitizing
    Formに入力された値のサニタイジングを行うかどうか指定します。"true"もしくは"false"が指定可能です。
    true(省略時) : サニタイジングを行います。
    false : サニタイジングを行いません。
    例)inputValueSanitizing=false
    ※Version2.8.0 までは初期値が "false" でしたが、Version2.8.1 以降では "true" となります。
    サニタイジング対象となる文字は以下の通りです。
     「<」→「&lt;」
     「>」→「&gt;」
     「'」→「&#39;」
     「"」→「&quot;」
  • hiddenValueDecode [Version2.8.0以上]
    hidden属性が指定された input 内のエスケープされたvalue値をデコードするか指定します。"true"もしくは"false"が指定可能です。
    true : デコードを行います。
    false(省略時) : デコードを行いません。
    例)hiddenValueDecode=false
    ※デコード対象となる文字は以下の通りです。
     「&lt;」→「<」
     「&gt;」→「>」
     「&#39;」→「'」
     「&quot;」→「"」
     「&amp;」→「&」 [Version2.8.0(20090617)以上]
    ※「&#60;」「&#62;」「&apos;」「&#34;」「&#38;」はデコード対象となりません。
    ※hidden属性の変換時の扱いについては「FORM送信」をご覧ください。
  • metaResponse
    特定のmetaタグを出力するかどうかを指定します。"true"もしくは"false"が指定可能です。
    trueに設定した場合、"content-type", "expires", "cache-control" のmetaタグは削除せずに出力されます。
    true : metaタグを出力します。
    false(省略時) : metaタグを出力しません。
    例)metaResponse=true
    http-equiv 属性は値が "content-type","expires","cache-control","refresh" 以外は削除します。
    詳細は「<meta>」タグを参照ください。
  • useCrawlerMode [Version2.8.0以上]
    SEOサポート機能を有効にするか指定します。"true"もしくは"false"が指定可能です。
    true : クローラー向けの変換を行います。
    false(省略時) : 端末向けの変換を行います。
    例)useCrawlerMode=true
  • supportsXhtmlInput [Version2.8.0以上]
    レスポンスの Content-Type ヘッダを見てiモード対応XHTMLからの変換を行うか決定します。"true"もしくは"false"が指定可能です。
    true : Content-Typeヘッダを見て変換元を iモード対応HTMLかiモード対応XHTMLかを自動識別します。
    false(省略時) : 強制的に変換元を iモード対応HTMLとして変換を行います。
    例)supportsXhtmlInput=true
    ※Version2.8.1 までは初期値が "false" でしたが、Version2.8.2 以降では "true" となります。
    レスポンス時の Content-Type ヘッダの内容と変換結果については「Content-Typeの扱い」をご覧ください。
  • supportsSpacerImg [Version2.8.1以上]
    ページ内の同一画像に同一セッションパラメータを付与するか指定します。"true"もしくは"false"が指定可能です。
    trueに設定すると、スペーサ画像を多用している場合などはリクエストが効率化されます。
    true : 同じ名前の画像ファイルに対して同じセッションパラメータを付与します。
    false(省略時) : 同じ名前の画像ファイルでも異なるセッションパラメータを付与します(Version2.8.0以下と同じ動作)。
    ※Version2.8.1 までは初期値が "false" でしたが、Version2.8.2 以降では "true" となります。
  • separatePageType [Version2.9.0以上]
    ページ分割の方式を指定します。"1"もしくは"2"が指定可能です(省略時:2)。
    1 : Version2.8.x 以下と同様のページ分割を行う
    2(省略時) : ルートドキュメントサイズを考慮した分割を行う
    例)separatePageType=2
    ※separatePageType=2 とした場合、userAgent.limitSize の設定は無効となります。
    userAgent.limitSize で分割キャッシュサイズの上限を指定したい場合は separatePageType は "1" としてください。
  • formActionUIDThrough [Version2.9.0以上]
    <form> タグの POST を使用すると URL に特定のパラメータが付いている場合があるが、そのパラメータを削除するか指定します。"true"もしくは"false"が指定可能です。
    true : 特定のパラメータは削除しません。
    false(省略時) : 全てのパラメータを削除します。(Version2.8.3以下と同じ動作)
    ※特定のパラメータは以下の通りです。
     「uid=NULLGWDOCOMO」
     「uid=1&sid=XXX&pid=XXX」(XXXは任意)
     「guid=ON」 [Version2.10.2以上]
    ※Version 2.10.2 以上では POST だけでなく GET でもパラメータを削除するか指定することができます。
  • forceImagePictogram [Version2.10.0以上]
    絵文字変換において、iPhone端末、BlackBerry 8707h以外の全スマートフォンに対して画像絵文字を適用するか指定します。"true"もしくは"false"が指定可能です。
    true : iPhone端末、BlackBerry 8707h以外の全スマートフォンに対して画像絵文字を適用します。
    false(省略時) : iPhone端末、BlackBerry 8707h以外の全スマートフォンに対して、useragent.xml の PictogramType に指定されている端末ごとの絵文字を適用します。

必要の無い限り変更してはならない項目

  • encodingMap1
    Encoding指定とJava内のEncoding指定のマッピングを指定します。
    例)encodingMap1=Shift_JIS:MS932
  • xproxyAcceptType
    端末側とx-Servletの通信をKeep-Aliveで行うかを指定します。"1"もしくは"2"が指定可能です。
    SSL 環境下で運用する場合は"2"に設定することで端末上のポップアップウインドウを抑制できます。
    1 : Keep-Alive無効
    2(省略時) : Keep-Alive有効
    例)xproxyAcceptType=2
    ※詳細はKeep-Alive対応を参照ください。
    ※Version2.8.1 までは初期値が "1" でしたが、Version2.8.2 以降では "2" となります。
  • 注意:
    「xproxyAcceptType=1」とした場合、Version2.9.0以降に実装された機能の動作は非保証となります。
  • requestProcessor.threadPoolSize
    変換処理を行うスレッド数を指定します(省略時:100)。
    例)requestProcessor.threadPoolSize=100
    • xproxyAcceptType=2 の場合のみ有効です。
    • この値を超えたリクエストが発生してもエラーにはならず、スレッドの空きが発生するまで処理待ちとなります。
  • requestProcessor.maxKeepAliveRequest
    Keep-Aliveを維持する最大リクエスト数を指定します(省略時:7)。
    例)requestProcessor.maxKeepAliveRequest=7
    • xproxyAcceptType=2 の場合のみ有効です。
    • 最大リクエスト数の目安は
      「1ページ内に含まれる画像ファイル数 + 読み込む外部CSSファイル数 + 読み込む外部JavaScriptファイル数 + 読み込むFlashファイル数」+3(注)
      となります。
      (注) +3 は ページ自身のhtmlファイル + 画像絵文字用CSSファイル + 画像絵文字用GIFファイル を示します。
  • entrance2.requestTimeout
    ブラウザからのリクエストを待つ秒数を指定します(省略時:15)。
    例)entrance2.requestTimeout=15
    • xproxyAcceptType=2 の場合のみ有効です。
    • この値はタイムアウトの処理を開始する秒数となります。
      実際に回線が切断されるには更にcontentsSocketTimeoutで指定した秒数が経過してからとなります。
  • entrance2.timeoutCheckInterval
    entrance2.requestTimeout の設定値を超えたかどうかをチェックする時間間隔をミリ秒単位で指定します(省略時:200,100以上の必要あり)。
    例)entrance2.timeoutCheckInterval=200
    • xproxyAcceptType=2 の場合のみ有効です。
    • この値は「次のチェックまでのアイドル時間」なので実際の「ブラウザからのリクエストを待つ秒数」は

      entrance2.requestTimeout の値 + entrance2.timeoutCheckInterval の値

      となります。
  • webRequestExchangerClass
    x-Servletが使用するクラス名を指定します。
    例)webRequestExchangerClass=jp.co.flexfirm.xproxy.control.WebRequestExchanger
  • borderURIExchangerClass
    x-Servletが使用するクラス名を指定します。
    例)borderURIExchangerClass=jp.co.flexfirm.xproxy.control.rule.XProxyBorderURIExchanger
  • internalImageConvert.decideLoopCount
    [x-Servlet画像変換機能使用時のみ有効]
    ファイルサイズ自動調整機能を用いる際の打ち切り開始ループ回数を指定します(Default:3)。
    例)internalImageConvert.decideLoopCount=3
  • internalImageConvert.maxLoopCount
    [x-Servlet画像変換機能使用時のみ有効]
    ファイルサイズ自動調整機能を用いる際の最大ループ回数を指定します(Default:6)。
    例)internalImageConvert.maxLoopCount=6
  • userAgent.limitSize1
    機種情報のContentMaxBytesがこの値以上にならないように指定します。
    userAgent.limitSizeN=${MarkupLanguageName}:XXX
    例)userAgent.limitSize1=VHTML:4000
  • userAgent.minSize1
    機種情報のContentMaxBytesがこの値以下にならないように指定します。
    userAgent.minSizeN=${MarkupLanguageName}:XXX
    例)userAgent.minSize1=VHTML:1500
  • HDMLInputExpressionLevel ※現在はHDML端末のサービスは終了しているため変更の必要はありません。
    入力項目をHDMLで表現する際の表現レベルを指定します。"1"もしくは"2"が指定可能です。
    1 (省略時) : Version2.3.0以前と同様の出力する
    2 : 入力項目で'[[]]'のように括弧が重複することを抑制する
    例)HDMLInputExpressionLevel=2
  • HDMLSuppressBrAfterSelect ※現在はHDML端末のサービスは終了しているため変更の必要はありません。
    SELECTタグをHDMLで表現する際にタグの後ろで改行されるのを抑制します。"true"もしくは"false"が指定可能です。
    true : 抑制します。(<br>を出力しない)
    false(省略時) : 抑制しません。(<br>を出力する)
    例)HDMLSuppressBrAfterSelect=true
  • gpsDocomoURL
    オープンiエリア機能を使用するためのURL
    例)gpsDocomoURL=http://w1m.docomo.ne.jp/cp/iarea?ecode=OPENAREACODE&msn=OPENAREAKEY&nl=
  • gpsWillcomURL
    AIR-EDGE PHONEの位置情報通知機能を使用するためのURL
    例)gpsWillcomURL=http://location.request/dummy.cgi?my=
  • setBotUserAgent
    Bot検索用の機種情報定義を有効にするか指定します。"true"もしくは"false"が指定可能です。
    true : User-Agent のマッチングを厳密に行います。
    false(省略時) : 従来のバージョンと同じ機種判別を行います。
    例)setBotUserAgent=true
  • doctypeStringIXHTML [Version2.8.0以上]
    iモードXHTMLにおいて出力するDoctype宣言を指定します。
    例)doctypeStringIXHTML=<!DOCTYPE html PUBLIC "-//i-mode group (ja)//DTD XHTML i-XHTML(Locale/Ver.=ja/{0}) 1.0//EN" "i-xhtml_4ja_10.dtd">
  • doctypeStringXHTML
    auのxhtml端末に出力するDoctype宣言を指定します
    例)<!DOCTYPE html PUBLIC "-//OPENWAVE//DTD XHTML 1.0//EN" "http://www.openwave.com/DTD/xhtml-basic.dtd">
  • doctypeStringVHTML
    SoftBankのxhtml端末に出力するDoctype宣言を指定します。
    例)<!DOCTYPE html PUBLIC "-//J-PHONE//DTD XHTML Basic 1.0 Plus//EN" "xhtml-basic10-plus.dtd">
  • doctypeStringEXHTML
    EMOBILEのxhtml端末に出力するDoctype宣言を指定します。
    例)<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">
  • deleteLocationWillcomUid
    WILLCOMの個体識別情報をリダイレクトのURLから削除するか指定します。"true"もしくは"false"が指定可能です。
    true(省略時) : リダイレクトURLから pocketcuid および pocketpay パラメータを削除します。
    false : リダイレクトURLから pocketcuid および pocketpay パラメータを削除しません。
    例)deleteLocationWillcomUid=true
  • vodafoneEmbedParameters
    SoftBank端末の画像ファイル名の変換パターンを独自変換とするかどうかを指定します。"true"もしくは"false"が指定可能です。
    true : 独自変換を行う。他キャリアと違うML変換を行います。
    false(省略時) : 独自変換を行わない。他キャリアと同様のML変換を行います。
    例)vodafoneEmbedParameters=false

    以下のようなファイル名を変換した場合(SoftBank端末のみ)

    <img src="/jakarta-banner.gif">

    vodafoneEmbedParameters=false

    <img src="/jakarta-banner_xpimg_gif.png?_xpxi=M5csdsrWvm0dq47tNplOZh.21.stLhR-0.g">

    vodafoneEmbedParameters=true

    <img src="/_xpxi*M5csdsrWvm0dq47tNplOZh.21.stLhR-0.g*jakarta-banner_xpimg_gif.png">

    SoftBankの旧型端末では画像ファイル名にパラメータを付与できない制限があったため、本設定でパラメータをファイル名として埋め込みます。
    現在では旧型端末のサービスは終了しているため変更の必要はありません。

    Version2.9.0 以降では初期設定値が "false" となります。

変更してはならない項目 (旧Versionとの互換性のために残している項目)

  • extraction.ruleDir
    抽出ルールを格納しておくディレクトリを指定します。
    例)extraction.ruleDir=rules
  • extraction.deviceLevelFile
    デバイスレベルファイルを指定します。
    例)extraction.deviceLevelFile=conf/devicelevel.txt
  • extraction.ruleUpdateCheckInterval
    ルールが更新されているかチェックする時間間隔をミリ秒単位で指定します。
    例)extraction.ruleUpdateCheckInterval=60000
  • debugFunction
    デバッグ機能を有効にするか指定します。(指定しても動作は変化しない)
    例)debugFunction=false
  • localfile.documentRoot
    生成したローカルファイルを格納しておくルートディレクトリを指定します。
    例)localfile.documentRoot=localdocs
  • localfile.baseDir
    生成したローカルファイルを格納しておくベースディレクトリを指定します。
    例)localfile.baseDir=localdocs
  • localfile.typeDefine
    生成したローカルファイルに使用するMIMETypeを指定します。
    例)localfile.typeDefine=conf/mimetypes.properties
TOP