lib.easyjava.net.rest

Class SimpleRESTClient

java.lang.Object

lib.easyjava.net.rest.SimpleRESTClient

public class SimpleRESTClient
extends java.lang.Object

Easy REST and Web requests not involving a lot of header manipulation.

Author:

Rob Rua (robrua@alumni.cmu.edu)

Constructor Summary

Constructors

Constructor and Description
SimpleRESTClient(java.lang.String URL)
SimpleRESTClient(java.lang.String URL, java.lang.String userAgent)

Method Summary

Modifier and Type	Method and Description
java.lang.String	delete() Sends a DELETE request to the base URL
java.lang.String	delete(java.lang.String URI) Sends a DELETE to the given URI from the base URL
static java.lang.String	deleteAt(java.lang.String URL) Sends a DELETE to the given URL
java.lang.String	get() Sends a GET request with no parameters to the base URL
java.lang.String	get(java.util.Map<java.lang.String,java.lang.String> parameters) Sends a GET request with the given parameters to the base URL
java.lang.String	get(java.lang.String URI) Sends a GET request with no parameters to the given URI from the base URL
java.lang.String	get(java.lang.String URI, java.util.Map<java.lang.String,java.lang.String> parameters) Sends a GET request with the given parameters to the given URI from the base URL
static java.lang.String	getFrom(java.lang.String URL) Sends a GET request with no parameters to the given URL
static java.lang.String	getFrom(java.lang.String URL, java.util.Map<java.lang.String,java.lang.String> parameters) Sends a GET request with the given parameters to the given URL
java.lang.String	post(java.lang.String postContent) Sends a POST request with the given content to the base URL using the "test/plain" MIME type
java.lang.String	post(java.lang.String contentType, java.lang.String postContent) Sends a POST request with the given content to the base URL using the given MIME type
java.lang.String	post(java.lang.String URI, java.lang.String contentType, java.lang.String postContent) Sends a POST request with the given content to the given URI from the base URL using the given MIME type
static java.lang.String	postTo(java.lang.String URL, java.lang.String postContent) Sends a POST request with the given content to the given URL using the "text/plain" MIME type
static java.lang.String	postTo(java.lang.String URL, java.lang.String contentType, java.lang.String postContent) Sends a POST request with the given content to the given URL using the given MIME type
java.lang.String	put(java.lang.String putContent) Sends a PUT request with the given content to the base URL using the "test/plain" MIME type
java.lang.String	put(java.lang.String contentType, java.lang.String putContent) Sends a PUT request with the given content to the base URL using the given MIME type
java.lang.String	put(java.lang.String URI, java.lang.String contentType, java.lang.String putContent) Sends a PUT request with the given content to the given URI from the base URL using the given MIME type
static java.lang.String	putTo(java.lang.String URL, java.lang.String putContent) Sends a PUT request with the given content to the given URL using the "text/plain" MIME type
static java.lang.String	putTo(java.lang.String URL, java.lang.String contentType, java.lang.String putContent) Sends a PUT request with the given content to the given URL using the given MIME type
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleRESTClient

public SimpleRESTClient(java.lang.String URL)

Parameters:

URL - the base URL that the REST requests are being made to

SimpleRESTClient

public SimpleRESTClient(java.lang.String URL,
                        java.lang.String userAgent)

Parameters:

URL - the base URL that the REST requests are being made to

userAgent - the user agent to send with requests

Method Detail

deleteAt

public static java.lang.String deleteAt(java.lang.String URL)
                                 throws java.io.IOException

Sends a DELETE to the given URL

Parameters:

URL - the URL to send a delete request to

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

getFrom

public static java.lang.String getFrom(java.lang.String URL)
                                throws java.io.IOException

Sends a GET request with no parameters to the given URL

Parameters:

URL - the URL to send a get request to

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

getFrom

public static java.lang.String getFrom(java.lang.String URL,
                                       java.util.Map<java.lang.String,java.lang.String> parameters)
                                throws java.io.IOException

Sends a GET request with the given parameters to the given URL

Parameters:

URL - the URL to send a get request to

parameters - the parameters to send with the request

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

postTo

public static java.lang.String postTo(java.lang.String URL,
                                      java.lang.String postContent)
                               throws java.io.IOException

Sends a POST request with the given content to the given URL using the "text/plain" MIME type

Parameters:

URL - the URL to send a post request to

postContent - the plain text content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

postTo

public static java.lang.String postTo(java.lang.String URL,
                                      java.lang.String contentType,
                                      java.lang.String postContent)
                               throws java.io.IOException

Sends a POST request with the given content to the given URL using the given MIME type

Parameters:

URL - the URL to send a post request to

contentType - the MIME type of the content

postContent - the content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

putTo

public static java.lang.String putTo(java.lang.String URL,
                                     java.lang.String putContent)
                              throws java.io.IOException

Sends a PUT request with the given content to the given URL using the "text/plain" MIME type

Parameters:

URL - the URL to send a put request to

putContent - the plain text content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

putTo

public static java.lang.String putTo(java.lang.String URL,
                                     java.lang.String contentType,
                                     java.lang.String putContent)
                              throws java.io.IOException

Sends a PUT request with the given content to the given URL using the given MIME type

Parameters:

URL - the URL to send a put request to

contentType - the MIME type of the content

putContent - the content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

delete

public java.lang.String delete()
                        throws java.io.IOException

Sends a DELETE request to the base URL

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

delete

public java.lang.String delete(java.lang.String URI)
                        throws java.io.IOException

Sends a DELETE to the given URI from the base URL

Parameters:

URI - the resource to access

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

get

public java.lang.String get()
                     throws java.io.IOException

Sends a GET request with no parameters to the base URL

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

get

public java.lang.String get(java.util.Map<java.lang.String,java.lang.String> parameters)
                     throws java.io.IOException

Sends a GET request with the given parameters to the base URL

Parameters:

parameters - the parameters to send with the request

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

get

public java.lang.String get(java.lang.String URI)
                     throws java.io.IOException

Sends a GET request with no parameters to the given URI from the base URL

Parameters:

URI - the resource to access

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

get

public java.lang.String get(java.lang.String URI,
                            java.util.Map<java.lang.String,java.lang.String> parameters)
                     throws java.io.IOException

Sends a GET request with the given parameters to the given URI from the base URL

Parameters:

URI - the resource to access

parameters - the parameters to send with the request

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

post

public java.lang.String post(java.lang.String postContent)
                      throws java.io.IOException

Sends a POST request with the given content to the base URL using the "test/plain" MIME type

Parameters:

postContent - the plain text content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

post

public java.lang.String post(java.lang.String contentType,
                             java.lang.String postContent)
                      throws java.io.IOException

Sends a POST request with the given content to the base URL using the given MIME type

Parameters:

contentType - the MIME type of the content

postContent - the content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

post

public java.lang.String post(java.lang.String URI,
                             java.lang.String contentType,
                             java.lang.String postContent)
                      throws java.io.IOException

Sends a POST request with the given content to the given URI from the base URL using the given MIME type

Parameters:

URI - the resource to access

contentType - the MIME type of the content

postContent - the content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

put

public java.lang.String put(java.lang.String putContent)
                     throws java.io.IOException

Sends a PUT request with the given content to the base URL using the "test/plain" MIME type

Parameters:

putContent - the plain text content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

put

public java.lang.String put(java.lang.String contentType,
                            java.lang.String putContent)
                     throws java.io.IOException

Sends a PUT request with the given content to the base URL using the given MIME type

Parameters:

contentType - the MIME type of the content

putContent - the content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

put

public java.lang.String put(java.lang.String URI,
                            java.lang.String contentType,
                            java.lang.String putContent)
                     throws java.io.IOException

Sends a PUT request with the given content to the given URI from the base URL using the given MIME type

Parameters:

URI - the resource to access

contentType - the MIME type of the content

putContent - the content to send

Returns:

the server's response

Throws:

java.io.IOException - if the request failed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object