Document properties in FluoConfiguration javadoc

[keith-turner]

In #899 I added the following methods to FluoConfiguration. Would be nice to add the info about the property being set or got to all getters and setters in FluoConfiguration. Specifically, adding something like Gets/Sets the value of the property {@value #CONNECTION_ZOOKEEPER_SECRET} for each method would be very useful.

  /**
   * Get the secret configured to access data in zookeeper. If the secret is an empty string, then
   * nothing in zookeeper is locked down.
   *
   * <p>
   * Gets the value of the property {@value #CONNECTION_ZOOKEEPER_SECRET}
   *
   * @since 1.2.0
   */
  public String getZookeeperSecret() {
    return getString(CONNECTION_ZOOKEEPER_SECRET, "");
  }

  /**
   * Setting this before initializing an application will cause Fluo to lock down Zookeeper such
   * that this secret is required to read data from zookeeper. If set to an empty string, then
   * nothing in zookeeper will be locked down. This property defaults to an empty string.
   *
   * <p>
   * Sets the value of the property {@value #CONNECTION_ZOOKEEPER_SECRET}
   *
   * @since 1.2.0
   */
  public void setZookeeperSecret(String secret) {
    setProperty(CONNECTION_ZOOKEEPER_SECRET, verifyNotNull(CONNECTION_ZOOKEEPER_SECRET, secret));
  }

[keith-turner]

I added this task to https://helpwanted.apache.org

[kennethmcfarland]

That's where I found it. I'd like to pick up this task if if that's alright.

[mikewalch]

Thanks @kpm1985!

[keith-turner]

I'd like to pick up this task if if that's alright.

That would be great @kpm1985 I will assign the task to you. Let us know if you have any questions. Below are the commands to build the javadoc.

# build javadoc
mvn clean package javadoc:javadoc -DskipTests
# open javadoc w/ browswer and look at FluoConfiguration
firefox modules/api/target/site/apidocs/index.html

[keith-turner]

@kpm1985 I will assign the task to you

@kpm1985 Github is not allowing me to assign the issue to you, however its all yours.

[kennethmcfarland]

Sorry, it could have been because I hadn't forked yet, not sure, but thank you for the opportunity. I'm looking forward to having fun and finishing this before I resume school.

[kennethmcfarland]

This is still a work in progress, but it would be appreciated if you could give a quick review to make sure I'm not over/under documenting anything so far. I plan on finishing this up tomorrow, and making the suggested changes as soon as I get them :)

https://github.com/kpm1985/fluo/blob/fluo-900/modules/api/src/main/java/org/apache/fluo/api/config/FluoConfiguration.java

[keith-turner]

@kpm1985 I opened kpm1985/fluo#1 and made some comments.

[keith-turner]

@kpm1985 are you still working in this? Do you need any assistance?

[kennethmcfarland]

I am still working, sorry for sitting on this. This should be finished before the weekend.

…

On Sep 13, 2017 7:25 AM, "Keith Turner" ***@***.***> wrote: @kpm1985 <https://github.com/kpm1985> are you still working in this? Do you need any assistance? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#900 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/Acg-LNs6hRsYc9qBacUi20rBsIz_b-xeks5sh-XygaJpZM4OuOhw> .

[stippireddy]

@keith-turner : Looks like this issue is still pending. I can pick it up.

[keith-turner]

@stippireddy that would be great

[keith-turner]

@stippireddy there is a PR for this issue now #928