|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.umass.lastfm.Caller
The Caller
class handles the low-level communication between the
client and last.fm.
Direct usage of this class should be unnecessary since all method calls are
available via the methods in the Artist
, Album
,
User
, etc. classes. If specialized calls which are not covered
by the Java API are necessary this class may be used directly.
Supports the setting of a custom Proxy
and a custom
User-Agent
HTTP header.
Method Summary | |
Result |
call(String method,
Session session,
Map params)
|
Result |
call(String method,
Session session,
String[] params)
|
Result |
call(String method,
String apiKey,
Map params)
|
Result |
call(String method,
String apiKey,
String[] params)
|
Cache |
getCache()
Returns the current Cache . |
static Caller |
getInstance()
Returns the single instance of the Caller class. |
Result |
getLastResult()
Returns the Result of the last operation, or null if
no call operation has been performed yet. |
String |
getUserAgent()
|
boolean |
isDebugMode()
|
HttpURLConnection |
openConnection(String url)
Creates a new HttpURLConnection , sets the proxy, if available,
and sets the User-Agent property. |
void |
setApiRootUrl(String apiRootUrl)
Set api root url. |
void |
setCache(Cache cache)
Sets the active Cache . |
void |
setDebugMode(boolean debugMode)
Sets the debugMode property. |
void |
setUserAgent(String userAgent)
Sets a User Agent this Caller will use for all upcoming HTTP requests. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static Caller getInstance()
Caller
class.
Caller
public void setApiRootUrl(String apiRootUrl)
apiRootUrl
- new api root urlpublic void setUserAgent(String userAgent)
userAgent
- a User-Agent stringpublic void setDebugMode(boolean debugMode)
debugMode
property. If debugMode
is
true
all call() methods will print debug information and
error messages on failure to stdout and stderr respectively.false
. Set this to true
while in
development and for troubleshooting.
debugMode
- true
to enable debug modepublic Cache getCache()
Cache
.
public void setCache(Cache cache)
Cache
. May be null
to disable
caching.
cache
- the new Cache or null
public Result call(String method, String apiKey, String[] params) throws CallException
CallException
public Result call(String method, String apiKey, Map params) throws CallException
CallException
public Result call(String method, Session session, String[] params)
public Result call(String method, Session session, Map params)
public Result getLastResult()
Result
of the last operation, or null
if
no call operation has been performed yet.
public HttpURLConnection openConnection(String url) throws IOException
HttpURLConnection
, sets the proxy, if available,
and sets the User-Agent property.
url
- URL to connect to
IOException
- if an I/O exception occurs.public String getUserAgent()
public boolean isDebugMode()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |