public class HttpCommunicator extends ngmObject
name | required | default | description |
HttpCommunicator.Url | NA | URL string | |
HttpCommunicator.Header.Set.name | NA | set the header value | |
HttpCommunicator.Parameter.Encoding | UTF-8 | encoding type for the parameter string | |
HttpCommunicator.Parameter.Set.name | NA | the named parameter value | |
HttpCommunicator.Content.Encoding | UTF-8 | encoding type for the response string | |
HttpCommunicator.Content.LineSeparator | system default | line separator for the response string : CR/LF/CRLF | |
HttpCommunicator.Content.ForceBinaryMode | false | if this is true, the content will be saved as a binary data. | |
HttpCommunicator.Error.Content.Encoding | UTF-8 | encoding type for the "ERROR" response string | |
HttpCommunicator.Debug.Log | NA | debug log filename | |
HttpCommunicator.Debug.Log.Message.ClipAt | 0 (no clipping) | messages will be clipped at specified length. | |
HttpCommunicator.Auth.User | NA | user for Authenticator | |
HttpCommunicator.Auth.Password | NA | password for Authenticator | |
HttpCommunicator.Timeout | java.net.URLCoonection default | timeout milliseconds for connect/read | |
HttpCommunicator.Connect.Timeout | java.net.URLCoonection default | timeout milliseconds for connect. This property overrides "HttpCommunicator.Timeout". | |
HttpCommunicator.Read.Timeout | 0 (no limit) | timeout milliseconds for read. This property overrides "HttpCommunicator.Timeout". | |
HttpCommunicator.Proxy.Address | NA | proxy host and port : "<host>:<port>" | |
HttpCommunicator.HandleCookie | false | if true, will use java.net.CookieManager as the default CookieHandler>:<port>" | |
HttpCommunicator.FollowRedirects | true | when false, will NOT follow redirect response |
name | default | description |
HttpCommunicator.Method.Patch.Enabled | false | If true, HttpURLConnection.methods will be overwritten and doPatch method will be enabled. |
HttpCommunicator.SSL.TrustAnyCert | false | If true, all SSL certificates will be trusted. |
(other) | All system properties for JVM http proxy will affect this class. |
修飾子とタイプ | クラスと説明 |
---|---|
static class |
HttpCommunicator.NullURLException |
C_BACKSLASH, C_BLOCK_CLOSE, C_BLOCK_OPEN, C_COMMA, C_CR, C_DOUBLE_BYTE_SPACE, C_DOUBLE_QUATATION, C_DOUBLE_QUOTATION, C_EQUAL, C_HYPHEN, C_LF, C_SINGLE_QUATATION, C_SINGLE_QUOTATION, C_SPACE, C_TAB, S_BACKSLASH, S_BLOCK_CLOSE, S_BLOCK_OPEN, S_COMMA, S_CR, S_CRLF, S_DOUBLE_QUATATION, S_DOUBLE_QUOTATION, S_EQUAL, S_HYPHEN, S_LF, S_SINGLE_QUATATION, S_SINGLE_QUOTATION, S_SPACE, S_TAB
修飾子とタイプ | メソッドと説明 |
---|---|
void |
addParameter(KeyValuePackage param) |
void |
addParameter(java.lang.String name,
boolean value) |
void |
addParameter(java.lang.String name,
long value) |
void |
addParameter(java.lang.String name,
java.lang.String value) |
void |
addParameters(java.util.ArrayList<KeyValuePackage> params) |
void |
addParameters(java.util.HashMap<java.lang.String,java.lang.String[]> params) |
void |
addParameters(KeyValuePackage[] params) |
void |
addParamFile(java.lang.String name,
java.io.File file_content)
ファイル名はfile_contentから、content_typeはファイル名を使用して MimetypesFileTypeMap.getDefaultFileTypeMap()により取得した値を使用する。
|
void |
addParamFile(java.lang.String name,
java.lang.String file_path)
ファイル名はfile_pathから、content_typeはファイル名を使用して MimetypesFileTypeMap.getDefaultFileTypeMap()により取得した値を使用する。
|
void |
addParamFile(java.lang.String name,
java.lang.String filename,
java.io.File file_content)
content_typeはファイル名を使用して MimetypesFileTypeMap.getDefaultFileTypeMap()により取得した値を使用する。
|
void |
addParamFile(java.lang.String name,
java.lang.String filename,
java.lang.String content_type,
byte[] binary_content) |
void |
addParamFile(java.lang.String name,
java.lang.String filename,
java.lang.String content_type,
java.io.File file_content) |
void |
addRequestHeader(KeyValuePackage header) |
void |
addRequestHeader(java.lang.String name,
boolean value) |
void |
addRequestHeader(java.lang.String name,
long value) |
void |
addRequestHeader(java.lang.String name,
java.lang.String value) |
void |
addRequestHeaders(KeyValuePackage[] headers) |
void |
clearParameters() |
void |
clearParamFiles() |
void |
clearRequestHeaders() |
void |
doDelete() |
void |
doGet() |
void |
doPatch()
When you use this method, the system property "HttpCommunicator.Method.Patch.Enabled" must be set to "true".
|
void |
doPost() |
void |
doPostMultipart() |
void |
doPut() |
java.lang.String |
formatQueryString() |
java.lang.String |
getAlias() |
int |
getConnectTimeout() |
java.lang.String |
getContentEncodingType() |
java.lang.String |
getContentLineSeparator() |
java.lang.String |
getContentType() |
java.lang.String |
getErrorContentEncodingType() |
byte[] |
getErrorResultBytes() |
java.lang.String |
getErrorResultBytesAsString() |
java.lang.String |
getErrorResultString() |
boolean |
getFollowRedirects() |
java.lang.String |
getParameterEncodingType() |
java.lang.String |
getProperty(java.lang.String key)
指定されたプロパティ値を取得する
|
java.net.Proxy |
getProxy() |
int |
getReadTimeout() |
FileResource |
getRequestBodyFile() |
TextContent |
getRequestBodyText() |
int |
getResponseCode() |
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getResponseHeaderMap() |
java.util.Iterator<java.lang.String> |
getResponseHeaderNames() |
java.lang.String |
getResponseHeaderValue(java.lang.String key) |
java.util.List<java.lang.String> |
getResponseHeaderValues(java.lang.String key) |
byte[] |
getResultBytes() |
java.lang.String |
getResultBytesAsString() |
java.lang.String |
getResultString() |
java.lang.String |
getURL() |
java.net.URL |
getURLAsURL() |
static void |
initializeSystemPropertiesForSSL(CoolProperties prop)
パラメタとして渡されたプロパティの値を用いてシステムプロパティjavax.net.ssl.
|
static HttpCommunicator |
newInstance() |
static HttpCommunicator |
newInstance(EZServletConfig config) |
static HttpCommunicator |
newInstance(EZServletConfig config,
java.lang.String alias)
プロパティキーHttpCommunicator.
|
static HttpCommunicator |
newInstance(EZServletContext context) |
static HttpCommunicator |
newInstance(EZServletContext context,
java.lang.String alias)
プロパティキーHttpCommunicator.
|
static HttpCommunicator |
newInstance(ngmObjectFunction o) |
static HttpCommunicator |
newInstance(ngmObjectFunction o,
java.lang.String alias)
プロパティキーHttpCommunicator.
|
static HttpCommunicator |
newInstance(java.util.Properties prop) |
static HttpCommunicator |
newInstance(java.util.Properties prop,
java.lang.String alias)
プロパティキーHttpCommunicator.
|
void |
parseQueryString(java.lang.String query_string) |
void |
setBasicAuthHeader(java.lang.String user,
java.lang.String pass)
ベーシック認証用のAuthenticationヘッダを生成し追加する。
|
void |
setConnectTimeout(int connect_timeout) |
void |
setContentEncodingType(java.lang.String content_enctype) |
void |
setContentLineSeparator(java.lang.String content_line_separator) |
void |
setCookieHandler() |
void |
setDebugLog(Log debug_log) |
void |
setErrorContentEncodingType(java.lang.String error_content_enctype) |
void |
setFollowRedirects(boolean follow_redirects) |
void |
setHCCookieHandler() |
void |
setParameterEncodingType(java.lang.String enctype) |
void |
setProxy(java.net.Proxy proxy) |
void |
setProxy(java.lang.String proxy_host_port) |
void |
setProxy(java.lang.String proxy_host,
int proxy_port) |
void |
setReadTimeout(int read_timeout) |
void |
setRequesetBody(TextContent request_body_text)
非推奨です。
|
void |
setRequestBody(FileResource request_body_file) |
void |
setRequestBody(TextContent request_body_text) |
static void |
setSSLSocketFactoryWithHostnameSensitiveKeyManager()
まだ仮実装なので、動作保証なしです。
|
void |
setURL(java.lang.String url_string)
"?"
|
void |
setURLDirect(java.lang.String url_string)
そのままjava.net.URLに使用される。
|
java.lang.String |
toString() |
clone, debug, debug, equals_n, equals_n2, getBooleanProperty, getBooleanProperty, getGroupedProperties, getIntProperty, getIntProperty, getLog, getLongProperty, getLongProperty, getProperties, getPropertiesForMe, getProperty, getShortProperty, getShortProperty, setLog, setNgmObject, setProperties, sysoutprintln
public static void initializeSystemPropertiesForSSL(CoolProperties prop)
キー | 必須 | 説明 |
KeyStore.Filename | * | キーストアのパス。 |
KeyStore.Type | キーストアタイプ。デフォルトは"pkcs12" | |
KeyStore.Password | * | キーストアのパスワード。 |
KeyStore.Password.CipherProcessor | キーストアのパスワードの暗号処理プロセッサクラス名。指定された場合のみパスワードの複合化処理を行う。 |
prop
- CipherProcessor
public static void setSSLSocketFactoryWithHostnameSensitiveKeyManager()
public static HttpCommunicator newInstance()
public static HttpCommunicator newInstance(java.util.Properties prop)
public static HttpCommunicator newInstance(ngmObjectFunction o)
public static HttpCommunicator newInstance(EZServletContext context)
public static HttpCommunicator newInstance(EZServletConfig config)
public static HttpCommunicator newInstance(java.util.Properties prop, java.lang.String alias)
prop
- alias
- public static HttpCommunicator newInstance(ngmObjectFunction o, java.lang.String alias)
o
- alias
- public static HttpCommunicator newInstance(EZServletContext context, java.lang.String alias)
context
- alias
- public static HttpCommunicator newInstance(EZServletConfig config, java.lang.String alias)
config
- alias
- public void setHCCookieHandler()
public void setCookieHandler()
public java.lang.String getAlias()
public java.lang.String getProperty(java.lang.String key)
ngmObject
getProperty
インタフェース内 ngmObjectFunction
getProperty
クラス内 ngmObject
key
- プロパティ名public java.net.URL getURLAsURL()
public void clearParameters()
public void clearParamFiles()
public void clearRequestHeaders()
@Deprecated public void setRequesetBody(TextContent request_body_text)
#setRequestBody(TextContent)}.
public void setRequestBody(TextContent request_body_text)
public TextContent getRequestBodyText()
public void setRequestBody(FileResource request_body_file)
public FileResource getRequestBodyFile()
public int getResponseCode()
public void setConnectTimeout(int connect_timeout)
public int getConnectTimeout()
public void setReadTimeout(int read_timeout)
public int getReadTimeout()
public boolean getFollowRedirects()
public void setFollowRedirects(boolean follow_redirects)
public void setProxy(java.lang.String proxy_host_port)
proxy_host_port
- "<host>:<port>"public void setProxy(java.lang.String proxy_host, int proxy_port)
public void setProxy(java.net.Proxy proxy)
public java.net.Proxy getProxy()
public void setDebugLog(Log debug_log)
public java.lang.String toString()
toString
クラス内 java.lang.Object
public void setURLDirect(java.lang.String url_string) throws java.net.MalformedURLException
url_string
- java.net.MalformedURLException
public void setURL(java.lang.String url_string) throws java.net.MalformedURLException
url_string
- java.net.MalformedURLException
public java.lang.String getURL()
public void addRequestHeader(java.lang.String name, java.lang.String value)
public void addRequestHeaders(KeyValuePackage[] headers)
public void addRequestHeader(KeyValuePackage header)
public void addRequestHeader(java.lang.String name, long value)
public void addRequestHeader(java.lang.String name, boolean value)
public void setBasicAuthHeader(java.lang.String user, java.lang.String pass)
user
- pass
- public void addParameter(java.lang.String name, java.lang.String value)
public void addParameters(KeyValuePackage[] params)
public void addParameters(java.util.ArrayList<KeyValuePackage> params)
public void addParameters(java.util.HashMap<java.lang.String,java.lang.String[]> params)
public void addParameter(KeyValuePackage param)
public void addParameter(java.lang.String name, long value)
public void addParameter(java.lang.String name, boolean value)
public void addParamFile(java.lang.String name, java.lang.String filename, java.lang.String content_type, java.io.File file_content)
public void addParamFile(java.lang.String name, java.lang.String filename, java.lang.String content_type, byte[] binary_content)
public void addParamFile(java.lang.String name, java.io.File file_content)
name
- file_content
- public void addParamFile(java.lang.String name, java.lang.String file_path)
name
- file_content
- public void addParamFile(java.lang.String name, java.lang.String filename, java.io.File file_content)
name
- filename
- file_content
- public void setParameterEncodingType(java.lang.String enctype)
public java.lang.String getParameterEncodingType()
public java.lang.String getContentType()
public void setContentEncodingType(java.lang.String content_enctype)
public java.lang.String getContentEncodingType()
public void setContentLineSeparator(java.lang.String content_line_separator)
public java.lang.String getContentLineSeparator()
public void setErrorContentEncodingType(java.lang.String error_content_enctype)
public java.lang.String getErrorContentEncodingType()
public void parseQueryString(java.lang.String query_string)
public java.lang.String formatQueryString()
public java.lang.String getResultString()
public byte[] getResultBytes()
public java.lang.String getResultBytesAsString() throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public java.lang.String getErrorResultString()
public byte[] getErrorResultBytes()
public java.lang.String getErrorResultBytesAsString() throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public void doGet() throws java.io.IOException
java.io.IOException
public void doDelete() throws java.io.IOException
java.io.IOException
public void doPost() throws java.io.IOException
java.io.IOException
public void doPut() throws java.io.IOException
java.io.IOException
public void doPatch() throws java.io.IOException
java.io.IOException
public void doPostMultipart() throws java.io.IOException, javax.mail.MessagingException
java.io.IOException
javax.mail.MessagingException
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaderMap()
public java.util.Iterator<java.lang.String> getResponseHeaderNames()
public java.util.List<java.lang.String> getResponseHeaderValues(java.lang.String key)
public java.lang.String getResponseHeaderValue(java.lang.String key)