org.riversun.jaxy

Class JaxyClient

java.lang.Object

org.riversun.jaxy.JaxyClient

public class JaxyClient
extends Object

This class can give you
Easy access to JSON and XML by using JaxyNode(JsonNode and XmlNode)

- JSON to JsonNode
- XML to XmlNode

Author:

Tom Misawa (riversun.org@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JaxyClient.SourceCodeGenerator

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_METHOD_GET_METHOD
static String	HTTP_METHOD_POST_METHOD
static String	HTTPS_ALG_SSL
static String	HTTPS_ALG_TLS
Set<String>	mForceIndexedParameterNameSet

Constructor Summary

Constructors

Constructor and Description
JaxyClient()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Map<String,String[]> parameterMap)
void	addParameter(String parameterName, double doubleParameterValue)
void	addParameter(String parameterName, float floatParameterValue)
void	addParameter(String parameterName, int intParameterValue)
void	addParameter(String parameterName, long longParameterValue)
void	addParameter(String parameterName, String parameterValue)
void	addParameter(String parameterName, String[] parameterValue)
void	addParameter(String parameterName, String parameterValue, boolean isNeedUrlEncodeParameterValue)
void	addRequestHeader(String headerName, String headerValue) Add header value to http(s) request header
String	doHttpRequest()
JaxyClient.SourceCodeGenerator	gen()
String	getEncoding()
String	getEndpointUrl()
JsonNode	getJson() retrieve json formatted data from network and get as JsonNode
JsonNode	getJson(String jsonText) Get JsonNode from json formatted file
String	getLatestRequestRawUrl() returns raw RequestUrl of latest request
String	getLatestRequestUrl()
protected Map	getParameterMap()
String	getProxyHost()
String	getQueryParamString()
String	getText() Get as plain text from network
String	getTextFormUrl(URL url) retrieve text from net
XmlNode	getXml() retrieve xml formatted data from network and get as XmlNode
XmlNode	getXml(Document doc) Deprecated.
XmlNode	getXml(File file) Get XmlNode from xml formatted file
XmlNode	getXml(String xmlFormattedText) Transform Xml formatted data into XmlNode
XmlNode	getXml(URL url) Retrieve xml formatted data from url and get as XmlNode
JaxyClient	setBasicAuthUserNameAndPassword(String userName, String password) Set userName and password for BasicAuth This method is available after calling setUseBasicAuth(boolean) with 'true'
void	setEncoding(String encoding)
void	setEndpointUrl(String endpointUrl)
void	setForceIndexedParameterName(String parameterName) Force add the array index into the selected parameterName
void	setHttpMethod(String requestMethod)
void	setProxy(String proxyHost, int proxyPort)
JaxyClient	setSSLAlgorithm(String sslAlgorithm)
JaxyClient	setTimeoutMillis(int millis)
JaxyClient	setUseBasicAuth(boolean useBasicAuth) Set use http basic auth
void	setUseCDATA(boolean useCDATA)
void	setUserAgent(String userAgent) Add 'User-Agent' into request header

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_METHOD_GET_METHOD

public static final String HTTP_METHOD_GET_METHOD

See Also:

Constant Field Values

HTTP_METHOD_POST_METHOD

public static final String HTTP_METHOD_POST_METHOD

See Also:

Constant Field Values

HTTPS_ALG_SSL

public static final String HTTPS_ALG_SSL

See Also:

Constant Field Values

HTTPS_ALG_TLS

public static final String HTTPS_ALG_TLS

See Also:

Constant Field Values

mForceIndexedParameterNameSet

public Set<String> mForceIndexedParameterNameSet

Constructor Detail

JaxyClient

public JaxyClient()

Method Detail

setSSLAlgorithm

public JaxyClient setSSLAlgorithm(String sslAlgorithm)

setUserAgent

public void setUserAgent(String userAgent)

Add 'User-Agent' into request header

Parameters:

userAgent -

addRequestHeader

public void addRequestHeader(String headerName,
                             String headerValue)

Add header value to http(s) request header

Parameters:

headerName -

headerValue -

getJson

public JsonNode getJson()
                 throws JaxyClientNetworkException

retrieve json formatted data from network and get as JsonNode

Returns:

JsonNode

Throws:

JaxyClientNetworkException

getJson

public JsonNode getJson(String jsonText)

Get JsonNode from json formatted file

Parameters:

jsonText -

Returns:

getXml

public XmlNode getXml()
               throws JaxyClientNetworkException

retrieve xml formatted data from network and get as XmlNode

Returns:

XmlNode

Throws:

JaxyClientNetworkException

getXml

@Deprecated
public XmlNode getXml(Document doc)

Deprecated.

Get XmlNode from w3c document

Parameters:

doc -

Returns:

getXml

public XmlNode getXml(File file)

Get XmlNode from xml formatted file

Parameters:

file -

Returns:

getXml

public XmlNode getXml(URL url)
               throws JaxyClientNetworkException

Retrieve xml formatted data from url and get as XmlNode

Parameters:

url -

Returns:

Throws:

JaxyClientNetworkException

getXml

public XmlNode getXml(String xmlFormattedText)

Transform Xml formatted data into XmlNode

Parameters:

xmlFormattedText -

Returns:

getText

public String getText()
               throws JaxyClientNetworkException

Get as plain text from network

Returns:

Throws:

JaxyClientNetworkException

setBasicAuthUserNameAndPassword

public JaxyClient setBasicAuthUserNameAndPassword(String userName,
                                                  String password)

Set userName and password for BasicAuth

This method is available after calling setUseBasicAuth(boolean) with 'true'

Parameters:

userName -

password -

Returns:

setUseBasicAuth

public JaxyClient setUseBasicAuth(boolean useBasicAuth)

Set use http basic auth

Parameters:

useBasicAuth -

Returns:

setTimeoutMillis

public JaxyClient setTimeoutMillis(int millis)

setForceIndexedParameterName

public void setForceIndexedParameterName(String parameterName)

Force add the array index into the selected parameterName

Parameters:

parameterName -

getParameterMap

protected Map getParameterMap()

setHttpMethod

public void setHttpMethod(String requestMethod)

addParameter

public void addParameter(Map<String,String[]> parameterMap)

addParameter

public void addParameter(String parameterName,
                         String parameterValue)

addParameter

public void addParameter(String parameterName,
                         String parameterValue,
                         boolean isNeedUrlEncodeParameterValue)

addParameter

public void addParameter(String parameterName,
                         String[] parameterValue)

addParameter

public void addParameter(String parameterName,
                         int intParameterValue)

addParameter

public void addParameter(String parameterName,
                         long longParameterValue)

addParameter

public void addParameter(String parameterName,
                         float floatParameterValue)

addParameter

public void addParameter(String parameterName,
                         double doubleParameterValue)

getTextFormUrl

public String getTextFormUrl(URL url)
                      throws JaxyClientNetworkException

retrieve text from net

Returns:

Throws:

JaxyClientNetworkException

doHttpRequest

public String doHttpRequest()
                     throws JaxyClientNetworkException

Throws:

JaxyClientNetworkException

getLatestRequestRawUrl

public String getLatestRequestRawUrl()

returns raw RequestUrl of latest request

Returns:

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getProxyHost

public String getProxyHost()

setProxy

public void setProxy(String proxyHost,
                     int proxyPort)

getEndpointUrl

public String getEndpointUrl()

setEndpointUrl

public void setEndpointUrl(String endpointUrl)

setUseCDATA

public void setUseCDATA(boolean useCDATA)

getQueryParamString

public String getQueryParamString()

getLatestRequestUrl

public String getLatestRequestUrl()

gen

public JaxyClient.SourceCodeGenerator gen()