Package me.saro.commons.web

Interface Web

  • All Known Implementing Classes:
    BasicWeb
    public interface Web
    Web Client
    Since:
    0.1
    Author:
    PARK Yong Seo

    • Method Detail

      • get

        static Web get​(java.lang.String url)
        create get method Web
        Parameters:
        url -
        Returns:

      • post

        static Web post​(java.lang.String url)
        create post method Web
        Parameters:
        url -
        Returns:

      • put

        static Web put​(java.lang.String url)
        create put method Web
        Parameters:
        url -
        Returns:

      • patch

        static Web patch​(java.lang.String url)
        create patch method Web
        Parameters:
        url -
        Returns:

      • delete

        static Web delete​(java.lang.String url)
        create delete method Web
        Parameters:
        url -
        Returns:

      • getRequestCharset

        java.lang.String getRequestCharset()
        request charset
        Returns:

      • getResponseCharset

        java.lang.String getResponseCharset()
        response charset
        Returns:

      • custom

        static Web custom​(java.lang.String url,
                  java.lang.String method)
        create custom method Web
        Parameters:
        url -
        Returns:

      • setConnectTimeout

        Web setConnectTimeout​(int connectTimeout)
        Connect Timeout
        Parameters:
        connectTimeout -
        Returns:

      • setReadTimeout

        Web setReadTimeout​(int readTimeout)
        Read Timeout
        Parameters:
        readTimeout -
        Returns:

      • setRequestCharset

        Web setRequestCharset​(java.lang.String charset)
        set request Charset
        Parameters:
        charset -
        Returns:

      • setResponseCharset

        Web setResponseCharset​(java.lang.String charset)
        set response charset
        Parameters:
        charset -
        Returns:

      • setIgnoreCertificate

        Web setIgnoreCertificate​(boolean ignoreCertificate)
        ignore https certificate
        this method not recommend
        ignore certificate is defenseless the MITM(man-in-the-middle attack)
        Parameters:
        ignoreCertificate -
        Returns:

      • addUrlParameter

        Web addUrlParameter​(java.lang.String name,
                    java.lang.String value)
        add url parameter
        always append url parameter even post method
        is not body write
        Parameters:
        name -
        value -
        Returns:

      • setHeader

        Web setHeader​(java.lang.String name,
              java.lang.String value)
        set header
        Parameters:
        name -
        value -
        Returns:

      • writeBody

        Web writeBody​(byte[] bytes)
        write body binary
        Parameters:
        bytes -
        Returns:

      • writeBodyParameter

        Web writeBodyParameter​(java.lang.String name,
                       java.lang.String value)
        writeBodyParameter
        WARNING : is not json type

        web
        .writeBodyParameter("aa", "11")
        .writeBodyParameter("bb", "22");
        equals
        aa=11&bb=22
        Parameters:
        name -
        value -
        Returns:

      • toCustom

        <R> WebResult<R> toCustom​(WebResult<R> result,
                          ThrowableFunction<java.io.InputStream,​R> function)
        to Custom result
        Parameters:
        result -
        function -
        Returns:

      • toCustom

        default <R> WebResult<R> toCustom​(ThrowableFunction<java.io.InputStream,​R> function)
        to Custom result
        Parameters:
        function -
        Returns:

      • toMapByJsonObject

        default WebResult<java.util.Map<java.lang.String,​java.lang.Object>> toMapByJsonObject()
        to Map result by JsonObject
        Returns:

      • toMapListByJsonArray

        default WebResult<java.util.List<java.util.Map<java.lang.String,​java.lang.Object>>> toMapListByJsonArray()
        to Map List result by JsonArray
        Returns:

      • toJsonTypeReference

        default <T> WebResult<T> toJsonTypeReference​(com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
        to Json result by TypeReference
        Parameters:
        typeReference -
        Returns:

      • toPlainText

        default WebResult<java.lang.String> toPlainText()
        to text result
        Returns:

      • saveFile

        default WebResult<java.io.File> saveFile​(java.io.File file,
                                         boolean overwrite)
        save file and return WebResult
        Returns:
        WebResult[WebResult]

      • readRawResultStream

        default WebResult<java.lang.String> readRawResultStream​(ThrowableConsumer<java.io.InputStream> reader)
        readRawResultStream
        Parameters:
        reader -
        Returns:
        it has Body

      • setContentType

        default Web setContentType​(java.lang.String value)
        set header ContentType
        Parameters:
        value -
        Returns:

      • setContentTypeApplicationJson

        default Web setContentTypeApplicationJson()
        ContentType application/json
        Returns:

      • writeBody

        default Web writeBody​(java.lang.String text)
        write Body text
        Parameters:
        text -
        Returns:

      • writeJsonByClass

        default Web writeJsonByClass​(java.lang.Object toJsonObject)
        write json class
        use jackson lib
        Parameters:
        toJsonObject -
        Returns:
        See Also:
        ObjectMapper