Repository: camel
Updated Branches:
  refs/heads/master 02361967c -> 21541cf65


Component docs


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/21541cf6
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/21541cf6
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/21541cf6

Branch: refs/heads/master
Commit: 21541cf65b7680710174cf6a0c39b077a0e727d0
Parents: 0236196
Author: Claus Ibsen <davscl...@apache.org>
Authored: Mon May 11 14:25:35 2015 +0200
Committer: Claus Ibsen <davscl...@apache.org>
Committed: Mon May 11 14:52:55 2015 +0200

----------------------------------------------------------------------
 .../component/facebook/FacebookComponent.java   |   3 +
 .../component/facebook/FacebookConsumer.java    |   4 +-
 .../component/facebook/FacebookEndpoint.java    |  49 ++---
 .../component/facebook/FacebookProducer.java    |   4 +-
 .../facebook/config/FacebookConfiguration.java  | 117 ++++++++++--
 .../config/FacebookEndpointConfiguration.java   | 183 +++++++++++++++++++
 6 files changed, 317 insertions(+), 43 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/21541cf6/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookComponent.java
----------------------------------------------------------------------
diff --git 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookComponent.java
 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookComponent.java
index 729a410..69f7ab6 100644
--- 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookComponent.java
+++ 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookComponent.java
@@ -72,6 +72,9 @@ public class FacebookComponent extends UriEndpointComponent {
         return configuration;
     }
 
+    /**
+     * To use the shared configuration
+     */
     public void setConfiguration(FacebookConfiguration configuration) {
         this.configuration = configuration;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/21541cf6/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConsumer.java
----------------------------------------------------------------------
diff --git 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConsumer.java
 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConsumer.java
index bbe121b..c1e27c9 100644
--- 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConsumer.java
+++ 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConsumer.java
@@ -129,8 +129,8 @@ public class FacebookConsumer extends ScheduledPollConsumer 
{
         if (filteredMethods.isEmpty()) {
             throw new IllegalArgumentException(
                 String.format("Missing properties for %s, need one or more 
from %s",
-                    endpoint.getMethodName(),
-                    getMissingProperties(endpoint.getMethodName(), 
endpoint.getNameStyle(), argNames)));
+                    endpoint.getMethod(),
+                    getMissingProperties(endpoint.getMethod(), 
endpoint.getNameStyle(), argNames)));
         } else if (filteredMethods.size() == 1) {
             // single match
             result = filteredMethods.get(0);

http://git-wip-us.apache.org/repos/asf/camel/blob/21541cf6/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
----------------------------------------------------------------------
diff --git 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
index 01c4b72..740ce85 100644
--- 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
+++ 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
@@ -24,6 +24,7 @@ import java.util.Map;
 import java.util.Set;
 
 import org.apache.camel.Consumer;
+import org.apache.camel.NoTypeConversionAvailableException;
 import org.apache.camel.Processor;
 import org.apache.camel.Producer;
 import 
org.apache.camel.component.facebook.config.FacebookEndpointConfiguration;
@@ -54,15 +55,14 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
 
     private static final Logger LOG = 
LoggerFactory.getLogger(FacebookEndpoint.class);
 
-    // Facebook4J method name
-    @UriPath @Metadata(required = "true")
-    private final String methodName;
     private FacebookNameStyle nameStyle;
+    private String method;
 
+    // Facebook4J method name
+    @UriPath(description = "What operation to perform") @Metadata(required = 
"true")
+    private FacebookMethodsType methodName;
     @UriParam
     private FacebookEndpointConfiguration configuration;
-
-    // property name for Exchange 'In' message body
     @UriParam
     private String inBody;
 
@@ -70,10 +70,10 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
     private List<FacebookMethodsType> candidates;
 
     public FacebookEndpoint(String uri, FacebookComponent facebookComponent,
-                            String remaining, FacebookEndpointConfiguration 
configuration) {
+                            String remaining, FacebookEndpointConfiguration 
configuration) throws NoTypeConversionAvailableException {
         super(uri, facebookComponent);
         this.configuration = configuration;
-        this.methodName = remaining;
+        this.method = remaining;
     }
 
     public Producer createProducer() throws Exception {
@@ -130,7 +130,7 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
         final String[] argNames = arguments.toArray(new 
String[arguments.size()]);
 
         candidates = new ArrayList<FacebookMethodsType>();
-        candidates.addAll(getCandidateMethods(methodName, argNames));
+        candidates.addAll(getCandidateMethods(method, argNames));
         if (!candidates.isEmpty()) {
             // found an exact name match, allows disambiguation if needed
             this.nameStyle = FacebookNameStyle.EXACT;
@@ -139,17 +139,17 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
             // also search for long forms of method name, both get* and search*
             // Note that this set will be further sorted by Producers and 
Consumers
             // producers will prefer get* forms, and consumers should prefer 
search* forms
-            
candidates.addAll(getCandidateMethods(convertToGetMethod(methodName), 
argNames));
+            candidates.addAll(getCandidateMethods(convertToGetMethod(method), 
argNames));
             if (!candidates.isEmpty()) {
                 this.nameStyle = FacebookNameStyle.GET;
             }
 
             int nGetMethods = candidates.size();
-            
candidates.addAll(getCandidateMethods(convertToSearchMethod(methodName), 
argNames));
+            
candidates.addAll(getCandidateMethods(convertToSearchMethod(method), argNames));
             // error if there are no candidates
             if (candidates.isEmpty()) {
                 throw new IllegalArgumentException(
-                    String.format("No matching operation for %s, with 
arguments %s", methodName, arguments));
+                    String.format("No matching operation for %s, with 
arguments %s", method, arguments));
             }
 
             if (nameStyle == null) {
@@ -163,9 +163,9 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
 
         // log missing/extra properties for debugging
         if (LOG.isDebugEnabled()) {
-            final Set<String> missing = getMissingProperties(methodName, 
nameStyle, arguments);
+            final Set<String> missing = getMissingProperties(method, 
nameStyle, arguments);
             if (!missing.isEmpty()) {
-                LOG.debug("Method {} could use one or more properties from 
{}", methodName, missing);
+                LOG.debug("Method {} could use one or more properties from 
{}", method, missing);
             }
         }
     }
@@ -174,14 +174,6 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
         return configuration;
     }
 
-    public String getMethodName() {
-        return methodName;
-    }
-
-    public FacebookNameStyle getNameStyle() {
-        return nameStyle;
-    }
-
     public List<FacebookMethodsType> getCandidates() {
         return Collections.unmodifiableList(candidates);
     }
@@ -190,6 +182,17 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
         return inBody;
     }
 
+    public String getMethod() {
+        return method;
+    }
+
+    public FacebookNameStyle getNameStyle() {
+        return nameStyle;
+    }
+
+    /**
+     * Sets the name of a parameter to be passed in the exchange In Body
+     */
     public void setInBody(String inBody) {
         // validate property name
         ObjectHelper.notNull(inBody, "inBody");
@@ -199,4 +202,8 @@ public class FacebookEndpoint extends DefaultEndpoint 
implements FacebookConstan
         this.inBody = inBody;
     }
 
+    @Override
+    protected void doStart() throws Exception {
+        super.doStart();
+    }
 }

http://git-wip-us.apache.org/repos/asf/camel/blob/21541cf6/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java
----------------------------------------------------------------------
diff --git 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java
 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java
index 5819402..14d37f2 100644
--- 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java
+++ 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java
@@ -136,10 +136,10 @@ public class FacebookProducer extends 
DefaultAsyncProducer {
 
             // get the method to call
             if (filteredMethods.isEmpty()) {
-                final Set<String> missing = 
getMissingProperties(endpoint.getMethodName(),
+                final Set<String> missing = 
getMissingProperties(endpoint.getMethod(),
                     endpoint.getNameStyle(), argNames);
                 throw new RuntimeCamelException(String.format("Missing 
properties for %s, need one or more from %s",
-                        endpoint.getMethodName(), missing));
+                        endpoint.getMethod(), missing));
             } else if (filteredMethods.size() == 1) {
                 // found an exact match
                 method = filteredMethods.get(0);

http://git-wip-us.apache.org/repos/asf/camel/blob/21541cf6/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookConfiguration.java
----------------------------------------------------------------------
diff --git 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookConfiguration.java
 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookConfiguration.java
index 20a2ebb..c52fd12 100644
--- 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookConfiguration.java
+++ 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookConfiguration.java
@@ -41,26 +41,25 @@ public class FacebookConfiguration implements Cloneable {
     private String oAuthAppSecret;
     @UriParam
     private String oAuthAccessToken;
-    @UriParam
+    @UriParam(defaultValue = "https://www.facebook.com/dialog/oauth";)
     private String oAuthAuthorizationURL;
     @UriParam
     private String oAuthPermissions;
-
-    @UriParam
+    @UriParam(defaultValue = "https://graph.facebook.com/oauth/access_token";)
     private String oAuthAccessTokenURL;
     @UriParam
     private String clientURL;
     @UriParam
     private String clientVersion;
-    @UriParam
+    @UriParam(defaultValue = "false")
     private Boolean debugEnabled;
-    @UriParam
+    @UriParam(defaultValue = "true")
     private Boolean gzipEnabled;
-    @UriParam
+    @UriParam(defaultValue = "20000")
     private Integer httpConnectionTimeout;
-    @UriParam
+    @UriParam(defaultValue = "2")
     private Integer httpDefaultMaxPerRoute;
-    @UriParam
+    @UriParam(defaultValue = "20")
     private Integer httpMaxTotalConnections;
     @UriParam
     private String httpProxyHost;
@@ -70,25 +69,25 @@ public class FacebookConfiguration implements Cloneable {
     private Integer httpProxyPort;
     @UriParam
     private String httpProxyUser;
-    @UriParam
+    @UriParam(defaultValue = "120000")
     private Integer httpReadTimeout;
-    @UriParam
+    @UriParam(defaultValue = "0")
     private Integer httpRetryCount;
-    @UriParam
+    @UriParam(defaultValue = "5")
     private Integer httpRetryIntervalSeconds;
-    @UriParam
+    @UriParam(defaultValue = "40000")
     private Integer httpStreamingReadTimeout;
-    @UriParam
+    @UriParam(defaultValue = "false")
     private Boolean jsonStoreEnabled;
-    @UriParam
+    @UriParam(defaultValue = "false")
     private Boolean mbeanEnabled;
-    @UriParam
+    @UriParam(defaultValue = "false")
     private Boolean prettyDebugEnabled;
-    @UriParam
+    @UriParam(defaultValue = "https://graph.facebook.com/";)
     private String restBaseURL;
-    @UriParam
+    @UriParam(defaultValue = "true")
     private Boolean useSSL;
-    @UriParam
+    @UriParam(defaultValue = "https://graph-video.facebook.com/";)
     private String videoBaseURL;
 
     // cached FaceBook instance, is created in getFacebook by endpoint 
producers and consumers
@@ -220,6 +219,9 @@ public class FacebookConfiguration implements Cloneable {
         return oAuthAccessToken;
     }
 
+    /**
+     * The user access token
+     */
     public void setOAuthAccessToken(String oAuthAccessToken) {
         this.oAuthAccessToken = oAuthAccessToken;
     }
@@ -228,6 +230,9 @@ public class FacebookConfiguration implements Cloneable {
         return oAuthAccessTokenURL;
     }
 
+    /**
+     * OAuth access token URL
+     */
     public void setOAuthAccessTokenURL(String oAuthAccessTokenURL) {
         this.oAuthAccessTokenURL = oAuthAccessTokenURL;
     }
@@ -236,6 +241,9 @@ public class FacebookConfiguration implements Cloneable {
         return oAuthAppId;
     }
 
+    /**
+     * The application Id
+     */
     public void setOAuthAppId(String oAuthAppId) {
         this.oAuthAppId = oAuthAppId;
     }
@@ -244,6 +252,9 @@ public class FacebookConfiguration implements Cloneable {
         return oAuthAppSecret;
     }
 
+    /**
+     * The application Secret
+     */
     public void setOAuthAppSecret(String oAuthAppSecret) {
         this.oAuthAppSecret = oAuthAppSecret;
     }
@@ -252,6 +263,9 @@ public class FacebookConfiguration implements Cloneable {
         return oAuthAuthorizationURL;
     }
 
+    /**
+     * OAuth authorization URL
+     */
     public void setOAuthAuthorizationURL(String oAuthAuthorizationURL) {
         this.oAuthAuthorizationURL = oAuthAuthorizationURL;
     }
@@ -260,6 +274,9 @@ public class FacebookConfiguration implements Cloneable {
         return clientURL;
     }
 
+    /**
+     * Facebook4J API client URL
+     */
     public void setClientURL(String clientURL) {
         this.clientURL = clientURL;
     }
@@ -268,6 +285,9 @@ public class FacebookConfiguration implements Cloneable {
         return clientVersion;
     }
 
+    /**
+     * Facebook4J client API version
+     */
     public void setClientVersion(String clientVersion) {
         this.clientVersion = clientVersion;
     }
@@ -276,6 +296,9 @@ public class FacebookConfiguration implements Cloneable {
         return debugEnabled;
     }
 
+    /**
+     * Enables deubg output. Effective only with the embedded logger
+     */
     public void setDebugEnabled(Boolean debugEnabled) {
         this.debugEnabled = debugEnabled;
     }
@@ -284,6 +307,9 @@ public class FacebookConfiguration implements Cloneable {
         return gzipEnabled;
     }
 
+    /**
+     * Use Facebook GZIP encoding
+     */
     public void setGzipEnabled(Boolean gzipEnabled) {
         this.gzipEnabled = gzipEnabled;
     }
@@ -292,6 +318,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpConnectionTimeout;
     }
 
+    /**
+     * Http connection timeout in milliseconds
+     */
     public void setHttpConnectionTimeout(Integer httpConnectionTimeout) {
         this.httpConnectionTimeout = httpConnectionTimeout;
     }
@@ -300,6 +329,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpDefaultMaxPerRoute;
     }
 
+    /**
+     * HTTP maximum connections per route
+     */
     public void setHttpDefaultMaxPerRoute(Integer httpDefaultMaxPerRoute) {
         this.httpDefaultMaxPerRoute = httpDefaultMaxPerRoute;
     }
@@ -308,6 +340,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpMaxTotalConnections;
     }
 
+    /**
+     * HTTP maximum total connections
+     */
     public void setHttpMaxTotalConnections(Integer httpMaxTotalConnections) {
         this.httpMaxTotalConnections = httpMaxTotalConnections;
     }
@@ -316,6 +351,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpProxyHost;
     }
 
+    /**
+     * HTTP proxy server host name
+     */
     public void setHttpProxyHost(String httpProxyHost) {
         this.httpProxyHost = httpProxyHost;
     }
@@ -324,6 +362,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpProxyPassword;
     }
 
+    /**
+     * HTTP proxy server password
+     */
     public void setHttpProxyPassword(String httpProxyPassword) {
         this.httpProxyPassword = httpProxyPassword;
     }
@@ -332,6 +373,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpProxyPort;
     }
 
+    /**
+     * HTTP proxy server port
+     */
     public void setHttpProxyPort(Integer httpProxyPort) {
         this.httpProxyPort = httpProxyPort;
     }
@@ -340,6 +384,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpProxyUser;
     }
 
+    /**
+     * HTTP proxy server user name
+     */
     public void setHttpProxyUser(String httpProxyUser) {
         this.httpProxyUser = httpProxyUser;
     }
@@ -348,6 +395,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpReadTimeout;
     }
 
+    /**
+     * Http read timeout in milliseconds
+     */
     public void setHttpReadTimeout(Integer httpReadTimeout) {
         this.httpReadTimeout = httpReadTimeout;
     }
@@ -356,6 +406,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpRetryCount;
     }
 
+    /**
+     * Number of HTTP retries
+     */
     public void setHttpRetryCount(Integer httpRetryCount) {
         this.httpRetryCount = httpRetryCount;
     }
@@ -364,6 +417,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpRetryIntervalSeconds;
     }
 
+    /**
+     * HTTP retry interval in seconds
+     */
     public void setHttpRetryIntervalSeconds(Integer httpRetryIntervalSeconds) {
         this.httpRetryIntervalSeconds = httpRetryIntervalSeconds;
     }
@@ -372,6 +428,9 @@ public class FacebookConfiguration implements Cloneable {
         return httpStreamingReadTimeout;
     }
 
+    /**
+     * HTTP streaming read timeout in milliseconds
+     */
     public void setHttpStreamingReadTimeout(Integer httpStreamingReadTimeout) {
         this.httpStreamingReadTimeout = httpStreamingReadTimeout;
     }
@@ -380,6 +439,9 @@ public class FacebookConfiguration implements Cloneable {
         return jsonStoreEnabled;
     }
 
+    /**
+     * If set to true, raw JSON forms will be stored in DataObjectFactory
+     */
     public void setJsonStoreEnabled(Boolean jsonStoreEnabled) {
         this.jsonStoreEnabled = jsonStoreEnabled;
     }
@@ -388,6 +450,9 @@ public class FacebookConfiguration implements Cloneable {
         return mbeanEnabled;
     }
 
+    /**
+     * If set to true, Facebook4J mbean will be registerd
+     */
     public void setMbeanEnabled(Boolean mbeanEnabled) {
         this.mbeanEnabled = mbeanEnabled;
     }
@@ -396,6 +461,10 @@ public class FacebookConfiguration implements Cloneable {
         return oAuthPermissions;
     }
 
+    /**
+     * Default OAuth permissions. Comma separated permission names.
+     * See https://developers.facebook.com/docs/reference/login/#permissions 
for the detail
+     */
     public void setOAuthPermissions(String oAuthPermissions) {
         this.oAuthPermissions = oAuthPermissions;
     }
@@ -404,6 +473,9 @@ public class FacebookConfiguration implements Cloneable {
         return prettyDebugEnabled;
     }
 
+    /**
+     * Prettify JSON debug output if set to true
+     */
     public void setPrettyDebugEnabled(Boolean prettyDebugEnabled) {
         this.prettyDebugEnabled = prettyDebugEnabled;
     }
@@ -412,6 +484,9 @@ public class FacebookConfiguration implements Cloneable {
         return restBaseURL;
     }
 
+    /**
+     * API base URL
+     */
     public void setRestBaseURL(String restBaseURL) {
         this.restBaseURL = restBaseURL;
     }
@@ -420,6 +495,9 @@ public class FacebookConfiguration implements Cloneable {
         return useSSL;
     }
 
+    /**
+     * Use SSL
+     */
     public void setUseSSL(Boolean useSSL) {
         this.useSSL = useSSL;
     }
@@ -428,6 +506,9 @@ public class FacebookConfiguration implements Cloneable {
         return videoBaseURL;
     }
 
+    /**
+     * Video API base URL
+     */
     public void setVideoBaseURL(String videoBaseURL) {
         this.videoBaseURL = videoBaseURL;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/21541cf6/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookEndpointConfiguration.java
----------------------------------------------------------------------
diff --git 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookEndpointConfiguration.java
 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookEndpointConfiguration.java
index fc6bb26..a8375af 100644
--- 
a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookEndpointConfiguration.java
+++ 
b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/config/FacebookEndpointConfiguration.java
@@ -49,6 +49,7 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
     @UriParam
     private GeoLocation center;
     @UriParam
+    @Deprecated
     private CheckinUpdate checkinUpdate;
     @UriParam
     private String checkinId;
@@ -163,6 +164,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return achievementURL;
     }
 
+    /**
+     * The unique URL of the achievement
+     */
     public void setAchievementURL(URL achievementURL) {
         this.achievementURL = achievementURL;
     }
@@ -171,6 +175,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return albumUpdate;
     }
 
+    /**
+     * The facebook Album to be created or updated
+     */
     public void setAlbumUpdate(AlbumUpdate albumUpdate) {
         this.albumUpdate = albumUpdate;
     }
@@ -179,6 +186,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return albumId;
     }
 
+    /**
+     * The album ID
+     */
     public void setAlbumId(String albumId) {
         this.albumId = albumId;
     }
@@ -187,6 +197,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return appId;
     }
 
+    /**
+     * The ID of the Facebook Application
+     */
     public void setAppId(String appId) {
         this.appId = appId;
     }
@@ -195,6 +208,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return center;
     }
 
+    /**
+     * Location latitude and longitude
+     */
     public void setCenter(GeoLocation center) {
         this.center = center;
     }
@@ -203,6 +219,11 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return checkinUpdate;
     }
 
+    /**
+     * The checkin to be created. Deprecated, instead create a Post with an 
attached location
+     * @deprecated instead create a Post with an attached location
+     */
+    @Deprecated
     public void setCheckinUpdate(CheckinUpdate checkinUpdate) {
         this.checkinUpdate = checkinUpdate;
     }
@@ -211,6 +232,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return checkinId;
     }
 
+    /**
+     * The checkin ID
+     */
     public void setCheckinId(String checkinId) {
         this.checkinId = checkinId;
     }
@@ -219,6 +243,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return commentId;
     }
 
+    /**
+     * The comment ID
+     */
     public void setCommentId(String commentId) {
         this.commentId = commentId;
     }
@@ -227,6 +254,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return description;
     }
 
+    /**
+     * The description text
+     */
     public void setDescription(String description) {
         this.description = description;
     }
@@ -235,6 +265,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return distance;
     }
 
+    /**
+     * Distance in meters
+     */
     public void setDistance(Integer distance) {
         this.distance = distance;
     }
@@ -243,6 +276,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return domainId;
     }
 
+    /**
+     * The domain ID
+     */
     public void setDomainId(String domainId) {
         this.domainId = domainId;
     }
@@ -251,6 +287,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return domainName;
     }
 
+    /**
+     * The domain name
+     */
     public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
@@ -259,6 +298,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return domainNames;
     }
 
+    /**
+     * The domain names
+     */
     public void setDomainNames(List<String> domainNames) {
         this.domainNames = domainNames;
     }
@@ -267,6 +309,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return eventId;
     }
 
+    /**
+     * The event ID
+     */
     public void setEventId(String eventId) {
         this.eventId = eventId;
     }
@@ -275,6 +320,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return eventUpdate;
     }
 
+    /**
+     * The event to be created or updated
+     */
     public void setEventUpdate(EventUpdate eventUpdate) {
         this.eventUpdate = eventUpdate;
     }
@@ -283,6 +331,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return friendId;
     }
 
+    /**
+     * The friend ID
+     */
     public void setFriendId(String friendId) {
         this.friendId = friendId;
     }
@@ -291,6 +342,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return friendUserId;
     }
 
+    /**
+     * The friend user ID
+     */
     public void setFriendUserId(String friendUserId) {
         this.friendUserId = friendUserId;
     }
@@ -299,6 +353,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return friendlistId;
     }
 
+    /**
+     * The friend list ID
+     */
     public void setFriendlistId(String friendlistId) {
         this.friendlistId = friendlistId;
     }
@@ -307,6 +364,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return friendlistName;
     }
 
+    /**
+     * The friend list Name
+     */
     public void setFriendlistName(String friendlistName) {
         this.friendlistName = friendlistName;
     }
@@ -315,6 +375,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return groupId;
     }
 
+    /**
+     * The group ID
+     */
     public void setGroupId(String groupId) {
         this.groupId = groupId;
     }
@@ -323,6 +386,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return ids;
     }
 
+    /**
+     * The ids of users
+     */
     public void setIds(List<String> ids) {
         this.ids = ids;
     }
@@ -331,6 +397,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return includeRead;
     }
 
+    /**
+     * Enables notifications that the user has already read in addition to 
unread ones
+     */
     public void setIncludeRead(Boolean includeRead) {
         this.includeRead = includeRead;
     }
@@ -339,6 +408,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return link;
     }
 
+    /**
+     * Link URL
+     */
     public void setLink(URL link) {
         this.link = link;
     }
@@ -347,6 +419,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return linkId;
     }
 
+    /**
+     * Link ID
+     */
     public void setLinkId(String linkId) {
         this.linkId = linkId;
     }
@@ -355,6 +430,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return locale;
     }
 
+    /**
+     * Desired FQL locale
+     */
     public void setLocale(Locale locale) {
         this.locale = locale;
     }
@@ -363,6 +441,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return message;
     }
 
+    /**
+     * The message text
+     */
     public void setMessage(String message) {
         this.message = message;
     }
@@ -371,6 +452,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return messageId;
     }
 
+    /**
+     * The message ID
+     */
     public void setMessageId(String messageId) {
         this.messageId = messageId;
     }
@@ -379,6 +463,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return metric;
     }
 
+    /**
+     * The metric name
+     */
     public void setMetric(String metric) {
         this.metric = metric;
     }
@@ -387,6 +474,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return name;
     }
 
+    /**
+     * Test user name, must be of the form 'first last'
+     */
     public void setName(String name) {
         this.name = name;
     }
@@ -395,6 +485,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return noteId;
     }
 
+    /**
+     * The note ID
+     */
     public void setNoteId(String noteId) {
         this.noteId = noteId;
     }
@@ -403,6 +496,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return notificationId;
     }
 
+    /**
+     * The notification ID
+     */
     public void setNotificationId(String notificationId) {
         this.notificationId = notificationId;
     }
@@ -411,6 +507,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return objectId;
     }
 
+    /**
+     * The insight object ID
+     */
     public void setObjectId(String objectId) {
         this.objectId = objectId;
     }
@@ -419,6 +518,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return optionDescription;
     }
 
+    /**
+     * The question's answer option description
+     */
     public void setOptionDescription(String optionDescription) {
         this.optionDescription = optionDescription;
     }
@@ -427,6 +529,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return permissionName;
     }
 
+    /**
+     * The permission name
+     */
     public void setPermissionName(String permissionName) {
         this.permissionName = permissionName;
     }
@@ -435,6 +540,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return permissions;
     }
 
+    /**
+     * Test user permissions in the format perm1,perm2,...
+     */
     public void setPermissions(String permissions) {
         this.permissions = permissions;
     }
@@ -443,6 +551,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return photoId;
     }
 
+    /**
+     * The photo ID
+     */
     public void setPhotoId(String photoId) {
         this.photoId = photoId;
     }
@@ -451,6 +562,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return placeId;
     }
 
+    /**
+     * The place ID
+     */
     public void setPlaceId(String placeId) {
         this.placeId = placeId;
     }
@@ -459,6 +573,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return postId;
     }
 
+    /**
+     * The post ID
+     */
     public void setPostId(String postId) {
         this.postId = postId;
     }
@@ -467,6 +584,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return postUpdate;
     }
 
+    /**
+     * The post to create or update
+     */
     public void setPostUpdate(PostUpdate postUpdate) {
         this.postUpdate = postUpdate;
     }
@@ -475,6 +595,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return queries;
     }
 
+    /**
+     * FQL queries
+     */
     public void setQueries(Map<String, String> queries) {
         this.queries = queries;
     }
@@ -483,6 +606,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return query;
     }
 
+    /**
+     * FQL query or search terms for search* endpoints
+     */
     public void setQuery(String query) {
         this.query = query;
     }
@@ -491,6 +617,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return questionId;
     }
 
+    /**
+     * The question id
+     */
     public void setQuestionId(String questionId) {
         this.questionId = questionId;
     }
@@ -499,6 +628,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return reading;
     }
 
+    /**
+     * Optional reading parameters. See Reading Options(#reading)
+     */
     public void setReading(Reading reading) {
         this.reading = reading;
     }
@@ -507,6 +639,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return scoreValue;
     }
 
+    /**
+     * The numeric score with value
+     */
     public void setScoreValue(Integer scoreValue) {
         this.scoreValue = scoreValue;
     }
@@ -515,6 +650,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return size;
     }
 
+    /**
+     * The picture size, one of large, normal, small or square
+     */
     public void setSize(PictureSize size) {
         this.size = size;
     }
@@ -523,6 +661,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return source;
     }
 
+    /**
+     * The media content from either a java.io.File or java.io.Inputstream
+     */
     public void setSource(Media source) {
         this.source = source;
     }
@@ -531,6 +672,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return subject;
     }
 
+    /**
+     * The note of the subject
+     */
     public void setSubject(String subject) {
         this.subject = subject;
     }
@@ -539,6 +683,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return tagUpdate;
     }
 
+    /**
+     * Photo tag information
+     */
     public void setTagUpdate(TagUpdate tagUpdate) {
         this.tagUpdate = tagUpdate;
     }
@@ -547,6 +694,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return testUser1;
     }
 
+    /**
+     * Test user 1
+     */
     public void setTestUser1(TestUser testUser1) {
         this.testUser1 = testUser1;
     }
@@ -555,6 +705,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return testUser2;
     }
 
+    /**
+     * Test user 2
+     */
     public void setTestUser2(TestUser testUser2) {
         this.testUser2 = testUser2;
     }
@@ -563,6 +716,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return testUserId;
     }
 
+    /**
+     * The ID of the test user
+     */
     public void setTestUserId(String testUserId) {
         this.testUserId = testUserId;
     }
@@ -571,6 +727,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return title;
     }
 
+    /**
+     * The title text
+     */
     public void setTitle(String title) {
         this.title = title;
     }
@@ -579,6 +738,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return toUserId;
     }
 
+    /**
+     * The ID of the user to tag
+     */
     public void setToUserId(String toUserId) {
         this.toUserId = toUserId;
     }
@@ -587,6 +749,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return toUserIds;
     }
 
+    /**
+     * The IDs of the users to tag
+     */
     public void setToUserIds(List<String> toUserIds) {
         this.toUserIds = toUserIds;
     }
@@ -595,6 +760,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return userId1;
     }
 
+    /**
+     * The ID of a user 1
+     */
     public void setUserId1(String userId1) {
         this.userId1 = userId1;
     }
@@ -603,6 +771,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return userId2;
     }
 
+    /**
+     * The ID of a user 2
+     */
     public void setUserId2(String userId2) {
         this.userId2 = userId2;
     }
@@ -611,6 +782,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return userId;
     }
 
+    /**
+     * The Facebook user ID
+     */
     public void setUserId(String userId) {
         this.userId = userId;
     }
@@ -619,6 +793,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return userIds;
     }
 
+    /**
+     * The IDs of users to invite to event
+     */
     public void setUserIds(List<String> userIds) {
         this.userIds = userIds;
     }
@@ -627,6 +804,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return userLocale;
     }
 
+    /**
+     * The test user locale
+     */
     public void setUserLocale(String userLocale) {
         this.userLocale = userLocale;
     }
@@ -635,6 +815,9 @@ public class FacebookEndpointConfiguration extends 
FacebookConfiguration {
         return videoId;
     }
 
+    /**
+     * The video ID
+     */
     public void setVideoId(String videoId) {
         this.videoId = videoId;
     }

Reply via email to