KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sslexplorer > properties > PropertyProfile


1 /*
2  * SSL-Explorer
3  *
4  * Copyright (C) 2003-2006 3SP LTD. All Rights Reserved
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2 of
9  * the License, or (at your option) any later version.
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19             
20 package com.sslexplorer.properties;
21
22 import com.sslexplorer.policyframework.OwnedResource;
23
24 /**
25  *
26  * All property values are held in a profile. Profiles provide a way of of the
27  * user selecting a set of property values depending on the environment they are
28  * in. For example, there may be a profile configured whose properties are
29  * appropriate for using when a user is connecting via the Office Lan. The
30  * administrator may also have configured a second profile who property values
31  * are more appropriate when users are connecting from somewhere less secure,
32  * such as an Internet Cafe.
33  * <p>
34  * There are two types of profile, <b>Global</b>, and <b>Personal</b>. Global
35  * profiles are created by an administrator and then assigned to users via
36  * policies. Many users may share the same profile. Personal profiles are
37  * created by users themselves and are only usable by them.
38  * <p>
39  * Only property definitions that have a visibility of
40  * {@link com.sslexplorer.boot.PropertyDefinition#PROFILE} may exist in global
41  * or personal profiles.
42  * <p>
43  * There also exists a special <b>Default</b> global profile. This profile has
44  * an id of 0 and is also used store to the default global profile <strong>and</strong>
45  * system configuration <strong>and</strong> hidden properties.
46  * <p>
47  * A Property Profiles is consider a type of
48  * {@link com.sslexplorer.policyframework.Resource} so is subject ot all
49  * the rules imposed on by the <i>Policy Framework</i>. In fact it is a
50  * specialised type of resource known as a
51  * {@link com.sslexplorer.policyframework.OwnedResource}. *
52  *
53  * @author Brett Smith <a HREF="mailto: brett@3sp.com">&lt;brett@3sp.com&gt;</a>
54  */
55 public interface PropertyProfile extends OwnedResource {
56
57     /**
58      * Get the label. This will be whats show to the user when selecting a
59      * profile.
60      *
61      * @return label
62      */
63     public String JavaDoc getLabel();
64 }
Popular Tags