org.jboss.as.domain.management.security

Class PropertiesFileLoader

java.lang.Object

org.jboss.as.domain.management.security.PropertiesFileLoader

Direct Known Subclasses:

PropertiesSubjectSupplemental, UserPropertiesFileLoader

public class PropertiesFileLoader
extends Object

The base class for services depending on loading a properties file, loads the properties on start up and re-loads as required where updates to the file are detected.

Author:

Darran Lofthouse

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMMENT_PREFIX
static String	DISABLE_SUFFIX_KEY
protected File	propertiesFile
static Pattern	PROPERTY_PATTERN Pattern that matches : #key=value key=value value must be any character except "=" and key must be any character except "#". group(1) returns the key of the property. group(2) returns the value of the property.

Constructor Summary

Constructors

Constructor and Description
PropertiesFileLoader(String path, String relativeTo)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLineContent(BufferedReader bufferedFileReader, List<String> content, String line) Add the line to the content
protected void	beginPersistence() Method called to indicate the start of persisting the properties.
protected void	endPersistence(BufferedWriter writer) Method called to indicate persisting the properties file is now complete.
static String	escapeString(String name, char[] escapeArray)
org.jboss.msc.inject.Injector<PathManager>	getPathManagerInjectorInjector()
Properties	getProperties()
protected void	load()
protected void	loadAsRequired()
void	persistProperties() Saves changes in properties file.
protected List<String>	readFile(File file)
protected void	safeClose(Closeable c)
void	start(org.jboss.msc.service.StartContext context)
void	stop(org.jboss.msc.service.StopContext context)
protected void	verifyProperties(Properties properties) Provides the base class with an opportunity to verify the contents of the properties before they are used.
protected void	write(BufferedWriter writer, String line, boolean newLine)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMENT_PREFIX

protected static final String COMMENT_PREFIX

See Also:

Constant Field Values

PROPERTY_PATTERN

public static final Pattern PROPERTY_PATTERN

Pattern that matches :

• #key=value
• key=value

value must be any character except "=" and key must be any character except "#".
group(1) returns the key of the property.
group(2) returns the value of the property.

DISABLE_SUFFIX_KEY

public static final String DISABLE_SUFFIX_KEY

See Also:

Constant Field Values

propertiesFile

protected File propertiesFile

Constructor Detail

PropertiesFileLoader

public PropertiesFileLoader(String path,
                    String relativeTo)

Method Detail

getPathManagerInjectorInjector

public org.jboss.msc.inject.Injector<PathManager> getPathManagerInjectorInjector()

start

public void start(org.jboss.msc.service.StartContext context)
           throws org.jboss.msc.service.StartException

Throws:

org.jboss.msc.service.StartException

stop

public void stop(org.jboss.msc.service.StopContext context)

getProperties

public Properties getProperties()
                         throws IOException

Throws:

IOException

loadAsRequired

protected void loadAsRequired()
                       throws IOException

Throws:

IOException

load

protected void load()
             throws IOException

Throws:

IOException

persistProperties

public void persistProperties()
                       throws IOException

Saves changes in properties file. It reads the property file into memory, modifies it and saves it back to the file.

Throws:

IOException

readFile

protected List<String> readFile(File file)
                         throws IOException

Throws:

IOException

addLineContent

protected void addLineContent(BufferedReader bufferedFileReader,
                  List<String> content,
                  String line)
                       throws IOException

Add the line to the content

Parameters:

bufferedFileReader - The file reader

content - The content of the file

line - The current read line

Throws:

IOException

beginPersistence

protected void beginPersistence()
                         throws IOException

Method called to indicate the start of persisting the properties.

Throws:

IOException

write

protected void write(BufferedWriter writer,
         String line,
         boolean newLine)
              throws IOException

Throws:

IOException

endPersistence

protected void endPersistence(BufferedWriter writer)
                       throws IOException

Method called to indicate persisting the properties file is now complete.

Throws:

IOException

escapeString

public static String escapeString(String name,
                  char[] escapeArray)

safeClose

protected void safeClose(Closeable c)

verifyProperties

protected void verifyProperties(Properties properties)
                         throws IOException

Provides the base class with an opportunity to verify the contents of the properties before they are used.

Parameters:

properties - - The Properties instance to verify.

Throws:

IOException