org.thales.punch.libraries.punchlang.operator

Class HttpOperator

java.lang.Object

org.thales.punch.libraries.punchlang.operator.HttpOperator

public class HttpOperator
extends Object

 Tuple resource = http("https://your.resource.server/resource.csv")
                  .header("Authorization", "Bearer: mytoken")
                  .post(body)

                  // this part is specific to a JSON body response
                  .asTuple();
 

Field Summary

Fields

Modifier and Type	Field and Description
protected RuntimeContext	runtimeContext The caller punchlet runtime context.
protected String	url The remote or local resource url.

Constructor Summary

Constructors

Constructor and Description
HttpOperator(RuntimeContext r, String url) Ctor.

Method Summary

Modifier and Type	Method and Description
String	asString() Get response as plain string text
Tuple	asTuple() Get response as Tuple
HttpOperator	data(String body) Http POST and PUT data as plain string
HttpOperator	data(Tuple body) Http POST and PUT data as plain string
HttpOperator	get() Set request as GET.
HttpOperator	header(String key, String value) Add an http header
HttpOperator	method(String method) Set request method
HttpOperator	post() Set request as POST
HttpOperator	put() Set request as PUT
HttpOperator	timeout(int timeout)

Methods inherited from class java.lang.Object

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

Field Detail

url

protected final String url

The remote or local resource url. Must start by "https://", "http:" or "file:".

runtimeContext

protected final RuntimeContext runtimeContext

The caller punchlet runtime context.

Constructor Detail

HttpOperator

public HttpOperator(RuntimeContext r,
                    String url)

Ctor.

Parameters:

r - the punchlet runtime context.

url - an http url.

Method Detail

method

public HttpOperator method(String method)

Set request method

Returns:

post

public HttpOperator post()

Set request as POST

Returns:

put

public HttpOperator put()

Set request as PUT

Returns:

get

public HttpOperator get()

Set request as GET. Default value

Returns:

timeout

public HttpOperator timeout(int timeout)

header

public HttpOperator header(String key,
                           String value)

Add an http header

Parameters:

key -

value -

Returns:

data

public HttpOperator data(String body)

Http POST and PUT data as plain string

Parameters:

body - as String

Returns:

data

public HttpOperator data(Tuple body)

Http POST and PUT data as plain string

Parameters:

body - as tuple

Returns:

asString

public String asString()

Get response as plain string text

Returns:

asTuple

public Tuple asTuple()

Get response as Tuple

Returns: