FacebookFriendUpdatesProvider (streams-provider-facebook 0.3-incubating-SNAPSHOT API)

; Sat, 11 Apr 2015 22:10:09 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r947190 [21/31] - in /websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook: ./ META-INF/ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/streams/ apidocs/org... Date: Sat, 11 Apr 2015 22:10:06 -0000 To: commits@streams.incubator.apache.org From: sblackmon@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150411221009.C693EAC070E@hades.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookFriendUpdatesProvider.html ============================================================================== --- websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookFriendUpdatesProvider.html (added) +++ websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookFriendUpdatesProvider.html Sat Apr 11 22:10:03 2015 @@ -0,0 +1,590 @@ + + + + + + +FacebookFriendUpdatesProvider (streams-provider-facebook 0.3-incubating-SNAPSHOT API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.streams.facebook.provider.FacebookFriendUpdatesProvider
+

All Implemented Interfaces:: Serializable, StreamsOperation, StreamsProvider

+
+

public class FacebookFriendUpdatesProvider
+extends Object
+implements StreamsProvider, Serializable

See Also:: Serialized Form

+ +

+ + +

Field Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Fields
Modifier and Type	Field and Description
`protected org.joda.time.DateTime`	`end`
`protected ExecutorService`	`executor`
`protected Iterator<String[]>`	`idsBatches`
`protected ReadWriteLock`	`lock`
`protected Queue<StreamsDatum>`	`providerQueue`
`protected AtomicBoolean`	`running`
`protected org.joda.time.DateTime`	`start`
`static String`	`STREAMS_ID`

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + + + + +

Constructors
Constructor and Description
`FacebookFriendUpdatesProvider()`
`FacebookFriendUpdatesProvider(Class klass)`
`FacebookFriendUpdatesProvider(FacebookUserstreamConfiguration config)`
`FacebookFriendUpdatesProvider(FacebookUserstreamConfiguration config, + Class klass)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`void`	`cleanUp()`
`FacebookUserstreamConfiguration`	`getConfig()`
`protected facebook4j.Facebook`	`getFacebookClient()`
`Queue<StreamsDatum>`	`getProviderQueue()`
`boolean`	`isRunning()`
`void`	`prepare(Object o)`
`StreamsResultSet`	`readCurrent()`
`StreamsResultSet`	`readNew(BigInteger sequence)`
`StreamsResultSet`	`readRange(org.joda.time.DateTime start, + org.joda.time.DateTime end)`
`void`	`setConfig(FacebookUserstreamConfiguration config)`
`void`	`startStream()`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +

Field Detail

+ + + +

+
STREAMS_ID
+
```
public static final String STREAMS_ID
```
+
See Also:
Constant Field Values
+

+ + + +

+
lock
+
```
protected final ReadWriteLock lock
```
+

+ + + +

providerQueue

protected volatile Queue<StreamsDatum> providerQueue

+ + + +

idsBatches

protected Iterator<String[]> idsBatches

+ + + +

+
executor
+
```
protected ExecutorService executor
```
+

+ + + +

+
start
+
```
protected org.joda.time.DateTime start
```
+

+ + + +

+
end
+
```
protected org.joda.time.DateTime end
```
+

+ + + +

+
running
+
```
protected final AtomicBoolean running
```
+

+ +

+ + +

Constructor Detail

+ + + +

+
FacebookFriendUpdatesProvider
+
```
public FacebookFriendUpdatesProvider()
```
+

+ + + +

FacebookFriendUpdatesProvider

public FacebookFriendUpdatesProvider(FacebookUserstreamConfiguration config)

+ + + +

FacebookFriendUpdatesProvider

public FacebookFriendUpdatesProvider(Class klass)

+ + + +

FacebookFriendUpdatesProvider

public FacebookFriendUpdatesProvider(FacebookUserstreamConfiguration config,
+                             Class klass)

+ +

+ + +
Method Detail
+ + + +
- +
  getConfig
  +
```
public FacebookUserstreamConfiguration getConfig()
```
  +
+ + + +
- +
  setConfig
  +
```
public void setConfig(FacebookUserstreamConfiguration config)
```
  +
+ + + +
- +
  getProviderQueue
  +
```
public Queue<StreamsDatum> getProviderQueue()
```
  +
+ + + +
- +
  startStream
  +
```
public void startStream()
```
  +
  +
  Specified by:
  +
  startStream in interface StreamsProvider
  +
  +
+ + + +
- +
  readCurrent
  +
```
public StreamsResultSet readCurrent()
```
  +
  +
  Specified by:
  +
  readCurrent in interface StreamsProvider
  +
  +
+ + + +
- +
  readNew
  +
```
public StreamsResultSet readNew(BigInteger sequence)
```
  +
  +
  Specified by:
  +
  readNew in interface StreamsProvider
  +
  +
+ + + +
- +
  readRange
  +
```
public StreamsResultSet readRange(org.joda.time.DateTime start,
+                         org.joda.time.DateTime end)
```
  +
  +
  Specified by:
  +
  readRange in interface StreamsProvider
  +
  +
+ + + +
- +
  isRunning
  +
```
public boolean isRunning()
```
  +
  +
  Specified by:
  +
  isRunning in interface StreamsProvider
  +
  +
+ + + +
- +
  prepare
  +
```
public void prepare(Object o)
```
  +
  +
  Specified by:
  +
  prepare in interface StreamsOperation
  +
  +
+ + + +
- +
  getFacebookClient
  +
```
protected facebook4j.Facebook getFacebookClient()
```
  +
+ + + +
- +
  cleanUp
  +
```
public void cleanUp()
```
  +
  +
  Specified by:
  +
  cleanUp in interface StreamsOperation
  +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + Added: websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookProvider.html ============================================================================== --- websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookProvider.html (added) +++ websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookProvider.html Sat Apr 11 22:10:03 2015 @@ -0,0 +1,468 @@ + + + + + + +FacebookProvider (streams-provider-facebook 0.3-incubating-SNAPSHOT API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.streams.facebook.provider.FacebookProvider
+

+
+
All Implemented Interfaces:
+
Serializable, StreamsOperation, StreamsProvider
+
+
+
Direct Known Subclasses:
+
FacebookPageFeedProvider, FacebookPageProvider
+
+
+
+
```
public abstract class FacebookProvider
+extends Object
+implements StreamsProvider
```
+
Abstract StreamsProvider for facebook.
+
See Also:
Serialized Form
+

+ +

+ + +
Field Summary
+ + + + + + + + + + + + + + +
Fields
Modifier and Type Field and Description
protected FacebookConfiguration configuration
protected BlockingQueue<StreamsDatum> datums
+

Fields
Modifier and Type	Field and Description
`protected FacebookConfiguration`	`configuration`
`protected BlockingQueue<StreamsDatum>`	`datums`

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
FacebookProvider()
FacebookProvider(FacebookConfiguration configuration)
+

Constructors
Constructor and Description
`FacebookProvider()`
`FacebookProvider(FacebookConfiguration configuration)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`void`	`cleanUp()`
`protected abstract FacebookDataCollector`	`getDataCollector()`
`boolean`	`isRunning()`
`void`	`overrideIds(Map<String,org.joda.time.DateTime> idsToAfterDate)` + Overrides the ids and addedAfter time in the configuration +
`void`	`prepare(Object configurationObject)`
`StreamsResultSet`	`readCurrent()`
`StreamsResultSet`	`readNew(BigInteger sequence)`
`StreamsResultSet`	`readRange(org.joda.time.DateTime start, + org.joda.time.DateTime end)`
`void`	`startStream()`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    configuration
    +
```
protected FacebookConfiguration configuration
```
    +
  + + + +
  - +
    datums
    +
```
protected BlockingQueue<StreamsDatum> datums
```
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    FacebookProvider
    +
```
public FacebookProvider()
```
    +
  + + + +
  - +
    FacebookProvider
    +
```
public FacebookProvider(FacebookConfiguration configuration)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    startStream
    +
```
public void startStream()
```
    +
    +
    Specified by:
    +
    startStream in interface StreamsProvider
    +
    +
  + + + +
  - +
    getDataCollector
    +
```
protected abstract FacebookDataCollector getDataCollector()
```
    +
  + + + +
  - +
    readCurrent
    +
```
public StreamsResultSet readCurrent()
```
    +
    +
    Specified by:
    +
    readCurrent in interface StreamsProvider
    +
    +
  + + + +
  - +
    readNew
    +
```
public StreamsResultSet readNew(BigInteger sequence)
```
    +
    +
    Specified by:
    +
    readNew in interface StreamsProvider
    +
    +
  + + + +
  - +
    readRange
    +
```
public StreamsResultSet readRange(org.joda.time.DateTime start,
+                         org.joda.time.DateTime end)
```
    +
    +
    Specified by:
    +
    readRange in interface StreamsProvider
    +
    +
  + + + +
  - +
    isRunning
    +
```
public boolean isRunning()
```
    +
    +
    Specified by:
    +
    isRunning in interface StreamsProvider
    +
    +
  + + + +
  - +
    prepare
    +
```
public void prepare(Object configurationObject)
```
    +
    +
    Specified by:
    +
    prepare in interface StreamsOperation
    +
    +
  + + + +
  - +
    cleanUp
    +
```
public void cleanUp()
```
    +
    +
    Specified by:
    +
    cleanUp in interface StreamsOperation
    +
    +
  + + + +
  - +
    overrideIds
    +
```
public void overrideIds(Map<String,org.joda.time.DateTime> idsToAfterDate)
```
    +
    Overrides the ids and addedAfter time in the configuration
    +
    Parameters:
    idsToAfterDate -
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + Added: websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookStreamConfigurator.html ============================================================================== --- websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookStreamConfigurator.html (added) +++ websites/production/streams/content/site/0.3-incubating-SNAPSHOT/streams-project/streams-contrib/streams-provider-facebook/apidocs/org/apache/streams/facebook/provider/FacebookStreamConfigurator.html Sat Apr 11 22:10:03 2015 @@ -0,0 +1,284 @@ + + + + + + +FacebookStreamConfigurator (streams-provider-facebook 0.3-incubating-SNAPSHOT API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.streams.facebook.provider.FacebookStreamConfigurator
+

+
+

public class FacebookStreamConfigurator
+extends Object

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
FacebookStreamConfigurator()
+

Constructors
Constructor and Description
`FacebookStreamConfigurator()`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`static FacebookConfiguration`	`detectConfiguration(com.typesafe.config.Config config)`
`static FacebookUserInformationConfiguration`	`detectFacebookConfiguration(com.typesafe.config.Config config)`
`static FacebookUserInformationConfiguration`	`detectFacebookUserInformationConfiguration(com.typesafe.config.Config config)`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +
Constructor Detail
+ + + +
- +
  FacebookStreamConfigurator
  +
```
public FacebookStreamConfigurator()
```
  +
+

+ +

+ + +

Method Detail

+ + + +

detectFacebookConfiguration

public static FacebookUserInformationConfiguration detectFacebookConfiguration(com.typesafe.config.Config config)

+ + + +

detectConfiguration

public static FacebookConfiguration detectConfiguration(com.typesafe.config.Config config)

+ + + +

detectFacebookUserInformationConfiguration

public static FacebookUserInformationConfiguration detectFacebookUserInformationConfiguration(com.typesafe.config.Config config)

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

Class FacebookFriendUpdatesProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STREAMS_ID

lock

providerQueue

idsBatches

executor

start

end

running

Constructor Detail

FacebookFriendUpdatesProvider

FacebookFriendUpdatesProvider

FacebookFriendUpdatesProvider

FacebookFriendUpdatesProvider

Method Detail

getConfig

setConfig

getProviderQueue

startStream

readCurrent

readNew

readRange

isRunning

prepare

getFacebookClient

cleanUp

Class FacebookProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

configuration

datums

Constructor Detail

FacebookProvider

FacebookProvider

Method Detail

startStream

getDataCollector

readCurrent

readNew

readRange

isRunning

prepare

cleanUp

overrideIds

Class FacebookStreamConfigurator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FacebookStreamConfigurator

Method Detail

detectFacebookConfiguration

detectConfiguration

detectFacebookUserInformationConfiguration