\n"); - baseOutput.append("\t

Layer: " + layer.Name + "

\n"); - - layerOutput.append("\n"); - layerOutput.append("" + - ""); - - for(Map.Entry mod:layer.Children.entrySet()){ - // module output will be filled with in-depth module info. - StringBuffer moduleOutput = new StringBuffer(); - Module module = mod.getValue(); - - // get the content for the module's document - moduleOutput.append(moduleContent(mod.getValue()).toString() + ""); - - // get the summary and name for the layer's document - - layerOutput.append("" + - "\n\n"); - - // write module document - FileWrite(layer.Name + "_" + module.Name + HTMLEXT, - headerOutput.toString() + "\n" + baseOutput.toString() + moduleOutput.toString() + footerOutput.toString()); - } - // write layer document - FileWrite(layer.Name + HTMLEXT, - headerOutput.toString() + "\n" + baseOutput.toString() - + layerOutput.toString() + "" + footerOutput.toString()); - - } - } - - private StringBuffer Menu(String key){ - StringBuffer out = new StringBuffer(); - out.append("
\n"); - for(Map.Entry layer:policy.Children.entrySet()){ - String layerName = layer.getKey(); - - - // show the modules for the current key - if (layerName.equals(key)){ - out.append("\t" + layerName + "
\n"); - out.append("\t
\n"); - for(Map.Entry module:layer.getValue().Children.entrySet()){ - String moduleName = module.getKey(); - out.append("\t\t- " + moduleName + "
\n"); - } - out.append("\t
\n"); - } else { - out.append("\t+ " + layerName + "
\n"); - } - } - out.append("
"); - return out; - } - - private StringBuffer Menu(){ - StringBuffer out = new StringBuffer(); - out.append("
\n"); - for(Map.Entry layer:policy.Children.entrySet()){ - String layerName = layer.getKey(); - - - out.append("\t" + layerName + "
\n"); - out.append("\t
\n"); - for(Map.Entry module:layer.getValue().Children.entrySet()){ - String moduleName = module.getKey(); - out.append("\t\t- " + moduleName + "
\n"); - } - out.append("\t
\n"); - } - out.append("
"); - return out; - } - - private StringBuffer moduleContent(Module module){ - StringBuffer out = new StringBuffer(); - - out.append("\t
Module: "+ module.Name + "
\n"); - out.append("\tSummary: " + module.PCDATA + "
\n"); - for (Map.Entry inter:module.Children.entrySet()){ - Interface iface = inter.getValue(); - // main table header - out.append("
Module Name Summary
" + module.Name + " " + module.PCDATA + "
\n"); - out.append("\n"); - - // only show weight when type isnt none - if (iface.Type != InterfaceType.None){ - out.append("\n" + - "\n"); - out.append("\t\n"); - } else { - out.append("\n"); - out.append("\n"); - - } - out.append("\n"); - - out.append("
Interface
Name " + iface.Name + "
Flow Type " + iface.Type.toString() + "
Flow Weight " + iface.Weight + "
Name " + iface.Name + "
Flow Type " + iface.Type.toString() + "
Description " + iface.PCDATA + "
\n" - + "" - + ""); - for (Map.Entry param:iface.Children.entrySet()){ - Parameter parameter = param.getValue(); - out.append("\t\n"); - out.append("\t\n"); - String opt = parameter.GetAttribute("optional"); - if (opt != null && opt.equalsIgnoreCase("true")){ - out.append("\t\n"); - } else { - out.append("\t\n"); - } - } - out.append("\n
Parameter Description Optional
" + parameter.Name + " " + parameter.PCDATA + " Yes
No

\n"); - } - return out; - } - - /** - * Write to sub directory. - * @param path - * @param outFilename - * @param content - * @return - */ - private void FileWrite (String path, String outFilename, String content){ - try { - // create parent if necessary - File outParent = new File(outDir, path ); - File outFile = new File(outParent, outFilename ); - if (outParent.exists() && !outParent.isDirectory()){ - throw new IOException("Output directory not really a directory"); - } else if (!outParent.exists()){ - outParent.mkdirs(); - } - PrintStream stream = new PrintStream(new FileOutputStream(outFile)); - stream.println(content); - stream.flush(); - stream.close(); - } catch (Exception e){ - System.err.println (e.getMessage()); - System.exit(1); - } - } - - /** - * Write to output directory directly. - * - * @param path - * @param outFilename - * @param content - * @return - */ - private void FileWrite (String outFilename, String content){ - try { - File out = new File(outDir, outFilename ); - PrintStream stream = new PrintStream(new FileOutputStream(out)); - stream.println(content); - stream.flush(); - stream.close(); - } catch (Exception e){ - System.err.println (e.getMessage()); - System.exit(1); - } - } -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/src/Docgen.java b/refpolicy/doc/doctools/src/Docgen.java deleted file mode 100644 index 12e38bf..0000000 --- a/refpolicy/doc/doctools/src/Docgen.java +++ /dev/null @@ -1,565 +0,0 @@ -/* Copyright (C) 2005 Tresys Technology, LLC - * License: refer to COPYING file for license information. - * Authors: Spencer Shimko - * - * Docgen.java: The reference policy xml analyzer and documentation generator - */ -import policy.*; - -import java.io.*; -import java.util.*; - -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.parsers.ParserConfigurationException; - -import javax.xml.validation.SchemaFactory; -import javax.xml.validation.Schema; - -import javax.xml.XMLConstants; - -import org.xml.sax.*; -import org.w3c.dom.*; - -/** - * The reference policy documentation generator and xml analyzer class. - * It pulls in XML describing reference policy, transmogrifies it, - * and spits it back out in some other arbitrary format. - */ -public class Docgen{ - // store the PIs here - private static Vector procInstr = new Vector(); - private static boolean verbose = false; - // the policy structure built after xml is parsed - private Policy policy = null; - // the xml document - private Document dom = null; - - // the files/directories passed in from the command line - private static File xmlFile; - private static File headerFile; - private static File footerFile; - private static File outputDir; - - private static void printUsage(){ - System.out.println("Reference Policy Documentation Compiler usage:"); - System.out.println("\tjava -cp ./src Docgen [-h] [-v] -xf xmlFileIn -hf headerFile -ff footerFile -od outDirectory"); - System.out.println("-h display this message and exit"); - System.out.println("-xf XML file to parse"); - System.out.println("-hf header file for HTML output"); - System.out.println("-ff footer file for HTML output"); - System.out.println("-od output directory"); - System.exit(1); - } - - /** - * Docgen constructor - * - * @param output Filename to setup for output - */ - public Docgen(String output) - throws FileNotFoundException { - } - - /** - * The main() driver for the policy documentation generator. - * @param argv Arguments, takes 1 filename parameter - */ - public static void main(String argv[]) { - if (argv.length == 0){ - printUsage(); - System.exit(1); - } - // hacked up version of getopt() - for (int x=0; x < argv.length; x++){ - if (argv[x].equals("-xf")){ - x++; - if (x - * - * Interface.java: The reference policy interfaces - * Version: @version@ - */ -package policy; - -import java.util.Map; -import java.util.TreeMap; - -/** - * Each reference policy interface is represented by this class. - * - * @see Layer - * @see Module - * @see Parameter - */ -public class Interface extends PolicyElement { - /** the children of this element */ - public final Map Children; - - public InterfaceType Type; - public int Weight; - - /** - * Default constructor assigns name to module. - * - * @param _name The name of the module. - * @param _Parent The reference to the parent element. - */ - public Interface(String _name, Module _Parent){ - super(_name, _Parent); - Children = new TreeMap(); - } -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/src/policy/InterfaceType.java b/refpolicy/doc/doctools/src/policy/InterfaceType.java deleted file mode 100644 index 0a102c5..0000000 --- a/refpolicy/doc/doctools/src/policy/InterfaceType.java +++ /dev/null @@ -1,12 +0,0 @@ -/* Copyright (C) 2005 Tresys Technology, LLC - * License: refer to COPYING file for license information. - * Authors: Spencer Shimko - * - * Interface.java: The reference policy interface types - * Version: @version@ - */ -package policy; - -public enum InterfaceType { - Read, Write, Both, None; -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/src/policy/Layer.java b/refpolicy/doc/doctools/src/policy/Layer.java deleted file mode 100644 index b232a38..0000000 --- a/refpolicy/doc/doctools/src/policy/Layer.java +++ /dev/null @@ -1,34 +0,0 @@ -/* Copyright (C) 2005 Tresys Technology, LLC - * License: refer to COPYING file for license information. - * Authors: Spencer Shimko - * - * Layer.java: The reference policy layers - * Version: @version@ - */ -package policy; - -import java.util.Map; -import java.util.TreeMap; - -/** - * Each reference policy layer is represented by this class. - * - * @see Module - * @see Interface - * @see Parameter - */ -public class Layer extends PolicyElement { - /** the children of this element */ - public final Map Children; - - /** - * Default constructor assigns name to layer. - * - * @param _name The name of the layer. - * @param _Parent The reference to the parent element. - */ - public Layer(String _name, Policy _Parent){ - super(_name, _Parent); - Children = new TreeMap(); - } -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/src/policy/Module.java b/refpolicy/doc/doctools/src/policy/Module.java deleted file mode 100644 index 3bb0c22..0000000 --- a/refpolicy/doc/doctools/src/policy/Module.java +++ /dev/null @@ -1,34 +0,0 @@ -/* Copyright (C) 2005 Tresys Technology, LLC - * License: refer to COPYING file for license information. - * Authors: Spencer Shimko - * - * Module.java: The reference policy module - * Version: @version@ - */ -package policy; - -import java.util.Map; -import java.util.TreeMap; - -/** - * Each reference policy layer is represented by this class. - * - * @see Layer - * @see Interface - * @see Parameter - */ -public class Module extends PolicyElement { - /** the children of this element */ - public final Map Children; - - /** - * Default constructor assigns name to module. - * - * @param _name The name of the module. - * @param _Parent The reference to the parent element. - */ - public Module(String _name, Layer _Parent){ - super(_name, _Parent); - Children = new TreeMap(); - } -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/src/policy/Parameter.java b/refpolicy/doc/doctools/src/policy/Parameter.java deleted file mode 100644 index 0f0ee45..0000000 --- a/refpolicy/doc/doctools/src/policy/Parameter.java +++ /dev/null @@ -1,28 +0,0 @@ -/* Copyright (C) 2005 Tresys Technology, LLC - * License: refer to COPYING file for license information. - * Authors: Spencer Shimko - * - * Parameter.java: The reference policy interface parameters - * Version: @version@ - */ -package policy; - -/** - * Each reference policy layer is represented by this class. - * - * @see Layer - * @see Module - * @see Interface - */ -public class Parameter extends PolicyElement{ - - /** - * Default constructor assigns name to parameter. - * - * @param _name The name of the parameter. - * @param _Parent The reference to the parent element. - */ - public Parameter(String _name, Interface _Parent){ - super(_name, _Parent); - } -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/src/policy/Policy.java b/refpolicy/doc/doctools/src/policy/Policy.java deleted file mode 100644 index e17ff1f..0000000 --- a/refpolicy/doc/doctools/src/policy/Policy.java +++ /dev/null @@ -1,35 +0,0 @@ -/* Copyright (C) 2005 Tresys Technology, LLC - * License: refer to COPYING file for license information. - * Authors: Spencer Shimko - * - * Policy.java: The reference policy api - * Version: @version@ - */ -package policy; - -import java.util.Map; -import java.util.TreeMap; - -/** - * Each reference policy layer is represented by this class. - * - * @see Module - * @see Interface - * @see Parameter - */ -public class Policy extends PolicyElement { - /** the children of this element */ - public final Map Children; - - /** - * Default constructor assigns name to layer. - * - * @param _name The name of the layer. - * @param _Parent The reference to the parent element. - */ - public Policy(String _name){ - // the policy is the root element so parent==null - super(_name, null); - Children = new TreeMap(); - } -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/src/policy/PolicyElement.java b/refpolicy/doc/doctools/src/policy/PolicyElement.java deleted file mode 100644 index f5fc913..0000000 --- a/refpolicy/doc/doctools/src/policy/PolicyElement.java +++ /dev/null @@ -1,114 +0,0 @@ -/* Copyright (C) 2005 Tresys Technology, LLC - * License: refer to COPYING file for license information. - * Authors: Spencer Shimko - * - * PolicyElement.java: The reference policy base class - * Version: @version@ - */ -package policy; - -import java.util.Map; -import java.util.TreeMap; - -/** - * Reference policy elements have certain similarties which - * should be inherited from a base class. This includes a name - * attribute that will be used for hashing, sorting, and converting - * to a string. - * - * @see Layer - * @see Module - * @see Interface - * @see Parameter - */ -public abstract class PolicyElement { - /** the string identifying the element */ - public final String Name; - /** the parent component */ - public final PolicyElement Parent; - - /** the attributes of this element */ - private final Map attributes; - - public String PCDATA; - - /** - * Default constructor assigns name. - * - * @param _name The name of the element. - * @param _Parent The reference to the parent element. - */ - public PolicyElement(String _name, PolicyElement _Parent){ - Name = _name; - Parent = _Parent; - attributes = new TreeMap(); - } - - /** - * Add attribute to policy element. - * - * @param aName String to identify attribute - * @param aString Value of attribute identified by string aName - * @return true when attribute added to element, - * false when attribute already defined for element - */ - public boolean AddAttribute(String aName, String aString){ - if (attributes.containsKey(aName)){ - return false; - } - attributes.put(aName,aString); - return true; - } - - /** - * Get attribute from policy element. - * - * @param aName String to identify attribute - * @return String value associated with named attribute - * or null if no attribute defined - * for aName. - */ - public String GetAttribute(String aName){ - return attributes.get(aName); - } - - /** - * Overridden equals method - * - * @param obj Object for comparison - */ - @Override public boolean equals(Object obj){ - return obj.toString().equals(this.Name); - } - - /** - * Return a hashcode for the element. Currently implemented as a - * call to the String hashCode() method. - * - * @return integer hashCode of this instance assuring two objects that - * are == will return same hashcode. - */ - @Override public int hashCode() { - return this.toString().hashCode(); - } - - /** - * Overridden toString() method. - * - * @return String representation of instance (it's name). - */ - @Override public String toString(){ - return Name; - } - - /** - * Since Component might be used as a key in some type of sort Compare - * is implemented. - * - * @return 0 if this==that, <0 if this0 if this>that - * @see String.compareTo - */ - public int compareTo(Layer that){ - return Name.compareTo(that.Name); - } -} \ No newline at end of file diff --git a/refpolicy/doc/doctools/style.css b/refpolicy/doc/doctools/style.css deleted file mode 100644 index 3805bf8..0000000 --- a/refpolicy/doc/doctools/style.css +++ /dev/null @@ -1,152 +0,0 @@ -body { - margin:0px; - padding:0px; - font-family:verdana, arial, helvetica, sans-serif; - color:#333; - background-color:white; - } -h1 { - margin:0px 0px 15px 0px; - padding:0px; - font-size:28px; - line-height:28px; - font-weight:900; - color:#ccc; - } -h2 { - font-size:100%; - } -h3 { - font-size:75%; - } -h4 { - font-size:67%; - } -li { - font:11px/20px verdana, arial, helvetica, sans-serif; - margin:0px 0px 0px 0px; - padding:0px; - } -p { - /* normal */ - font:11px/20px verdana, arial, helvetica, sans-serif; - margin:0px 0px 16px 0px; - padding:0px; - } - -tt { - /* inline code */ - font-family: monospace; - } - -table { - background-color:#eee; - border:1px dashed #999; - /*background-color: white;*/ - color: black; - text-align: left; - font:11px/20px verdana, arial, helvetica, sans-serif; - margin-left: 10%; - margin-right: 10%; -} - -th { - background-color: #ccccff; - text-align: center; -} - -td.header { - font-weight: bold; -} - -#Content>p {margin:0px;} -#Content>p+p {text-indent:30px;} -a { - color:#09c; - font-size:11px; - text-decoration:none; - font-weight:600; - font-family:verdana, arial, helvetica, sans-serif; - } -a:link {color:#09c;} -a:visited {color:#07a;} -a:hover {background-color:#eee;} - -#Codeblock { - margin:5px 50px 5px 50px; - padding:5px 0px 5px 15px; - border-style:solid; - border-color:black; - border-width:1px 1px 1px 1px; - background-color:#f8f8f8; - font-size:11px; - font-weight:600; - text-decoration:none; - font-family:courier; -} -pre { - font-size:11px; - font-weight:600; - text-decoration:none; - font-family:courier; -} -pre.codeblock { - /* code block (bordered, slight gray background) */ - border-style:solid; - border-color:black; - border-width:1px 1px 1px 1px; - background-color:#f8f8f8; - margin-left: 10%; - margin-right: 10%; -} -dl { - /* definition text block */ - font:11px/20px verdana, arial, helvetica, sans-serif; - margin:0px 0px 16px 0px; - padding:0px; - } -dt { - /* definition term */ - font-weight: bold; - } - -#Header { - margin:50px 0px 10px 0px; - padding:17px 0px 0px 20px; - /* For IE5/Win's benefit height = [correct height] + [top padding] + [top and bottom border widths] */ - height:33px; /* 14px + 17px + 2px = 33px */ - border-style:solid; - border-color:black; - border-width:1px 0px; /* top and bottom borders: 1px; left and right borders: 0px */ - line-height:11px; - font-size:110%; - background-color:#eee; - voice-family: "\"}\""; - voice-family:inherit; - height:14px; /* the correct height */ - } -body>#Header {height:14px;} -#Content { - margin:0px 50px 50px 200px; - padding:10px; - } - -#Menu { - position:absolute; - top:100px; - left:20px; - width:162px; - padding:10px; - background-color:#eee; - border:1px dashed #999; - line-height:17px; - text-align:left; - voice-family: "\"}\""; - voice-family:inherit; - width:160px; - } -#Menu subitem { - font-size: 5px; -} - -body>#Menu {width:160px;}

Interface
Name	" + iface.Name + "
Flow Type	" + iface.Type.toString() + "
Flow Weight	" + iface.Weight + "
Name	" + iface.Name + "
Flow Type	" + iface.Type.toString() + "
Description	" + iface.PCDATA + "

Welcome to the reference policy API!

Layer: " + layer.Name + "

Module: "+ module.Name + "\n"); - out.append("\tSummary: " + module.PCDATA + "

Module: "+ module.Name + "
\n"); - out.append("\tSummary: " + module.PCDATA + "