com.flickr4java.flickr

Class REST

java.lang.Object

com.flickr4java.flickr.Transport

com.flickr4java.flickr.REST

public class REST
extends Transport

Transport implementation using the REST interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH

Fields inherited from class com.flickr4java.flickr.Transport

API_HOST, responseClass, REST, SOAP

Constructor Summary

Constructors

Constructor and Description
REST() Construct a new REST transport instance.
REST(java.lang.String host) Construct a new REST transport instance using the specified host endpoint.
REST(java.lang.String host, int port) Construct a new REST transport instance using the specified host and port endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
Response	get(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String sharedSecret) Invoke an HTTP GET request on a remote host.
Response	getNonOAuth(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters) Invoke a non OAuth HTTP GET request on a remote host.
java.lang.String	getProxyCredentials() Generates Base64-encoded credentials from locally stored username and password.
boolean	isProxyAuth()
Response	post(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String sharedSecret, boolean multipart) Invoke an HTTP POST request on a remote host.
void	setConnectTimeoutMs(java.lang.Integer connectTimeoutMs)
void	setProxy(java.lang.String proxyHost, int proxyPort) Set a proxy for REST-requests.
void	setProxy(java.lang.String proxyHost, int proxyPort, java.lang.String username, java.lang.String password) Set a proxy with authentication for REST-requests.
void	setReadTimeoutMs(java.lang.Integer readTimeoutMs)

Methods inherited from class com.flickr4java.flickr.Transport

getHost, getPath, getPort, getTransportType, post, setHost, setPath, setPort, setResponseClass, setTransportType

Methods inherited from class java.lang.Object

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

Field Detail

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

Constructor Detail

REST

public REST()

Construct a new REST transport instance.

REST

public REST(java.lang.String host)

Construct a new REST transport instance using the specified host endpoint.

Parameters:

host - The host endpoint

REST

public REST(java.lang.String host,
    int port)

Construct a new REST transport instance using the specified host and port endpoint.

Parameters:

host - The host endpoint

port - The port

Method Detail

setProxy

public void setProxy(java.lang.String proxyHost,
            int proxyPort)

Set a proxy for REST-requests.

Parameters:

proxyHost -

proxyPort -

setProxy

public void setProxy(java.lang.String proxyHost,
            int proxyPort,
            java.lang.String username,
            java.lang.String password)

Set a proxy with authentication for REST-requests.

Parameters:

proxyHost -

proxyPort -

username -

password -

get

public Response get(java.lang.String path,
           java.util.Map<java.lang.String,java.lang.Object> parameters,
           java.lang.String sharedSecret)

Invoke an HTTP GET request on a remote host. You must close the InputStream after you are done with.

Specified by:

get in class Transport

Parameters:

path - The request path

parameters - The parameters (collection of Parameter objects)

Returns:

The Response

getNonOAuth

public Response getNonOAuth(java.lang.String path,
                   java.util.Map<java.lang.String,java.lang.String> parameters)

Invoke a non OAuth HTTP GET request on a remote host. This is only used for the Flickr OAuth methods checkToken and getAccessToken.

Specified by:

getNonOAuth in class Transport

Parameters:

path - The request path

parameters - The parameters

Returns:

The Response

post

public Response post(java.lang.String path,
            java.util.Map<java.lang.String,java.lang.Object> parameters,
            java.lang.String sharedSecret,
            boolean multipart)

Invoke an HTTP POST request on a remote host.

Specified by:

post in class Transport

Parameters:

path - The request path

parameters - The parameters (collection of Parameter objects)

Returns:

The Response object

isProxyAuth

public boolean isProxyAuth()

getProxyCredentials

public java.lang.String getProxyCredentials()

Generates Base64-encoded credentials from locally stored username and password.

Returns:

credentials

setConnectTimeoutMs

public void setConnectTimeoutMs(java.lang.Integer connectTimeoutMs)

setReadTimeoutMs

public void setReadTimeoutMs(java.lang.Integer readTimeoutMs)