001    /*
002     * Copyright (c) 2009 The openGion Project.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *     http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013     * either express or implied. See the License for the specific language
014     * governing permissions and limitations under the License.
015     */
016    package org.opengion.fukurou.transfer;
017    
018    import java.io.IOException;
019    
020    import org.opengion.fukurou.db.Transaction;
021    import org.opengion.fukurou.util.StringUtil;
022    import org.opengion.fukurou.util.URLConnect;
023    
024    /**
025     * 莨晞?隕∵ｱゅ↓蟇ｾ縺励※縺ｮHTTP邨檎罰縺ｧ莨晞?蜃ｦ逅?ｒ螳溯｡後＠縺ｾ縺吶?
026     *
027     * 隱ｭ蜿匁婿豕輔↓繧医ｊ隱ｭ縺ｿ蜿悶▲縺溘ョ繝ｼ繧ｿ繧単OST繝??繧ｿ縺ｨ縺励※騾∽ｿ｡縺励?繝ｪ繝｢繝ｼ繝医?繧ｹ繝井ｸ翫〒
028     * 莨晞?蜃ｦ逅?ｒ螳溯｡後＠縺ｾ縺吶?
029     *
030     * 蜃ｦ逅??豬√ｌ縺ｨ縺励※縺ｯ莉･荳九?繧医≧縺ｫ縺ｪ繧翫∪縺吶?
031     * 竭?TTP縺ｧ莨晞?蜃ｦ逅?ｒ螳溯｡後☆繧九◆繧√?繧ｵ繝ｼ繝悶Ξ繝?ヨ繧貞他縺ｳ蜃ｺ縺吶?
032     * 竭｡竭?〒蜻ｼ縺ｳ蜃ｺ縺励＆繧後◆繧ｵ繝ｼ繝悶Ξ繝?ヨ縺後?莨晞?蜃ｦ逅?ｒ螳溯｡後☆繧九◆繧√?繧ｪ繝悶ず繧ｧ繧ｯ繝医ｒ逕滓?縺励?
033     *   莨晞?蜃ｦ逅?ｒ螳溯｡後☆繧九?
034     * 竭｢蜃ｦ逅?ｵゆｺ?ｾ後?莨晞?繝励Ο繧ｻ繧ｹ縺ｫ蛻ｶ蠕｡縺梧綾繧翫?隱ｭ蜿匁婿豕輔↓蝓ｺ縺･縺丞ｾ悟?逅?螳御ｺ??逅?∪縺溘?
035     *   繧ｨ繝ｩ繝ｼ蜃ｦ逅?縺悟ｮ溯｡後＆繧後∪縺吶?
036     *
037     * 縺ｾ縺壺蔵縺ｫ縺､縺?※縲∝他縺ｳ蜃ｺ縺励＆繧後ｋ繧ｵ繝ｼ繝悶Ξ繝?ヨ縺ｯ縲?
038     *   [繝ｪ繝｢繝ｼ繝域磁邯壼?URL]servlet/remoteControl?class=TransferExecWrapper 縺ｫ縺ｪ繧翫∪縺吶?
039     *   [繝ｪ繝｢繝ｼ繝域磁邯壼?URL]縺ｯ縲”ttp://[繝帙せ繝亥錐]:[繝昴?繝育分蜿ｷ]/[繧ｳ繝ｳ繝?く繧ｹ繝亥錐]縺ｮ蠖｢蠑上↓縺ｪ繧翫∪縺吶′縲?
040     *   縺薙ｌ縺ｫ縺､縺?※縺ｯ縲∝ｮ溯｡悟ｯｾ雎｡縺ｧ謖?ｮ壹＠縺ｾ縺吶?
041     * 谺｡縺ｫ竭｡縺ｫ縺､縺?※縲√し繝ｼ繝悶Ξ繝?ヨ邨檎罰縺ｧ螳溯｡後＆繧後ｋ莨晞?蜃ｦ逅?↓縺､縺?※縲√◎縺ｮ螳溯｡梧婿豕輔?縲?
042     *   蜈ｷ菴鍋噪縺ｫ縺ｯ縲√し繝悶け繝ｩ繧ｹ縺ｮ繧ｯ繝ｩ繧ｹ蜷阪↓蟇ｾ縺励※縲√％縺ｮ繧ｯ繝ｩ繧ｹ(隕ｪ繧ｯ繝ｩ繧ｹ)縺ｮ繧ｯ繝ｩ繧ｹ蜷?"_" 繧帝勁螟悶＠縺滄Κ蛻?′
043     *   螳溯｡梧婿豕輔→縺励※隱崎ｭ倥＆繧後∪縺吶?
044     *   蜈ｷ菴鍋噪縺ｫ縺ｯ縲√け繝ｩ繧ｹ蜷阪?譛?ｾ後?"_"(繧｢繝ｳ繝??繝舌?)莉･髯阪′螳溯｡梧婿豕輔→縺励※隱崎ｭ倥＆繧後?
045     *   萓九→縺励※縲√し繝悶け繝ｩ繧ｹ蜷阪′TransferExec_HTTP_CB01縺ｮ蝣ｴ蜷医?謗･邯壼?縺ｫ縺翫￠繧句ｮ溯｡梧婿豕輔?
046     *   譌ｧ莨晞?DB逋ｻ骭ｲ(CB01)縺ｨ縺ｪ繧翫∪縺吶?
047     *   縺ｾ縺溘?繝ｪ繝｢繝ｼ繝医?繧ｹ繝井ｸ翫〒螳溯｡後＆繧後ｋ莨晞?蜃ｦ逅??[繝ｪ繝｢繝ｼ繝亥ｮ溯｡悟ｯｾ雎｡]縺ｯ縲∝?縺ｮ螳溯｡悟ｯｾ雎｡縺ｧ險ｭ螳壹＠縺ｾ縺吶?
048     *   縺薙?縺薙→縺九ｉ縲？TTP邨檎罰縺ｧ莨晞?蜃ｦ逅?ｒ螳溯｡後☆繧句?蜷医?蜈??螳溯｡悟ｯｾ雎｡縺ｫ縺ｯ縲ー繝ｪ繝｢繝ｼ繝域磁邯壼?URL]縺ｨ
049     *   [繝ｪ繝｢繝ｼ繝亥ｮ溯｡悟ｯｾ雎｡]縺ｮ2縺､繧定ｨｭ螳壹☆繧句ｿ?ｦ√′縺ゅｊ縺ｾ縺吶?
050     *   蜈ｷ菴鍋噪縺ｪ險ｭ螳壽婿豕輔↓縺､縺?※縺ｯ蜷?し繝悶け繝ｩ繧ｹ縺ｮJavaDoc繧貞盾辣ｧ縺励※荳九＆縺??
051     * 譛?ｾ後↓竭｢縺ｫ縺､縺?※縲∵磁邯壽凾縺ｫ繧ｨ繝ｩ繝ｼ縺檎匱逕溘＠縺溷?蜷医ｄ縲√Ξ繧ｹ繝昴Φ繧ｹ繝??繧ｿ縺ｫ蟇ｾ縺励※"row_error"縺ｨ縺?≧
052     *   譁?ｭ怜?縺悟ｭ伜惠縺吶ｋ蝣ｴ蜷医?縲√お繝ｩ繝ｼ縺ｨ縺励※蜃ｦ逅?＠縺ｾ縺吶?
053     *   縺昴ｌ莉･螟悶?蝣ｴ蜷医?縲∵ｭ｣蟶ｸ邨ゆｺ?→縺励※蜃ｦ逅?＠縺ｾ縺吶?
054     *
055     * HTTP謗･邯壽凾縺ｫ縺ｯ縲∽ｻ･荳九?繝昴せ繝医ョ繝ｼ繧ｿ縺碁?菫｡縺輔ｌ縺ｾ縺吶?
056     * [繝昴せ繝医ョ繝ｼ繧ｿ]
057     * 繝ｻKBREAD                     (隱ｭ蜿匁婿豕?
058     * 繝ｻREADOBJ            (隱ｭ蜿門ｯｾ雎｡)
059     * 繝ｻREADPRM            (隱ｭ蜿悶ヱ繝ｩ繝｡繝ｼ繧ｿ繝ｼ)
060     * 繝ｻKBEXEC                     (螳溯｡梧婿豕? 窶ｻ繧ｵ繝悶け繝ｩ繧ｹ縺ｮ譛?ｾ後?"_"(繧｢繝ｳ繝??繝舌?)莉･髯阪?譁?ｭ怜?
061     * 繝ｻEXECDBID           (螳溯｡梧磁邯壼?DBID)
062     * 繝ｻEXECOBJ            (繝ｪ繝｢繝ｼ繝亥ｮ溯｡悟ｯｾ雎｡) 窶ｻ繝ｭ繝ｼ繧ｫ繝ｫ縺ｮ螳溯｡悟ｯｾ雎｡縺九ｉ繝ｪ繝｢繝ｼ繝域磁邯壼?URL繧帝勁縺?◆譁?ｭ怜?
063     * 繝ｻEXECPRM            (螳溯｡後ヱ繝ｩ繝｡繝ｼ繧ｿ繝ｼ)
064     * 繝ｻERROR_SENDTO       (隱ｭ縺ｿ蜿悶ｊ蜈??繧ｹ繝医さ繝ｼ繝?
065     * 繝ｻHFROM (隱ｭ縺ｿ蜿悶ｊ蜈??繧ｹ繝医さ繝ｼ繝?
066     * 繝ｻn (繝??繧ｿ莉ｶ謨ｰ)
067     * 繝ｻv1?柧n (繝??繧ｿ)
068     *
069     * @og.group 莨晞?繧ｷ繧ｹ繝?Β
070     *
071     * @version  5.0
072     * @author   Hiroki.Nakamura
073     * @since    JDK1.6
074     */
075    public abstract class TransferExec_HTTP implements TransferExec {
076    
077            // 繝ｪ繝｢繝ｼ繝亥宛蠕｡繧ｵ繝ｼ繝悶Ξ繝?ヨ蜷?
078            private static final String REMOTE_SERVLET = "servlet/remoteControl?class=TransferExecWrapper";
079    
080            /**
081             * URL謗･邯壹ｒ螳溯｡後＠縺ｾ縺吶?
082             *
083             * @param vals 莨晞?繝??繧ｿ(驟榊?)
084             * @param config 莨晞?險ｭ螳壹が繝悶ず繧ｧ繧ｯ繝?
085             * @param tran 繝医Λ繝ｳ繧ｶ繧ｯ繧ｷ繝ｧ繝ｳ繧ｪ繝悶ず繧ｧ繧ｯ繝?
086             */
087            @Override
088            public void execute( final String[] vals, final TransferConfig config, final Transaction tran ) {
089                    URLConnect conn = null;
090                    try {
091                            splitExecObj( config.getExecObj() );
092                            conn = new URLConnect( getRemoteHost() + REMOTE_SERVLET, TransferConfig.HTTP_AUTH_USER_PASS );
093                            if( config.getProxyHost() != null && config.getProxyHost().length() > 0 ) {
094                                    conn.setProxy( config.getProxyHost(), config.getProxyPort() );
095                            }
096    
097                            conn.setCharset( "UTF-8" );
098                            // 繝昴せ繝医ョ繝ｼ繧ｿ繧堤函謌舌＠縺ｾ縺吶?
099                            conn.setPostData( getPostData( vals, config ) );
100    
101                            conn.connect();
102    
103                            String readData = conn.readData();
104                            // 霑斐＆繧後◆繝??繧ｿ荳ｭ縺ｫ"row_error"縺悟ｭ伜惠縺吶ｋ蝣ｴ蜷医?繧ｨ繝ｩ繝ｼ縺ｨ縺励※蜃ｦ逅?＠縺ｾ縺吶?
105                            if( readData != null && readData.indexOf( "row_error" ) >= 0 ) {
106                                    throw new RuntimeException( readData );
107                            }
108                    }
109                    catch( IOException ex ) {
110                            String errMsg = "URL謗･邯壽凾縺ｫ萓句､悶′逋ｺ逕溘＠縺ｾ縺励◆縲?;
111                            throw new RuntimeException( errMsg, ex );
112                    }
113                    finally {
114                            if( conn != null ) { conn.disconnect(); }
115                    }
116            }
117    
118            /**
119             * 繝ｭ繝ｼ繧ｫ繝ｫ縺ｮ螳溯｡悟ｯｾ雎｡繧偵?繝ｪ繝｢繝ｼ繝域磁邯壼?縺ｮ螳溯｡悟ｯｾ雎｡縺ｨ繝ｪ繝｢繝ｼ繝域磁邯壼?URL縺ｫ蛻?ｧ｣縺励∪縺吶?
120             *
121             * @param localExecObj 繝ｭ繝ｼ繧ｫ繝ｫ縺ｮ螳溯｡悟ｯｾ雎｡
122             */
123            protected abstract void splitExecObj( final String localExecObj );
124    
125            /**
126             * 繝ｪ繝｢繝ｼ繝域磁邯壼?URL繧定ｿ斐＠縺ｾ縺吶?
127             * 縺薙?繝｡繧ｽ繝?ラ縺ｯ縲＋@link #splitExecObj(String)}縺ｮ蠕後↓蜻ｼ縺ｳ蜃ｺ縺励☆繧句ｿ?ｦ√′縺ゅｊ縺ｾ縺吶?
128             *
129             * @return 繝ｪ繝｢繝ｼ繝域磁邯壼?URL
130             */
131            protected abstract String getRemoteHost();
132    
133            /**
134             * 繝ｪ繝｢繝ｼ繝域磁邯壼?縺ｮ螳溯｡悟ｯｾ雎｡繧定ｿ斐＠縺ｾ縺吶?
135             * 縺薙?繝｡繧ｽ繝?ラ縺ｯ縲＋@link #splitExecObj(String)}縺ｮ蠕後↓蜻ｼ縺ｳ蜃ｺ縺励☆繧句ｿ?ｦ√′縺ゅｊ縺ｾ縺吶?
136             *
137             * @return 謗･邯啅RL
138             */
139            protected abstract String getRemoteExecObj();
140    
141            /**
142             * 莨晞?繝??繧ｿ蜿翫?莨晞?險ｭ螳壹ｒPOST繝??繧ｿ縺ｨ縺励※繧ｷ繝ｪ繧｢繝ｩ繧､繧ｺ縺励∪縺吶?
143             *
144             * @param vals 莨晞?繝??繧ｿ(驟榊?)
145             * @param config 莨晞?險ｭ螳壹が繝悶ず繧ｧ繧ｯ繝?
146             *
147             * @return 繝昴せ繝医ョ繝ｼ繧ｿ
148             */
149            private String getPostData( final String[] vals, final TransferConfig config ) {
150                    // 繧ｵ繝悶け繝ｩ繧ｹ蜷阪°繧芽ｦｪ繧ｯ繝ｩ繧ｹ蜷?"_"繧帝勁縺?◆驛ｨ蛻?ｒ螳溯｡梧婿豕輔→縺吶ｋ縲?
151                    String kbExec = getClass().getName().replace( getClass().getSuperclass().getName() + "_", "" );
152    
153                    StringBuilder buf = new StringBuilder();
154                    buf.append( "KBREAD="           ).append( StringUtil.urlEncode( config.getKbRead() ) );
155                    buf.append( "&READOBJ="             ).append( StringUtil.urlEncode( config.getReadObj() ) );
156                    buf.append( "&READPRM="             ).append( StringUtil.urlEncode( config.getReadPrm() ) );
157                    buf.append( "&KBEXEC="              ).append( StringUtil.urlEncode( kbExec ) );
158                    buf.append( "&EXECDBID="    ).append( StringUtil.urlEncode( config.getExecDbid() )  );
159                    buf.append( "&EXECOBJ="             ).append( StringUtil.urlEncode( getRemoteExecObj() ) );
160                    buf.append( "&EXECPRM="             ).append( StringUtil.urlEncode( config.getExecPrm() ) );
161                    buf.append( "&ERROR_SENDTO=").append( StringUtil.urlEncode( config.getErrorSendto() ) );
162                    buf.append( "&HFROM="               ).append( StringUtil.urlEncode( config.getHfrom() ) ) ;
163    
164                    if( vals != null && vals.length > 0 ) {
165                            buf.append( "&n=" ).append( vals.length );
166                            for( int i=0; i<vals.length; i++ ) {
167                                    buf.append( "&v" ).append( i ).append( "=" );
168                                    buf.append( StringUtil.urlEncode( vals[i] ) );
169                            }
170                    }
171                    else {
172                            buf.append( "&n=0" );
173                    }
174    
175                    return buf.toString();
176            }
177    }