org.shredzone.flattr4j.impl

Class FlattrServiceImpl

java.lang.Object

org.shredzone.flattr4j.impl.FlattrServiceImpl

All Implemented Interfaces:

FlattrService

public class FlattrServiceImpl
extends Object
implements FlattrService

Default implementation of FlattrService.

Author:

Richard "Shred" Körber

Constructor Summary

Constructors

Constructor and Description
FlattrServiceImpl(Connector connector)

Method Summary

Modifier and Type	Method and Description
ThingId	create(Submission thing) Creates a new Thing.
void	delete(ThingId thingId) Deletes a Thing.
MiniThing	flattr(AutoSubmission submission) Flattrs an AutoSubmission.
MiniThing	flattr(String url) Flattrs a URL.
MiniThing	flattr(ThingId thingId) Flattrs a Thing.
List<Activity>	getActivities(UserId user, Activity.Type type) Returns all Activity of the given user ID.
List<Category>	getCategories() Gets a list of all Flattr Category.
protected Connector	getConnector() Returns the Connector used for calling the API.
RateLimit	getCurrentRateLimit() Gets the current rate limit from the server.
List<Flattr>	getFlattrs(ThingId thingId) Gets all Flattr most recently posted for the given thing ID.
List<Flattr>	getFlattrs(ThingId thingId, Integer count, Integer page) Gets all Flattr most recently posted for the given thing ID.
List<Flattr>	getFlattrs(UserId user) Gets all Flattr most recently posted by the given user ID.
List<Flattr>	getFlattrs(UserId userId, Integer count, Integer page) Gets all Flattr most recently posted by the given user ID.
List<Language>	getLanguages() Gets a list of all Flattr Language.
RateLimit	getLastRateLimit() Gets a RateLimit instance that reflects the rate limit and remaining rate returned by the last API call.
List<Activity>	getMyActivities(Activity.Type type) Returns all Activity of the associated user.
List<Flattr>	getMyFlattrs() Returns all Flattr submitted by the associated user.
List<Flattr>	getMyFlattrs(Integer count, Integer page) Returns all Flattr submitted by the associated user.
User	getMyself() Gets the User profile of the associated user.
List<Subscription>	getMySubscriptions() Returns all Subscription of the associated user.
List<Thing>	getMyThings() Returns all Thing submitted by the associated user.
List<Thing>	getMyThings(Integer count, Integer page) Returns all Thing submitted by the associated user.
Subscription	getSubscription(ThingId thingId) Returns the Subscription of the given Thing.
Thing	getThing(ThingId thingId) Gets a Thing for the given ThingId.
Thing	getThingBySubmission(AutoSubmission submission) Gets a Thing by its autosubmit URL.
Thing	getThingByUrl(String url) Gets a Thing by its registered URL.
List<Thing>	getThings(Collection<? extends ThingId> thingIds) Gets a list of Thing by a collection of thing IDs.
List<Thing>	getThings(UserId user) Gets a list of Thing most recently submitted by the given user.
List<Thing>	getThings(UserId user, Integer count, Integer page) Gets a list of Thing most recently submitted by the given user.
User	getUser(UserId user) Gets the User profile of the given user ID.
boolean	isFullMode() Is the full mode currently enabled?
void	pauseSubscription(ThingId thingId, boolean paused) Pauses or resumes a Subscription.
SearchResult	searchThings(SearchQuery query, Integer count, Integer page) Searches for Thing.
void	setFullMode(boolean full) Sets the full mode.
protected void	setupFullMode(Connection conn) Sets the Connection according to the current full mode.
void	subscribe(ThingId thingId) Subscribes a Thing.
boolean	toggleSubscription(ThingId thingId) Toggles the pause state of the subscription of the given Thing.
void	unsubscribe(ThingId thingId) Cancels subscription of a Thing.
void	update(Thing thing) Updates a Thing.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlattrServiceImpl

public FlattrServiceImpl(Connector connector)

Method Detail

getConnector

protected Connector getConnector()

Returns the Connector used for calling the API.

Returns:

Connector

setFullMode

public void setFullMode(boolean full)

Description copied from interface: FlattrService

Sets the full mode. Defaults to false.

Specified by:

setFullMode in interface FlattrService

Parameters:

full - true: use full requests, false: use standard requests

isFullMode

public boolean isFullMode()

Description copied from interface: FlattrService

Is the full mode currently enabled?

Specified by:

isFullMode in interface FlattrService

Returns:

true: full requests, false: standard requests

create

public ThingId create(Submission thing)
               throws FlattrException

Description copied from interface: FlattrService

Creates a new Thing. The authenticated user will be the owner of the Thing.

Specified by:

create in interface FlattrService

Parameters:

thing - Submission to be submitted

Returns:

ThingId of the Thing that was created

Throws:

FlattrException

update

public void update(Thing thing)
            throws FlattrException

Description copied from interface: FlattrService

Updates a Thing.

Specified by:

update in interface FlattrService

Parameters:

thing - Thing to be modified

Throws:

FlattrException

delete

public void delete(ThingId thingId)
            throws FlattrException

Description copied from interface: FlattrService

Deletes a Thing.

Specified by:

delete in interface FlattrService

Parameters:

thingId - ThingId to delete

Throws:

FlattrException

flattr

public MiniThing flattr(AutoSubmission submission)
                 throws FlattrException

Description copied from interface: FlattrService

Flattrs an AutoSubmission. If the submission has not been submitted to Flattr yet, it will automatically be submitted before.

Specified by:

flattr in interface FlattrService

Parameters:

submission - AutoSubmission to flattr

Returns:

MiniThing of the flattr-ed thing (containing an updated click count)

Throws:

FlattrException

flattr

public MiniThing flattr(String url)
                 throws FlattrException

Description copied from interface: FlattrService

Flattrs a URL.

Specified by:

flattr in interface FlattrService

Parameters:

url - URL to flattr

Returns:

MiniThing of the flattr-ed thing (containing an updated click count)

Throws:

FlattrException

flattr

public MiniThing flattr(ThingId thingId)
                 throws FlattrException

Description copied from interface: FlattrService

Flattrs a Thing. This means that the Thing is flattr-ed by the associated user.

Specified by:

flattr in interface FlattrService

Parameters:

thingId - ThingId to flattr

Returns:

MiniThing of the flattr-ed thing (containing an updated click count)

Throws:

FlattrException

getMyself

public User getMyself()
               throws FlattrException

Description copied from interface: FlattrService

Gets the User profile of the associated user.

Specified by:

getMyself in interface FlattrService

Returns:

User profile of oneself

Throws:

FlattrException

getMyThings

public List<Thing> getMyThings()
                        throws FlattrException

Description copied from interface: FlattrService

Returns all Thing submitted by the associated user. Limited to 30 entries.

Specified by:

getMyThings in interface FlattrService

Returns:

List of Thing

Throws:

FlattrException

getMyThings

public List<Thing> getMyThings(Integer count,
                               Integer page)
                        throws FlattrException

Description copied from interface: FlattrService

Returns all Thing submitted by the associated user.

Specified by:

getMyThings in interface FlattrService

Parameters:

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

List of Thing

Throws:

FlattrException

getMyFlattrs

public List<Flattr> getMyFlattrs()
                          throws FlattrException

Description copied from interface: FlattrService

Returns all Flattr submitted by the associated user. Limited to 30 entries.

Specified by:

getMyFlattrs in interface FlattrService

Returns:

List of Flattr

Throws:

FlattrException

getMyFlattrs

public List<Flattr> getMyFlattrs(Integer count,
                                 Integer page)
                          throws FlattrException

Description copied from interface: FlattrService

Returns all Flattr submitted by the associated user.

Specified by:

getMyFlattrs in interface FlattrService

Parameters:

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

List of Flattr

Throws:

FlattrException

getThing

public Thing getThing(ThingId thingId)
               throws FlattrException

Description copied from interface: FlattrService

Gets a Thing for the given ThingId.

Specified by:

getThing in interface FlattrService

Parameters:

thingId - ThingId of the Thing to be fetched

Returns:

Thing

Throws:

FlattrException

getThingByUrl

public Thing getThingByUrl(String url)
                    throws FlattrException

Description copied from interface: FlattrService

Gets a Thing by its registered URL.

Specified by:

getThingByUrl in interface FlattrService

Parameters:

url - Thing's URL

Returns:

Thing of the URL that was found, null if nothing was found

Throws:

FlattrException

getThingBySubmission

public Thing getThingBySubmission(AutoSubmission submission)
                           throws FlattrException

Description copied from interface: FlattrService

Gets a Thing by its autosubmit URL.

Uses two rates!

Specified by:

getThingBySubmission in interface FlattrService

Parameters:

submission - AutoSubmission to check for

Returns:

Thing of the submission if found, null if nothing was found

Throws:

FlattrException

getThings

public List<Thing> getThings(UserId user)
                      throws FlattrException

Description copied from interface: FlattrService

Gets a list of Thing most recently submitted by the given user. This list is limited to 30 entries.

Specified by:

getThings in interface FlattrService

Parameters:

user - UserId to find the Things of

Returns:

List of Thing submitted by the user

Throws:

FlattrException

getThings

public List<Thing> getThings(UserId user,
                             Integer count,
                             Integer page)
                      throws FlattrException

Description copied from interface: FlattrService

Gets a list of Thing most recently submitted by the given user.

Specified by:

getThings in interface FlattrService

Parameters:

user - UserId to find the Things of

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

List of Thing submitted by the user

Throws:

FlattrException

getThings

public List<Thing> getThings(Collection<? extends ThingId> thingIds)
                      throws FlattrException

Description copied from interface: FlattrService

Gets a list of Thing by a collection of thing IDs.

Specified by:

getThings in interface FlattrService

Parameters:

thingIds - Collection of ThingId. The order of Thing returned may not match the order of the provided IDs.

Returns:

List of Thing fetched

Throws:

FlattrException

searchThings

public SearchResult searchThings(SearchQuery query,
                                 Integer count,
                                 Integer page)
                          throws FlattrException

Description copied from interface: FlattrService

Searches for Thing.

Specified by:

searchThings in interface FlattrService

Parameters:

query - SearchQuery, or null to search for everything

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

SearchResult

Throws:

FlattrException

getUser

public User getUser(UserId user)
             throws FlattrException

Description copied from interface: FlattrService

Gets the User profile of the given user ID.

Specified by:

getUser in interface FlattrService

Parameters:

user - UserId to get a profile for

Returns:

User profile of that user

Throws:

FlattrException

getFlattrs

public List<Flattr> getFlattrs(UserId user)
                        throws FlattrException

Description copied from interface: FlattrService

Gets all Flattr most recently posted by the given user ID. Limited to 30 results.

Specified by:

getFlattrs in interface FlattrService

Parameters:

user - UserId to get the result for

Returns:

List of Flattr posted by the user

Throws:

FlattrException

getFlattrs

public List<Flattr> getFlattrs(UserId userId,
                               Integer count,
                               Integer page)
                        throws FlattrException

Description copied from interface: FlattrService

Gets all Flattr most recently posted by the given user ID.

Specified by:

getFlattrs in interface FlattrService

Parameters:

userId - UserId to get the result for

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

List of Flattr posted by the user

Throws:

FlattrException

getFlattrs

public List<Flattr> getFlattrs(ThingId thingId)
                        throws FlattrException

Description copied from interface: FlattrService

Gets all Flattr most recently posted for the given thing ID.

Specified by:

getFlattrs in interface FlattrService

Parameters:

thingId - ThingId to get the result for

Returns:

List of Flattr posted by the user

Throws:

FlattrException

getFlattrs

public List<Flattr> getFlattrs(ThingId thingId,
                               Integer count,
                               Integer page)
                        throws FlattrException

Description copied from interface: FlattrService

Gets all Flattr most recently posted for the given thing ID.

Specified by:

getFlattrs in interface FlattrService

Parameters:

thingId - ThingId to get the result for

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

List of Flattr posted by the user

Throws:

FlattrException

getActivities

public List<Activity> getActivities(UserId user,
                                    Activity.Type type)
                             throws FlattrException

Description copied from interface: FlattrService

Returns all Activity of the given user ID.

Specified by:

getActivities in interface FlattrService

Parameters:

user - UserId to get the result for

type - activity type. null defaults to Activity.Type#OUTGOING.

Returns:

List of Activity

Throws:

FlattrException

getMyActivities

public List<Activity> getMyActivities(Activity.Type type)
                               throws FlattrException

Description copied from interface: FlattrService

Returns all Activity of the associated user.

Specified by:

getMyActivities in interface FlattrService

Parameters:

type - activity type. null defaults to Activity.Type#OUTGOING.

Returns:

List of Activity

Throws:

FlattrException

getMySubscriptions

public List<Subscription> getMySubscriptions()
                                      throws FlattrException

Description copied from interface: FlattrService

Returns all Subscription of the associated user.

Specified by:

getMySubscriptions in interface FlattrService

Returns:

List of Subscription

Throws:

FlattrException

getSubscription

public Subscription getSubscription(ThingId thingId)
                             throws FlattrException

Description copied from interface: FlattrService

Returns the Subscription of the given Thing. Only the subscriptions of the associated user are accessible.

Note: This call is emulated by flattr4j. Depending on the number of subscriptions of the associated user, this call may take some time and cause increased network traffic. It may also increment the rate counter by more than 1.

Specified by:

getSubscription in interface FlattrService

Parameters:

thingId - ThingId to get the subscription of

Returns:

Subscription of this thing, or null if there is no such subscription

Throws:

FlattrException

subscribe

public void subscribe(ThingId thingId)
               throws FlattrException

Description copied from interface: FlattrService

Subscribes a Thing.

Specified by:

subscribe in interface FlattrService

Parameters:

thingId - ThingId to subscribe

Throws:

FlattrException

unsubscribe

public void unsubscribe(ThingId thingId)
                 throws FlattrException

Description copied from interface: FlattrService

Cancels subscription of a Thing.

Specified by:

unsubscribe in interface FlattrService

Parameters:

thingId - ThingId to unsubscribed

Throws:

FlattrException

toggleSubscription

public boolean toggleSubscription(ThingId thingId)
                           throws FlattrException

Description copied from interface: FlattrService

Toggles the pause state of the subscription of the given Thing.

Specified by:

toggleSubscription in interface FlattrService

Parameters:

thingId - ThingId of the thing to toggle the pause state of

Returns:

true if the subscription is now paused, false if the subscription was resumed.

Throws:

FlattrException

pauseSubscription

public void pauseSubscription(ThingId thingId,
                              boolean paused)
                       throws FlattrException

Description copied from interface: FlattrService

Pauses or resumes a Subscription. If the subscription is already in the desired state, nothing will happen.

Note: There is currently no way to explicitely set the pause state of a subscription via Flattr API. flattr4j emulates this call by toggling the pause state to get the current state, and if necessary, toggling it again to set the subscription to the desired state (which means that the rate counter is incremented by 2). This call is not atomic. If the second toggle call should fail, it will leave the subscription in the opposite state.

Specified by:

pauseSubscription in interface FlattrService

Parameters:

thingId - ThingId of the thing to set the pause state

paused - true: pause subscription, false: resume subscription

Throws:

FlattrException

getCategories

public List<Category> getCategories()
                             throws FlattrException

Description copied from interface: FlattrService

Gets a list of all Flattr Category.

Note: The result is not cached.

Specified by:

getCategories in interface FlattrService

Returns:

List of Flattr Category.

Throws:

FlattrException

getLanguages

public List<Language> getLanguages()
                            throws FlattrException

Description copied from interface: FlattrService

Gets a list of all Flattr Language.

Note: The result is not cached.

Specified by:

getLanguages in interface FlattrService

Returns:

List of Flattr Language.

Throws:

FlattrException

getCurrentRateLimit

public RateLimit getCurrentRateLimit()
                              throws FlattrException

Description copied from interface: FlattrService

Gets the current rate limit from the server.

Unlike FlattrService.getLastRateLimit(), this call actively queries the current rate limits from the server.

FlattrService.getLastRateLimit() is untouched by this call.

Specified by:

getCurrentRateLimit in interface FlattrService

Returns:

Rate limit.

Throws:

FlattrException

getLastRateLimit

public RateLimit getLastRateLimit()

Description copied from interface: FlattrService

Gets a RateLimit instance that reflects the rate limit and remaining rate returned by the last API call.

This method does not block and does not connect to the network.

Specified by:

getLastRateLimit in interface FlattrService

Returns:

Rate limit.

setupFullMode

protected void setupFullMode(Connection conn)

Sets the Connection according to the current full mode.

Parameters:

conn - Connection to set