org.jickr
Class Flickr

java.lang.Object
  extended by org.jickr.Flickr

public class Flickr
extends java.lang.Object

Flickr access information. Also includes some static methods to perform certain generic tasks.


Method Summary
static java.lang.String getApiKey()
          Get the API key, after having stored it via setApiKey.
static java.lang.String getBase()
          Get the base URL for all requests.
static java.lang.String getSharedSecret()
          Get the Shared Secret for this app.
static void setApiKey(java.lang.String newApiKey)
          Set the API key for use in other parts of the library.
static void setSharedSecret(java.lang.String newSharedSecret)
          Set the shared secret for use in other parts of the library.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setApiKey

public static void setApiKey(java.lang.String newApiKey)
Set the API key for use in other parts of the library. Note: This should be the only place where you have to know your API key. You'll need to get your key from the Flickr API site.

Note: This call has the side effect of setting java.net.useSystemProxies to true. If you don't know what that means, don't worry about it.

Parameters:
newApiKey - Flickr API key

getApiKey

public static java.lang.String getApiKey()
Get the API key, after having stored it via setApiKey. This call should be made after Flickr.setApiKey(), or an exception will be thrown.

Returns:
apiKey The Flickr API key.
See Also:
setApiKey(String)

setSharedSecret

public static void setSharedSecret(java.lang.String newSharedSecret)
Set the shared secret for use in other parts of the library. Note: This should be the only place where you have to know your Shared Secret. You'll need to get the Shared Secret from Flickr at the same place you get your API Key. Setting the Shared Secret also signs all requests automatically.

Parameters:
newSharedSecret - Flickr Shared Secret

getSharedSecret

public static java.lang.String getSharedSecret()
Get the Shared Secret for this app. Attempts to call this method before Flickr.setSharedSecret() will result in an exception.

Returns:
The shared secret.
See Also:
setSharedSecret(String)

getBase

public static java.lang.String getBase()
Get the base URL for all requests.

Returns:
the base URL for all requests to Flickr.