| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Config</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Config"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/google/enterprise/adaptor/CommandStreamParser.html" title="class in com.google.enterprise.adaptor"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../com/google/enterprise/adaptor/CustomFormatter.html" title="class in com.google.enterprise.adaptor"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/google/enterprise/adaptor/Config.html" target="_top">FRAMES</a></li> |
| <li><a href="Config.html" target="_top">NO FRAMES</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>SUMMARY: </li> |
| <li>NESTED | </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_summary">CONSTR</a> | </li> |
| <li><a href="#method_summary">METHOD</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>DETAIL: </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_detail">CONSTR</a> | </li> |
| <li><a href="#method_detail">METHOD</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <p class="subTitle">com.google.enterprise.adaptor</p> |
| <h2 title="Class Config" class="title">Class Config</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.google.enterprise.adaptor.Config</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <strong>Config</strong> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Configuration values for this program, like the GSA's hostname. Also several |
| knobs, or controls, for changing the behavior of the program. |
| <p>All available configuration:<br> |
| <style type="text/css"> td { padding-right:2em; } </style> |
| <table> |
| <tr><td align=center><b>required?</b></td> |
| <td><b>name</b></td><td><b>meaning</b></td> |
| <tr><td> </td><td>gsa.acceptsDocControlsHeader </td><td>use |
| X-Gsa-Doc-Controls HTTP header with namespaced ACLs. |
| Otherwise ACLs are sent without namespace and as metadata. |
| If not set, then an attempt to compute from gsa.version is made. |
| Defaults to true for 7.2.0-0 and later, and false for earlier, |
| as defined by gsa.version. |
| <tr><td> </td><td>adaptor.markAllDocsAsPublic </td><td> Tells GSA all |
| documents are public. Overrides all ACLs and even the setting of |
| <code>Response.setSecure()</code>. Defaults to false |
| <tr><td> </td><td>adaptor.fullListingSchedule </td><td> when to invoke |
| <a href="../../../../com/google/enterprise/adaptor/Adaptor.html#getDocIds(com.google.enterprise.adaptor.DocIdPusher)"><code>Adaptor.getDocIds</code></a>, in cron format (minute, |
| hour, day of month, month, day of week). Defaults to 0 3 * * * |
| <tr><td> </td><td>adaptor.incrementalPollPeriodSecs </td><td> number |
| of seconds between invocations of <a href="../../../../com/google/enterprise/adaptor/PollingIncrementalLister.html#getModifiedDocIds(com.google.enterprise.adaptor.DocIdPusher)"><code>PollingIncrementalLister.getModifiedDocIds</code></a>. Defaults to 900 |
| <tr><td> </td><td>adaptor.docContentTimeoutSecs </td><td> number of seconds |
| adaptor has to complete sending content before it is interrupted. Timing |
| starts when sending content starts. Defaults to 180 |
| <tr><td> </td><td>adaptor.docHeaderTimeoutSecs </td><td> number of seconds |
| adaptor has to start sending content before it is interrupted. |
| Defaults to 30 |
| <tr><td> </td><td>adaptor.pushDocIdsOnStartup </td><td> whether to invoke |
| <a href="../../../../com/google/enterprise/adaptor/Adaptor.html#getDocIds(com.google.enterprise.adaptor.DocIdPusher)"><code>Adaptor.getDocIds</code></a> on process start |
| (in addition to adaptor.fullListingSchedule). Defaults to true |
| <tr><td> </td><td>docId.isUrl </td><td> say your adaptor's document ids |
| are already URLs and avoid them being inserted into adaptor |
| generated URLs. Defaults to false |
| <tr><td> </td><td>feed.crawlImmediatelyBitEnabled </td><td> send bit telling |
| GSA to crawl immediately. Defaults to false |
| <tr><td> </td><td>feed.maxUrls </td><td> set max number of URLs included |
| per feed file. Defaults to 5000 |
| <tr><td> </td><td>feed.name </td><td> source name used in feeds. Generated |
| if not provided |
| <tr><td> </td><td>feed.noRecrawlBitEnabled </td><td> send bit telling |
| GSA to crawl your documents only once. Defaults to false |
| <tr><td> </td><td>feed.archiveDirectory </td><td> specifies a directory in |
| which all feeds sent to the GSA will be archived. Feeds that failed to |
| be sent to the GSA will be tagged with "FAILED" in the file name. |
| If no directory is specified, feed files will not be saved. |
| <tr><td> </td><td>gsa.version </td><td> version number used to configure |
| expected GSA features. Defaults to acquiring from GSA. |
| Uses 7.0.14-114 if acquiring fails. |
| <tr><td> </td><td>gsa.614FeedWorkaroundEnabled </td><td> enable detour |
| around particular feed parsing failure found in GSA version 6.14 . |
| Defaults to false |
| <tr><td> </td><td>gsa.70AuthMethodWorkaroundEnabled </td><td> send authmethod |
| in feed files to workaround early GSA 7.0 bug. Defaults to false |
| <tr><td> </td><td>gsa.characterEncoding </td><td> character set used |
| in feed files. Defaults to UTF-8 |
| <tr><td align="center"> yes </td><td>gsa.hostname </td><td> machine to |
| send feed files to. Process errors if not provided |
| <tr><td> </td><td>gsa.admin.hostname </td><td> administrative host for |
| the GSA. This may be different from gsa.hostname if the GSA's dedicated |
| administrative network interface is enabled. Defaults to the same |
| value as gsa.hostname. |
| <tr><td> </td><td>gsa.samlEntityId </td><td> The SAML Entity ID that |
| identifies the GSA. Defaults to |
| http://google.com/enterprise/gsa/security-manager |
| <tr><td> </td><td>journal.reducedMem </td><td> avoid tracking per URL |
| information in RAM; suggested with over five hundred thousand documents. |
| Defaults to true |
| <tr><td> </td><td>gsa.scoringType</td><td> type of relevance algorithm |
| GSA utilizes to rank documents. Either content or web. Is sent |
| when gsa.acceptsDocControlsHeader is true. Defaults to content |
| <tr><td> </td><td>server.dashboardPort </td><td> port on adaptor's |
| machine for accessing adaptor's dashboard. Defaults to 5679 |
| <tr><td> </td><td>server.docIdPath </td><td> part of URL preceding |
| encoded document ids. Defaults to /doc/ |
| <tr><td> </td><td>server.fullAccessHosts </td><td> hosts allowed access |
| without authentication |
| (certificates still needed when in secure mode). Defaults to |
| empty but implicitly contains gsa.hostname |
| <tr><td> </td><td>server.hostname </td><td> |
| hostname of adaptor machine for URL generation. |
| The GSA will use this hostname to crawl the adaptor. |
| Defaults to lowercase of automatically detected hostname |
| <tr><td> </td><td>server.keyAlias </td><td> keystore alias where |
| encryption (public and private) keys are stored. |
| Defaults to adaptor |
| <tr><td> </td><td>server.maxWorkerThreads </td><td> number of maximum |
| simultenous retrievals allowed. Defaults to 16 |
| <tr><td> </td><td>server.port </td><td> retriever port. Defaults to 5678 |
| <tr><td> </td><td>server.queueCapacity </td><td> max retriever queue size. |
| Defaults to 160 |
| <tr><td> </td><td>server.reverseProxyPort </td><td> port used in |
| retriever URLs (in case requests |
| are routed through a reverse proxy). Defaults to server.port |
| <tr><td> </td><td>server.reverseProxyProtocol </td><td> either http or https, |
| depending on proxy traffic. Defaults to https in secure |
| mode and http otherwise |
| <tr><td> </td><td>server.samlEntityId </td><td> The SAML Entity ID that the |
| Adaptor will use to identity itself. Defaults to |
| http://google.com/enterprise/gsa/adaptor |
| <tr><td> </td><td>server.secure </td><td> enables https and certificate |
| checking. Defaults to false |
| <tr><td> </td><td>server.useCompression </td><td> compress retrieval |
| responses. Defaults to true |
| <tr><td> </td><td>transform.acl.X </td><td> where X is an integer, match |
| and modify principals as described. Defaults no modifications |
| <tr><td> </td><td>transform.pipeline </td><td> sequence of |
| transformation steps. Defaults to no-pipeline |
| <tr><td> </td><td>saml.idpExpirationMillis </td><td> Expiration time |
| sent in SAML Authentication response. Defaults to 30,000 milliseconds. |
| </table></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#Config()">Config</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#addKey(java.lang.String, java.lang.String)">addKey</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code> |
| <div class="block">Add configuration key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#ensureLatestConfigLoaded()">ensureLatestConfigLoaded</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#getAllKeys()">getAllKeys</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#getListOfConfigs(java.lang.String)">getListOfConfigs</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Returns a list of maps corresponding to each item of the comma-separated |
| value of <code>key</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#getRawValue(java.lang.String)">getRawValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Get a configuration value exactly as provided in configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#getValue(java.lang.String)">getValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Get a configuration value as computed based on the configuration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#getValuesWithPrefix(java.lang.String)">getValuesWithPrefix</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</code> |
| <div class="block">Gets all configuration values that begin with <code>prefix</code>, returning |
| them as a map with the keys having <code>prefix</code> removed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#load(java.io.File)">load</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> configFile)</code> |
| <div class="block">Load user-provided configuration file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#load(java.lang.String)">load</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> configFile)</code> |
| <div class="block">Load user-provided configuration file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#overrideKey(java.lang.String, java.lang.String)">overrideKey</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code> |
| <div class="block">Change the default value of a preexisting configuration key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Config.html#validate()">validate</a></strong>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Config()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Config</h4> |
| <pre>public Config()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAllKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllKeys</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getAllKeys()</pre> |
| </li> |
| </ul> |
| <a name="getListOfConfigs(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListOfConfigs</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> getListOfConfigs(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Returns a list of maps corresponding to each item of the comma-separated |
| value of <code>key</code>. Each map is the configuration entries for that item |
| in the list. The 'name' configuration entry is added in each map based on |
| the name provided by the user. |
| |
| <p>As an example, provided the following config: |
| <pre><code>adaptor.servers=server1,fluttershy , rainbowDash |
| adaptor.servers.fluttershy.hostname=fluttershy |
| adaptor.servers.fluttershy.port=42 |
| adaptor.servers.server1.hostname=applejack |
| adaptor.servers.server1.port=314 |
| adaptor.servers.rainbowDash.hostname=rainbowdash |
| adaptor.servers.rainbowDash.port=159 |
| adaptor.servers.rainbowDash.name=20% cooler |
| adaptor.servers.derpy.hostname=hooves</code></pre> |
| |
| <p>And calling: |
| <pre><code>config.getConfigList("adaptor.servers");</code></pre> |
| |
| <p>Returns: |
| <pre><code>[{ |
| "hostname": "applejack", |
| "port": "42", |
| "name": "server1", |
| }, { |
| "hostname": "fluttershy", |
| "port": "314", |
| "name": "fluttershy", |
| }, { |
| "hostname": "rainbowdash", |
| "port": "159", |
| "name": "raindowDash", |
| }]</code></pre></div> |
| </li> |
| </ul> |
| <a name="load(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public void load(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> configFile) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Load user-provided configuration file.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="load(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public void load(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> configFile) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Load user-provided configuration file.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="ensureLatestConfigLoaded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ensureLatestConfigLoaded</h4> |
| <pre>public boolean ensureLatestConfigLoaded() |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if configuration file was modified.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="validate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>public void validate()</pre> |
| </li> |
| </ul> |
| <a name="getRawValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRawValue</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRawValue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Get a configuration value exactly as provided in configuration. Generally, |
| <a href="../../../../com/google/enterprise/adaptor/Config.html#getValue(java.lang.String)"><code>getValue(java.lang.String)</code></a> should be used instead of this method.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>raw non-<code>null</code> value of <code>key</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if <code>key</code> has no value</dd></dl> |
| </li> |
| </ul> |
| <a name="getValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getValue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Get a configuration value as computed based on the configuration. Some |
| configuration values can be generated from other values. This method |
| returns that computed configuration value instead of the raw value provided |
| in configuration. This method should be preferred over <a href="../../../../com/google/enterprise/adaptor/Config.html#getRawValue(java.lang.String)"><code>getRawValue(java.lang.String)</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>non-<code>null</code> value of <code>key</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if <code>key</code> has no value</dd></dl> |
| </li> |
| </ul> |
| <a name="getValuesWithPrefix(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValuesWithPrefix</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getValuesWithPrefix(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</pre> |
| <div class="block">Gets all configuration values that begin with <code>prefix</code>, returning |
| them as a map with the keys having <code>prefix</code> removed.</div> |
| </li> |
| </ul> |
| <a name="addKey(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addKey</h4> |
| <pre>public void addKey(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre> |
| <div class="block">Add configuration key. If <code>defaultValue</code> is <code>null</code>, then no |
| default value is used and the user must provide one.</div> |
| </li> |
| </ul> |
| <a name="overrideKey(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>overrideKey</h4> |
| <pre>public void overrideKey(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre> |
| <div class="block">Change the default value of a preexisting configuration key. If <code>defaultValue</code> is <code>null</code>, then no default is used and the user must |
| provide one.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/google/enterprise/adaptor/CommandStreamParser.html" title="class in com.google.enterprise.adaptor"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../com/google/enterprise/adaptor/CustomFormatter.html" title="class in com.google.enterprise.adaptor"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/google/enterprise/adaptor/Config.html" target="_top">FRAMES</a></li> |
| <li><a href="Config.html" target="_top">NO FRAMES</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>SUMMARY: </li> |
| <li>NESTED | </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_summary">CONSTR</a> | </li> |
| <li><a href="#method_summary">METHOD</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>DETAIL: </li> |
| <li>FIELD | </li> |
| <li><a href="#constructor_detail">CONSTR</a> | </li> |
| <li><a href="#method_detail">METHOD</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
