KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opensymphony > user > provider > file > XMLProfileProvider


1 /*
2  * Copyright (c) 2002-2003 by OpenSymphony
3  * All rights reserved.
4  */
5 package com.opensymphony.user.provider.file;
6
7 import java.util.Properties JavaDoc;
8
9
10 /**
11 * Following properties are <b>required</b>:
12 * <ul>
13 * <li><b>storeFile</b> - the absolute path to the store file (<i>ex: c:\groups.xml</i>) or a resource location in the jar (<i>ex: /groups.xml</i>) </li>
14 * <li><b>storeFileType</b> - one of (file, resource)
15 * </ul>
16 *
17 * XML format example:
18 * <pre>
19 * &lt;users&gt;
20 * &lt;user id="jdoe"&gt;
21 * &lt;property-set&gt;
22 * &lt;property key="fullName" type="String"&gt;John Doe&lt;property/&gt;
23 * &lt;property key="email" type="String"&gt;john.doe@myplace.net&lt;property/&gt;
24 * &lt;/property-set&gt;
25 * &lt;/user&gt;
26 * &lt;user id="myUser"&gt;
27 * &lt;property-set&gt;
28 * &lt;property key="abc" type="String"&gt;def&lt;property/&gt;
29 * &lt;/property-set&gt;
30 * &lt;/user&gt;
31 * &lt;user id="foo"/&gt;
32 * &lt;/users&gt;
33 * </pre>
34 *
35 * @author Dave Brondsema
36 *
37 */
38 public class XMLProfileProvider extends FileProfileProvider {
39     //~ Methods ////////////////////////////////////////////////////////////////
40
41     public boolean init(Properties JavaDoc properties) {
42         boolean retVal = super.init(properties);
43
44         if (retVal) {
45             propertySetCache = new XMLPropertySetCache(properties.getProperty("storeFile"), properties.getProperty("storeFileType"));
46
47             return true;
48         }
49
50         return false;
51     }
52 }
53
Popular Tags