org.codice.ddf.catalog.twitter.source

Class TwitterSource

java.lang.Object

org.codice.ddf.catalog.twitter.source.TwitterSource

All Implemented Interfaces:

ResourceReader, ConfiguredService, FederatedSource, RemoteSource, Source, Describable

public class TwitterSource
extends Object
implements FederatedSource, ConfiguredService

Constructor Summary

Constructors

Constructor and Description
TwitterSource()

Method Summary

Modifier and Type	Method and Description
void	destroy()
String	getConfigurationPid() Returns the PID of the configuration that corresponds to this service
String	getConsumerKey()
String	getConsumerSecret()
Set<ContentType>	getContentTypes() Gets the ContentTypes that are currently stored by the Source.
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
Set<String>	getOptions(Metacard metacard) Obtain a set of all options supported by this ResourceReader.
String	getOrganization() Returns the organization associated with the describable item.
Set<String>	getSupportedSchemes() Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
void	init()
boolean	isAvailable() This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.
boolean	isAvailable(SourceMonitor callback) This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability.
SourceResponse	query(QueryRequest request)
ResourceResponse	retrieveResource(URI uri, Map<String,Serializable> arguments) Retrieves a Resource based on a URI and provided arguments.
void	setConfigurationPid(String configurationPid) Sets the PID of this service's corresponding configuration
void	setConsumerKey(String consumerKey)
void	setConsumerSecret(String consumerSecret)
void	setId(String id)
void	setResourceReader(ResourceReader resourceReader)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.source.Source

getSecurityAttributes

Constructor Detail

TwitterSource

public TwitterSource()

Method Detail

init

public void init()

destroy

public void destroy()

retrieveResource

public ResourceResponse retrieveResource(URI uri,
                                         Map<String,Serializable> arguments)
                                  throws IOException,
                                         ResourceNotFoundException,
                                         ResourceNotSupportedException

Description copied from interface: ResourceReader

Retrieves a Resource based on a URI and provided arguments.

Specified by:

retrieveResource in interface ResourceReader

Parameters:

uri - A URI that defines what Resource to retrieve and how to do it.

arguments - Any additional arguments that should be passed to the ResourceReader.

Returns:

A ResourceResponse containing the retrieved Resource.

Throws:

IOException

ResourceNotFoundException

ResourceNotSupportedException

getSupportedSchemes

public Set<String> getSupportedSchemes()

Description copied from interface: ResourceReader

Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup. Custom schemes can be created for a ResourceReader to support.

Specified by:

getSupportedSchemes in interface ResourceReader

Returns:

Set of supported schemes

getOptions

public Set<String> getOptions(Metacard metacard)

Description copied from interface: ResourceReader

Obtain a set of all options supported by this ResourceReader. Options are used to obtain the Resource in a unique way.

Specified by:

getOptions in interface ResourceReader

Returns:

Set of all options that this ResourceReader supports. This will be an empty set if no options are supported.

isAvailable

public boolean isAvailable()

Description copied from interface: Source

This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.

This is expected to be an expensive operation, possibly involving network I/O. Typically only CatalogFramework implementations will call this and only periodically.

Specified by:

isAvailable in interface Source

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

See Also:

ddf.catalog.util.SourcePoller

isAvailable

public boolean isAvailable(SourceMonitor callback)

Description copied from interface: Source

This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability. The intent is to return a boolean as to whether the Source is available at this very moment and also to use the SourceMonitor object to update the caller of this method if this Source's availability changes later in the future.

Specified by:

isAvailable in interface Source

Parameters:

callback - - used to notify the caller of this method when the Source object wants to update its availability.

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

query

public SourceResponse query(QueryRequest request)
                     throws UnsupportedQueryException

Specified by:

query in interface Source

Parameters:

request - the query to execute

Returns:

a SourceResponse with query results and query response details

Throws:

UnsupportedQueryException - when the query is not understood, malformed, or not supported by a Source

getContentTypes

public Set<ContentType> getContentTypes()

Description copied from interface: Source

Gets the ContentTypes that are currently stored by the Source. Notice the return object is a Set, meaning it returns all unique content types found in the Source without duplications.

Specified by:

getContentTypes in interface Source

Returns:

a Set of ContentTypes currently available from this Source.

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Returns:

the version of the item being described (example: 1.0)

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

setId

public void setId(String id)

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: Dummy Catalog Provider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)

getConsumerKey

public String getConsumerKey()

setConsumerKey

public void setConsumerKey(String consumerKey)

getConsumerSecret

public String getConsumerSecret()

setConsumerSecret

public void setConsumerSecret(String consumerSecret)

setResourceReader

public void setResourceReader(ResourceReader resourceReader)

getConfigurationPid

public String getConfigurationPid()

Description copied from interface: ConfiguredService

Returns the PID of the configuration that corresponds to this service

Specified by:

getConfigurationPid in interface ConfiguredService

Returns:

The unique PID of the configuration associated with this service

setConfigurationPid

public void setConfigurationPid(String configurationPid)

Description copied from interface: ConfiguredService

Sets the PID of this service's corresponding configuration

Specified by:

setConfigurationPid in interface ConfiguredService

Parameters:

configurationPid - The unique PID of the configuration associated with this service