Google Git
Sign in
apache / juddi / refs/heads/asf-site / . / juddi-client / xref / org / apache / juddi / v3 / client / config / WebHelper.html
blob: 32b967b6265ac14ccd39a02c244c043c791dec01 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>WebHelper xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/juddi/v3/client/config/WebHelper.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Copyright 2001-2011 The Apache Software Foundation.</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.juddi.v3.client.config;
<a class="jxr_linenumber" name="L18" href="#L18">18</a>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.ConfigurationException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * @author kstam</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/juddi/v3/client/config/WebHelper.html">WebHelper</a> {
<a class="jxr_linenumber" name="L30" href="#L30">30</a>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log logger = LogFactory.getLog(WebHelper.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String UDDI_CLIENT_NAME = <span class="jxr_string">"uddi.client.name"</span>;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String UDDI_CLIENT_CONFIG_FILE = <span class="jxr_string">"uddi.client.config.file"</span>;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String JUDDI_CLIENT_NAME = <span class="jxr_string">"juddi.client.name"</span>;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String JUDDI_CLIENT_TRANSPORT = <span class="jxr_string">"juddi.client.transport"</span>;
<a class="jxr_linenumber" name="L36" href="#L36">36</a>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Checks the servlet context for the manager defined in the web</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * context. Optionally, in your web.xml you can specify either the</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * manager name if you want to use an existing manager called</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * 'uddi-portlet-manager':</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * &amp;lt;context-param&amp;gt;</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * &amp;lt;param-name&amp;gt;uddi.client.manager.name&amp;lt;/param-name&amp;gt;</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * &amp;lt;param-value&amp;gt;uddi-portlet-manager&amp;lt;/param-value&amp;gt;</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * &amp;lt;/context-param&amp;gt;</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt; or, if you don't want to use the default META-INF/uddi.xml</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * file path, but 'META-INF/my-uddi.xml' instead, then you can set:</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * &amp;lt;context-param&amp;gt;</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * &amp;lt;param-name&amp;gt;uddi.client.config.path&amp;lt;/param-name&amp;gt;</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * &amp;lt;param-value&amp;gt;META-INF/my-uddi.xml&amp;lt;/param-value&amp;gt;</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * &amp;lt;/context-param&amp;gt;</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @param servletContext</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @return a UDDI Client instance</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @throws ConfigurationException</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html">UDDIClient</a> getUDDIClient(ServletContext servletContext) <strong class="jxr_keyword">throws</strong> ConfigurationException {
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (servletContext.getAttribute(JUDDI_CLIENT_NAME) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> String clientName = String.valueOf(servletContext.getAttribute(JUDDI_CLIENT_NAME));
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">return</strong> UDDIClientContainer.getUDDIClient(clientName);
<a class="jxr_linenumber" name="L64" href="#L64">64</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L65" href="#L65">65</a> String clientName = servletContext.getInitParameter(UDDI_CLIENT_NAME);
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (clientName != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html">UDDIClient</a> client = UDDIClientContainer.getUDDIClient(clientName);
<a class="jxr_linenumber" name="L69" href="#L69">69</a> logger.info(<span class="jxr_string">"Client "</span> + clientName + <span class="jxr_string">" was already started."</span>);
<a class="jxr_linenumber" name="L70" href="#L70">70</a> servletContext.setAttribute(JUDDI_CLIENT_NAME, clientName);
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">return</strong> client;
<a class="jxr_linenumber" name="L72" href="#L72">72</a> } <strong class="jxr_keyword">catch</strong> (ConfigurationException ce) {
<a class="jxr_linenumber" name="L73" href="#L73">73</a> logger.debug(<span class="jxr_string">"Client "</span> + clientName + <span class="jxr_string">" is not yet started."</span>);
<a class="jxr_linenumber" name="L74" href="#L74">74</a> }
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
<a class="jxr_linenumber" name="L76" href="#L76">76</a> String clientConfigFile = servletContext.getInitParameter(UDDI_CLIENT_CONFIG_FILE);
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (clientConfigFile == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> clientConfigFile = ClientConfig.DEFAULT_UDDI_CONFIG;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> logger.info(<span class="jxr_string">"Reading the clientName from the clientConfig file "</span> + clientConfigFile);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html">UDDIClient</a> client = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html">UDDIClient</a>(clientConfigFile);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (client.getName() == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> logger.warn(<span class="jxr_string">"Deprecated, client name set to 'default', however it should be provided in the uddi.xml"</span>);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> clientName = <span class="jxr_string">"default"</span>;
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> (client.getName() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L89" href="#L89">89</a> logger.info(<span class="jxr_string">"Starting Client "</span> + client.getName() + <span class="jxr_string">"..."</span>);
<a class="jxr_linenumber" name="L90" href="#L90">90</a> clientName = client.getName();
<a class="jxr_linenumber" name="L91" href="#L91">91</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ConfigurationException(<span class="jxr_string">"A client name needs to be specified in the client config file."</span>);
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
<a class="jxr_linenumber" name="L94" href="#L94">94</a>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> client.start();
<a class="jxr_linenumber" name="L96" href="#L96">96</a> servletContext.setAttribute(JUDDI_CLIENT_NAME, clientName);
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> client;
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>