com.ning.api.client.access.impl.DefaultFinder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ning-api-java Show documentation
Java client library for accessing Ning external API
There is a newer version: 0.5.1
package com.ning.api.client.access.impl;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import com.ning.api.client.NingClientConfig;
import com.ning.api.client.NingClientException;
import com.ning.api.client.access.NingConnection;
import com.ning.api.client.action.Finder;
import com.ning.api.client.http.NingHttpGet;
import com.ning.api.client.item.ContentItem;
import com.ning.api.client.item.Fields;
import com.ning.api.client.item.Key;
import com.ning.api.client.item.Typed;

/**
 * Standard implementation for typical Finders.
 * 
 * @author tatu
 *
 * @param  Type of content item(s) to find
 * @param  Enumeration of fields for T
 */
public class DefaultFinder<
    C extends ContentItem,
    F extends Enum & Typed
>
    implements Finder
{
    protected final NingConnection connection;

    /**
     * Timeout to use for calls
     */
    protected NingClientConfig config;

    /**
     * Request end point used for fetching items
     */
    protected final String endpoint;
    
    /**
     * Fields to fetch values for, for items listed
     */
    protected final Fields fields;

    protected final Class itemType;
    
    public DefaultFinder(NingConnection connection, NingClientConfig config, String endpoint,
            Class itemType, Fields fields)
    {
        this.connection = connection;
        this.config = config;
        this.endpoint = endpoint;
        this.fields = fields;
        this.itemType = itemType;
    }

    public final C find(String id) throws NingClientException
    {
        return find(new Key(id));
    }

    public final List find(Collection ids) throws NingClientException
    {
        if (ids.isEmpty()) {
            return Collections.emptyList();
        }
        @SuppressWarnings("unchecked")
        Key[] keys = (Key[]) new Key[ids.size()];
        int i =  0;
        for (String id : ids) {
            keys[i++] = new Key(id);
        }
        return find(keys);
    }
    
    public final List find(String[] ids) throws NingClientException
    {
        @SuppressWarnings("unchecked")
        Key[] keys = (Key[]) new Key[ids.length];
        for (int i = 0, len = ids.length; i < len; ++i) {
            keys[i] = new Key(ids[i]);
        }
        return find(keys);
    }
    
    public C find(Key id)
    {
        NingHttpGet getter = buildQuery(id);
        return getter.execute(config.getReadTimeoutMsecs()).asSingleItem(itemType);
    }

    public List find(Key[] ids) {
        // !!! TODO
        return null;
    }

    protected NingHttpGet buildQuery(Key id)
    {
        NingHttpGet getter = prepareQuery();
        getter = getter.addQueryParameter("id", id.toString());
        return getter;
    }

    /**
     * Overridable method sub-classes can define to add other query parameters
     */
    protected NingHttpGet prepareQuery()
    {
        NingHttpGet getter = connection.prepareHttpGet(endpoint);
        getter = getter.addAccept("* /*");
        // also, need to specify fields to include with "fields"
        if (fields != null && fields.size() > 0) {
            getter = getter.addQueryParameter("fields", fields.toString());
        }
        return getter;
    }
}