Author: indika
Date: Mon Mar 9 13:00:54 2009
New Revision: 751667
URL: http://svn.apache.org/viewvc?rev=751667&view=rev
Log:
few java docs
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretCallbackHandlerFactory.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretLoadingModule.java
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretCallbackHandlerFactory.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretCallbackHandlerFactory.java?rev=751667&r1=751666&r2=751667&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretCallbackHandlerFactory.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretCallbackHandlerFactory.java
Mon Mar 9 13:00:54 2009
@@ -26,12 +26,21 @@
import java.util.Properties;
/**
- *
+ * Contains factory methods to create SecretCallbackHandler
*/
public class SecretCallbackHandlerFactory {
private static final Log log =
LogFactory.getLog(SecretCallbackHandlerFactory.class);
+ /**
+ * Creates a SecretCallbackHandler instance based on given properties
+ * At future , can extend this , if SecretCallbackHandler instance need
+ * some data in the initialization
+ *
+ * @param properties properties contains some information about how to
create a SecretCallbackHandler
+ * @param key use for getting related properties out of all
properties
+ * @return SecretCallbackHandler instance
+ */
public static SecretCallbackHandler createSecretCallbackHandler(Properties
properties,
String
key) {
String provider = MiscellaneousUtil.getProperty(
@@ -41,7 +50,14 @@
}
+ /**
+ * Creates a SecretCallbackHandler instance based on provided class
+ *
+ * @param provider provider class name
+ * @return SecretCallbackHandler instance
+ */
public static SecretCallbackHandler createSecretCallbackHandler(String
provider) {
+
if (provider != null && !"".equals(provider)) {
try {
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretLoadingModule.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretLoadingModule.java?rev=751667&r1=751666&r2=751667&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretLoadingModule.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/secret/SecretLoadingModule.java
Mon Mar 9 13:00:54 2009
@@ -22,13 +22,18 @@
import java.util.List;
/**
- *
+ * Loads the secret on behalf of applications
*/
public class SecretLoadingModule {
private final List<SecretCallbackHandler> secretCallbackHandlers =
new ArrayList<SecretCallbackHandler>();
+ /**
+ * Initialized SecretLoadingModule with SecretCallbackHandlers
+ *
+ * @param secretCallbackHandlers SecretCallbackHandlers
+ */
public void init(SecretCallbackHandler[] secretCallbackHandlers) {
for (SecretCallbackHandler secretCallbackHandler :
secretCallbackHandlers) {
if (secretCallbackHandler != null) {
@@ -37,6 +42,11 @@
}
}
+ /**
+ * Load secrets into given clasbacks. Use all registered call back handlers
+ *
+ * @param secretCallbacks SecretCallbacks
+ */
public void load(SecretCallback[] secretCallbacks) {
for (SecretCallbackHandler secretCallbackHandler :
secretCallbackHandlers) {
if (secretCallbackHandler != null) {
