com.datasift.client.managedsource.sources

Class BaseSource<T extends DataSource<T>>

java.lang.Object

com.datasift.client.managedsource.sources.BaseSource<T>

All Implemented Interfaces:

DataSource<T>

Direct Known Subclasses:

FacebookPage, GooglePlus, Instagram, TwitterGnip, Yammer

public abstract class BaseSource<T extends DataSource<T>>
extends java.lang.Object
implements DataSource<T>

Author:

Courtney Robinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseSource.AuthParams
static class	BaseSource.ResourceParams

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<BaseSource.AuthParams>	auth
protected DataSiftConfig	config
protected org.slf4j.Logger	log
protected java.util.Map<java.lang.String,java.lang.Object>	parameters
protected java.util.Set<BaseSource.ResourceParams>	resources
protected ManagedDataSourceType<T>	type

Constructor Summary

Constructors

Constructor and Description
BaseSource(DataSiftConfig config, ManagedDataSourceType<T> type)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthAsJSON()
java.lang.String	getParametersAsJSON()
java.lang.String	getResourcesAsJSON()
boolean	hasAuth()
boolean	hasParams()
boolean	hasResources()
BaseSource.AuthParams	newAuthParams(java.lang.String name, long expires) Creates a set of auth parameters that can be used for this source
BaseSource.ResourceParams	newResourceParams()
T	setParametersField(java.lang.String name, java.lang.Object value)
ManagedDataSourceType<T>	type()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final ManagedDataSourceType<T extends DataSource<T>> type

config

protected DataSiftConfig config

log

protected org.slf4j.Logger log

parameters

protected java.util.Map<java.lang.String,java.lang.Object> parameters

resources

protected java.util.Set<BaseSource.ResourceParams> resources

auth

protected java.util.Set<BaseSource.AuthParams> auth

Constructor Detail

BaseSource

public BaseSource(DataSiftConfig config,
                  ManagedDataSourceType<T> type)

Method Detail

type

public ManagedDataSourceType<T> type()

Specified by:

type in interface DataSource<T extends DataSource<T>>

Returns:

a managed source type of the data source this represents

hasAuth

public boolean hasAuth()

Specified by:

hasAuth in interface DataSource<T extends DataSource<T>>

Returns:

true if any auth information has been set for this data source

hasResources

public boolean hasResources()

Specified by:

hasResources in interface DataSource<T extends DataSource<T>>

Returns:

true if any resource parameters have been configured for this data source

hasParams

public boolean hasParams()

Specified by:

hasParams in interface DataSource<T extends DataSource<T>>

Returns:

true if any "parameter" params have been configured for this data source

setParametersField

public T setParametersField(java.lang.String name,
                            java.lang.Object value)

newAuthParams

public BaseSource.AuthParams newAuthParams(java.lang.String name,
                                           long expires)

Creates a set of auth parameters that can be used for this source

Parameters:

name - a human friendly name for this auth set

expires - identity resource expiry date/time as a UTC timestamp

Returns:

a new auth set

newResourceParams

public BaseSource.ResourceParams newResourceParams()

Returns:

A new set of resource parameters

getParametersAsJSON

public java.lang.String getParametersAsJSON()

Specified by:

getParametersAsJSON in interface DataSource<T extends DataSource<T>>

Returns:

A URL encoded string which represents the parameters for this data source note this is the value for the "parameters" field and does not include the key itself

getResourcesAsJSON

public java.lang.String getResourcesAsJSON()

Specified by:

getResourcesAsJSON in interface DataSource<T extends DataSource<T>>

Returns:

A URL encoded string which represents the resources for this data source note this is the value for the "resources" field and does not include the key itself

getAuthAsJSON

public java.lang.String getAuthAsJSON()

Specified by:

getAuthAsJSON in interface DataSource<T extends DataSource<T>>

Returns:

A URL encoded string which represents the auth information for this data source note this is the value for the "auth" field and does not include the key itself