-
Notifications
You must be signed in to change notification settings - Fork 33
/
UserProperties.java
182 lines (158 loc) · 5.94 KB
/
UserProperties.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/*
* Copyright (c) 2000, 2017 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.messaging.jmq.admin.util;
import java.io.*;
import java.util.Properties;
import com.sun.messaging.jmq.admin.resources.AdminResources;
/**
* This class can be used to save user property files. This class can be subclassed for use in any application requiring
* loading/saving of user preferences.
*
* <P>
* It has a default directory location of:
*
* <PRE>
* <value of user.home property>/.imq/admin
* </PRE>
*
* and a default file name of "admin.properties".
*
* <P>
* The name of the property file and directory can be configured.
*
* <P>
* If the property file does not exist when a save is attempted, it will be created (including the directory hierarchy).
*/
public class UserProperties extends Properties {
private static AdminResources ar = Globals.getAdminResources();
private static final String JMQPREFSROOT = ".imq";
private static final String JMQADMINROOT = "admin";
private String fileName, dirName;
/**
* Instantiate a UserProperties object.
*/
public UserProperties() {
String userHome = System.getProperty("user.home");
fileName = "admin.properties";
dirName = userHome + File.separator + JMQPREFSROOT + File.separator + JMQADMINROOT;
}
/**
* Set save file name. The default for this is "admin.properties"
*
* @param fileName The filename to use when saving this property object.
*/
public void setFileName(String fileName) {
this.fileName = fileName;
}
/**
* Get absolute save file name.
*
* @return fileName The absolute path to the file used when saving this property object.
*/
public String getAbsoluteFileName() {
String absFileName = dirName + File.separator + fileName;
return (absFileName);
}
/**
* Set save directory name. The default for this is:
*
* <PRE>
* <value of user.home property>/.imq/admin
* </PRE>
*
* @param dirName The directory name to use when saving this property object.
*/
public void setDirName(String dirName) {
this.dirName = dirName;
}
/**
* Loads properties from file.
* <P>
* This method will load the properties from the file specified via setFileName() or the default if none was specified.
* The directory used here is the one specified by setDirName() or a default if none was specified.
*
* @throws SecurityException
*/
public void load() throws UserPropertiesException {
String absFileName = dirName + File.separator + fileName;
File propFile;
propFile = new File(absFileName);
if (!propFile.exists()) {
/*
* UserPropertiesException upe; errStr = "Property file:\n" + propFile.getAbsolutePath() + "\n" + "does not exist.";
*
* upe = new UserPropertiesException(errStr); throw (upe);
*/
return;
}
if (!propFile.canRead()) {
UserPropertiesException upe;
upe = new UserPropertiesException(ar.getString(ar.E_PROPFILE_NOT_READABLE, propFile.getAbsolutePath()));
throw (upe);
}
loadFile(propFile);
}
private void loadFile(File propFile) throws UserPropertiesException {
try (FileInputStream fis = new FileInputStream(propFile)) {
load(fis);
} catch (Exception ex) {
UserPropertiesException upe;
upe = new UserPropertiesException(ar.getString(ar.E_FAILED_TO_OPEN_PROPFILE, propFile.getAbsolutePath(), ex.toString()));
throw (upe);
}
}
/**
* Saves properties to file.
* <P>
* This method will save the properties to the file specified via setFileName() or the default if none was specified.
* The directory used here is the one specified by setDirName() or a default if none was specified.
*
* @throws SecurityException
*/
public void save() throws UserPropertiesException {
String absFileName = dirName + File.separator + fileName;
File propDir, propFile;
propDir = new File(dirName);
propFile = new File(absFileName);
if (propFile.exists()) {
if (!propFile.canWrite()) {
UserPropertiesException upe;
upe = new UserPropertiesException(ar.getString(ar.E_PROPFILE_NOT_WRITEABLE, propFile.getAbsolutePath()));
throw (upe);
}
} else {
if (propDir.exists()) {
if (!propDir.canWrite()) {
UserPropertiesException upe;
upe = new UserPropertiesException(ar.getString(ar.E_CANNOT_CREATE_PROPFILE, propFile.getAbsolutePath()));
throw (upe);
}
} else {
propDir.mkdirs();
}
}
try {
try (FileOutputStream fos = new FileOutputStream(propFile)) {
store(fos, null);
}
} catch (IOException ioe) {
UserPropertiesException upe;
upe = new UserPropertiesException(ar.getString(ar.E_FAILED_TO_WRITE_PROPFILE, propFile.getAbsolutePath(), ioe.toString()));
throw (upe);
}
}
}