com.flickr4java.flickr

Class Transport

java.lang.Object

com.flickr4java.flickr.Transport

Direct Known Subclasses:

REST

public abstract class Transport
extends java.lang.Object

The abstract Transport class provides a common interface for transporting requests to the Flickr servers. Flickr offers several transport methods including REST, SOAP and XML-RPC. Flickr4Java currently implements the REST transport and work is being done to include the SOAP transport.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	API_HOST
protected java.lang.Class<?>	responseClass
static java.lang.String	REST
static java.lang.String	SOAP

Constructor Summary

Constructors

Constructor and Description
Transport()

Method Summary

Methods

Modifier and Type	Method and Description
abstract 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.
java.lang.String	getHost()
abstract 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	getPath()
int	getPort()
java.lang.String	getTransportType()
Response	post(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String sharedSecret) Invoke an HTTP POST request on a remote host.
abstract 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	setHost(java.lang.String host)
void	setPath(java.lang.String path)
void	setPort(int port)
void	setResponseClass(java.lang.Class<?> responseClass)
void	setTransportType(java.lang.String transport)

Methods inherited from class java.lang.Object

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

Field Detail

REST

public static final java.lang.String REST

See Also:

Constant Field Values

SOAP

public static final java.lang.String SOAP

See Also:

Constant Field Values

API_HOST

protected static final java.lang.String API_HOST

See Also:

Constant Field Values

responseClass

protected java.lang.Class<?> responseClass

Constructor Detail

Transport

public Transport()

Method Detail

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getPort

public int getPort()

setPort

public void setPort(int port)

getTransportType

public java.lang.String getTransportType()

setTransportType

public void setTransportType(java.lang.String transport)

getPath

public java.lang.String getPath()

setPath

public void setPath(java.lang.String path)

get

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

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

Parameters:

path - The request path

parameters - The parameters (collection of Parameter objects)

sharedSecret -

Returns:

The Response

Throws:

FlickrException

post

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

Invoke an HTTP POST request on a remote host.

Parameters:

path - The request path

parameters - The parameters (List of Parameter objects)

sharedSecret -

Returns:

The Response object

Throws:

FlickrException

post

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

Invoke an HTTP POST request on a remote host.

Parameters:

path - The request path

parameters - The parameters (List of Parameter objects)

sharedSecret -

Returns:

The Response object

Throws:

FlickrException

getNonOAuth

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

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

Parameters:

path - The request path

parameters - The parameters

Returns:

The Response

Throws:

FlickrException

setResponseClass

public void setResponseClass(java.lang.Class<?> responseClass)