Author: thobbs
Date: Thu Apr 19 13:49:26 2012
New Revision: 1327945
URL: http://svn.apache.org/viewvc?rev=1327945&view=rev
Log:
Finished javadocs
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/DefaultOptions.java
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ClasspathSetting.java
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/CodebaseSetting.java
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/GroupedSetting.java
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/InitialLookupAttributesSetting.java
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/PolicySetting.java
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ServerExporterSetting.java
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/Setting.java
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/DefaultOptions.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/DefaultOptions.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/DefaultOptions.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/DefaultOptions.java
Thu Apr 19 13:49:26 2012
@@ -121,6 +121,7 @@ public class DefaultOptions implements C
public static final String HTTP_SERVER = "httpServer";
public static final String SERVICE_NAME = "serviceName";
public static final String INITIAL_ATTRIBS = "initialLookupAttributes";
+ public static final String POLICY = "policy";
// unique setting keys end
public static final String DEFAULT_JINI_PORT = "4160";
@@ -164,24 +165,13 @@ public class DefaultOptions implements C
"ConfigUtil.getHostName()",
NO_FORMAT,
false));
- options.put(CODEBASE, new CodebaseSetting(CODEBASE,
- options.get("httpPort"),
- options.get("httpServer"),
- Collections.<String>emptyList(),
- NO_FORMAT,
- STRING_FORMAT,
- false));
- options.put(CLASSPATH, new ClasspathSetting(CLASSPATH,
-
Collections.<String>emptyList(),
-
NO_FORMAT,
-
STRING_FORMAT,
-
false));
+ options.put(CODEBASE, new
CodebaseSetting(options.get(HTTP_PORT),
+ options.get(HTTP_SERVER),
+ Collections.<String>emptyList()));
+ options.put(CLASSPATH, new
ClasspathSetting(Collections.<String>emptyList()));
- options.put("policy", new PolicySetting("policy",
-
options.get("riverHome"),
-
"src-extra/policy.all",
-
STRING_FORMAT,
-
false));
+ options.put(POLICY, new PolicySetting(options.get("riverHome"),
+
"src-extra/policy.all"));
options.put("serverExporter", new ServerExporterSetting());
options.put(INITIAL_ATTRIBS, new
InitialLookupAttributesSetting());
}
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ClasspathSetting.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ClasspathSetting.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ClasspathSetting.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ClasspathSetting.java
Thu Apr 19 13:49:26 2012
@@ -19,14 +19,25 @@ package org.apache.river.extra.easystart
import java.util.List;
+import net.jini.config.ConfigurationFile;
+
+import org.apache.river.extra.easystart.config.DefaultOptions;
+
+/**
+ * Specialist group based setting to handle the classpath setting according to
+ * the {@link ConfigurationFile} specification.
+ *
+ * @author Tom Hobbs
+ *
+ */
public class ClasspathSetting extends GroupedSetting {
- public ClasspathSetting(String name,
- List<String> defaults,
- String format,
- String elementFormat,
- boolean
serviceDescription) {
- super(name, defaults, format, elementFormat,
serviceDescription);
+ public ClasspathSetting(List<String> defaults) {
+ super(DefaultOptions.CLASSPATH,
+ defaults,
+ DefaultOptions.NO_FORMAT,
+ DefaultOptions.STRING_FORMAT,
+ false);
}
@Override
@@ -48,13 +59,12 @@ public class ClasspathSetting extends Gr
return String.format(super.getFormatter(), sb.toString());
}
+ /**
+ * Provides a deep copy.
+ */
@Override
public Object clone() {
- GroupedSetting clone = new ClasspathSetting(super.name,
-
super.defaults,
-
super.format,
-
this.elementFormat,
-
super.isServiceDescription());
+ GroupedSetting clone = new ClasspathSetting(super.defaults);
for(String override : this.overrides) {
clone.add(override);
}
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/CodebaseSetting.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/CodebaseSetting.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/CodebaseSetting.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/CodebaseSetting.java
Thu Apr 19 13:49:26 2012
@@ -19,19 +19,30 @@ package org.apache.river.extra.easystart
import java.util.List;
+import net.jini.config.ConfigurationFile;
+
+import org.apache.river.extra.easystart.config.DefaultOptions;
+
+/**
+ * Specialist GroupSetting for handling the definition of the
<code>codebase</code>
+ * according to the {@link ConfigurationFile}.#
+ *
+ * @author Tom Hobbs
+ *
+ */
public class CodebaseSetting extends GroupedSetting {
private final Setting httpPort;
private final Setting httpServer;
- public CodebaseSetting(String name,
- Setting httpPort,
+ public CodebaseSetting(Setting httpPort,
Setting httpServer,
- List<String> defaults,
- String format,
- String elementFormat,
- boolean
serviceDescription) {
- super(name, defaults, format, elementFormat,
serviceDescription);
+ List<String> defaults) {
+ super(DefaultOptions.CODEBASE,
+ defaults,
+ DefaultOptions.NO_FORMAT,
+ DefaultOptions.STRING_FORMAT,
+ false);
this.httpPort = httpPort;
this.httpServer = httpServer;
@@ -62,13 +73,9 @@ public class CodebaseSetting extends Gro
@Override
public Object clone() {
- GroupedSetting clone = new CodebaseSetting(super.name,
-
this.httpPort,
+ GroupedSetting clone = new CodebaseSetting(this.httpPort,
this.httpServer,
-
super.defaults,
-
super.format,
-
this.elementFormat,
-
super.isServiceDescription());
+
super.defaults);
for(String override : this.overrides) {
clone.add(override);
}
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/GroupedSetting.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/GroupedSetting.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/GroupedSetting.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/GroupedSetting.java
Thu Apr 19 13:49:26 2012
@@ -20,6 +20,16 @@ package org.apache.river.extra.easystart
import java.util.LinkedList;
import java.util.List;
+import net.jini.config.ConfigurationFile;
+
+/**
+ * A specialist implemention of Setting to be used when the configuration item
+ * would be described as a <code>String[]</code> if it were being specified
+ * in a {@link ConfigurationFile}.
+ *
+ * @author Tom Hobbs
+ *
+ */
public class GroupedSetting extends Setting {
protected final String elementFormat;
@@ -78,6 +88,9 @@ public class GroupedSetting extends Sett
return sb.toString();
}
+ /**
+ * Provides a deep copy.
+ */
@Override
public Object clone() {
GroupedSetting clone = new GroupedSetting(super.name,
this.defaults, super.format, this.elementFormat, super.isServiceDescription());
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/InitialLookupAttributesSetting.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/InitialLookupAttributesSetting.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/InitialLookupAttributesSetting.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/InitialLookupAttributesSetting.java
Thu Apr 19 13:49:26 2012
@@ -20,10 +20,20 @@ package org.apache.river.extra.easystart
import java.util.LinkedList;
import java.util.List;
+import net.jini.core.entry.Entry;
import net.jini.lookup.entry.Name;
import org.apache.river.extra.easystart.config.DefaultOptions;
+/**
+ * Encapsulated the configuration of the initial lookup attributes which,
+ * according to the ConfigurationFile specification is an array of {@link
Entry}
+ *
+ * Currently, it only support {@link Name}.
+ *
+ * @author Tom Hobbs
+ *
+ */
public class InitialLookupAttributesSetting extends GroupedSetting {
public InitialLookupAttributesSetting() {
@@ -53,6 +63,10 @@ public class InitialLookupAttributesSett
return sb.toString();
}
+
+ /**
+ * Provides a deep copy.
+ */
@Override
public Object clone() {
InitialLookupAttributesSetting clone = new
InitialLookupAttributesSetting();
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/PolicySetting.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/PolicySetting.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/PolicySetting.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/PolicySetting.java
Thu Apr 19 13:49:26 2012
@@ -19,16 +19,33 @@ package org.apache.river.extra.easystart
import java.io.File;
+import org.apache.river.extra.easystart.config.DefaultOptions;
+
+/**
+ * Specific Setting implementation to represent a Java security policy file.
+ *
+ * @author Tom Hobbs
+ *
+ */
public class PolicySetting extends Setting {
private final Setting riverHome;
- public PolicySetting(String name,
- Setting riverHome,
- String defaultValue,
- String format,
- boolean
serviceDescription) {
- super(name, defaultValue, format, serviceDescription);
+ /**
+ * If the riverHome is null, then the default policy file found in the
value
+ * of riverHome will be used instead.
+ *
+ * @param riverHome
+ * The location of the River installation or null
+ * @param defaultValue
+ * The default location and name of the policy file
+ */
+ public PolicySetting(Setting riverHome,
+ String defaultValue) {
+ super(DefaultOptions.POLICY,
+ defaultValue,
+ DefaultOptions.STRING_FORMAT,
+ false);
this.riverHome = riverHome;
}
@@ -50,8 +67,13 @@ public class PolicySetting extends Setti
}
}
+ /**
+ * Provides a deep clone.
+ */
@Override
public Object clone() {
- return new PolicySetting(this.name, this.riverHome,
this.defaultValue, this.format, this.serviceDescription);
+ PolicySetting ps = new PolicySetting(this.riverHome,
this.defaultValue);
+ ps.setOverride(this.getOverride());
+ return ps;
}
}
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ServerExporterSetting.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ServerExporterSetting.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ServerExporterSetting.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/ServerExporterSetting.java
Thu Apr 19 13:49:26 2012
@@ -19,10 +19,19 @@ package org.apache.river.extra.easystart
import org.apache.river.extra.easystart.config.DefaultOptions;
+/**
+ * A specific kind of Setting that allows the configuration to be easily
+ * changed between JRMP and JERI endpoints.
+ * @author Tom Hobbs
+ *
+ */
public class ServerExporterSetting extends Setting {
private static final String JRMP_STRING = "new
net.jini.jrmp.JrmpExporter()";
+ /**
+ * Simple constructor that defaults to JRMP.
+ */
public ServerExporterSetting() {
super("serverExporter", JRMP_STRING, DefaultOptions.NO_FORMAT,
true);
}
@@ -38,6 +47,9 @@ public class ServerExporterSetting exten
+", new
net.jini.jeri.BasicILFactory())");
}
+ /**
+ * Provides a deep clone.
+ */
@Override
public Object clone() {
ServerExporterSetting clone = new ServerExporterSetting();
Modified:
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/Setting.java
URL:
http://svn.apache.org/viewvc/river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/Setting.java?rev=1327945&r1=1327944&r2=1327945&view=diff
==============================================================================
---
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/Setting.java
(original)
+++
river/jtsk/skunk/easystart/src-extra/org/apache/river/extra/easystart/config/settings/Setting.java
Thu Apr 19 13:49:26 2012
@@ -17,13 +17,12 @@
*/
package org.apache.river.extra.easystart.config.settings;
+import org.apache.river.extra.easystart.config.DefaultOptions;
+
/**
- * This is an enum-like class which encapsulates some default options when
- * using River services.
- *
- * It is not an enum, on purpose, in order to allow other users to easily
- * extend and replace as required.
+ * Basic class for holding a default setting with an overridable option. All
+ * service configuration items should be described as some kind of Setting.
*
* @author Tom Hobbs
*
@@ -34,6 +33,20 @@ public class Setting implements Cloneabl
protected final boolean serviceDescription;
protected String override;
+ /**
+ * Simple constructor.
+ *
+ * @param name
+ * The unique key of the Setting
+ * @param defaultValue
+ * The settings default value
+ * @param format
+ * A String formatter for the value, see {@link
DefaultOptions.STRING_FORMAT}
+ * and other such fields
+ * @param serviceDescription
+ * Whether or not this setting describes the service or is some
other
+ * configuration item (such as HTTP port and others)
+ */
public Setting(String name, String defaultValue, String format, boolean
serviceDescription) {
this.name = name;
this.defaultValue = defaultValue;
@@ -75,6 +88,9 @@ public class Setting implements Cloneabl
return this.override;
}
+ /**
+ * Provides a deep clone
+ */
@Override
public Object clone() {
Setting clone = new Setting(this.name, this.defaultValue,
this.format, this.serviceDescription);
