01: /*
02: * JOSSO: Java Open Single Sign-On
03: *
04: * Copyright 2004-2008, Atricore, Inc.
05: *
06: * This is free software; you can redistribute it and/or modify it
07: * under the terms of the GNU Lesser General Public License as
08: * published by the Free Software Foundation; either version 2.1 of
09: * the License, or (at your option) any later version.
10: *
11: * This software is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this software; if not, write to the Free
18: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
20: */
21: package org.josso.util.config;
22:
23: import java.io.File;
24:
25: /**
26: * Represents a ConfigurationHandler context. Provides information related to specific configurations like file.
27: *
28: * @author <a href="mailto:sgonzalez@josso.org">Sebastian Gonzalez Oyuela</a>
29: * @version $Id: ConfigurationContext.java 508 2008-02-18 13:32:29Z sgonzalez $
30: */
31:
32: public interface ConfigurationContext {
33:
34: /**
35: * System property that allows JOSSO to update configuration files when values are dinamically changed, probably using JMX.
36: */
37: public static final String SYS_PROP_CONFIGURATION_UPDATABLE = "josso.config.update";
38:
39: /**
40: * System property that tells JOSSO to backup configuration files before modifying them.
41: */
42: public static final String SYS_PROP_CONFIGURATION_BACKUP = "josso.config.backup";
43:
44: /**
45: * @return boolean if the associated configuration can be udpated.
46: */
47: boolean isConfigurationUpdatable();
48:
49: /**
50: * The file descriptor representing the associated configuration.
51: */
52: File getConfigurationFile();
53:
54: /**
55: * @return true if configuration backup is enable.
56: */
57: boolean isBackupEnabled();
58:
59: }
|