org.alfresco.jlan.server.config

Class ServerConfiguration

java.lang.Object

org.alfresco.jlan.server.config.ServerConfiguration

All Implemented Interfaces:

ServerConfigurationAccessor

Direct Known Subclasses:

CifsOnlyXMLServerConfiguration

public class ServerConfiguration
extends Object
implements ServerConfigurationAccessor

Server Configuration Class

Provides the configuration parameters for the network file servers (SMB/CIFS, FTP and NFS).

Author:

gkspencer

Constructor Summary

Constructors

Constructor and Description
ServerConfiguration(String name) Construct a server configuration object

Method Summary

Modifier and Type	Method and Description
void	addConfigSection(ConfigSection config) Add a configuration section
void	addListener(ConfigurationListener listener) Add a configuration change listener
void	addServer(NetworkServer srv) Add a server to the list of active servers
void	closeConfiguration() Close the configuration
NetworkServer	findServer(String proto) Find an active server using the protocol name
protected int	fireConfigurationChange(int id, Object newVal) Notify all registered configuration change listeners of a configuration change
ConfigSection	getConfigSection(String name) Return the required configuration section
Platform.Type	getPlatformType() Return the platform type
String	getPlatformTypeString() Return the platform type as a string
NetworkServer	getServer(int idx) Return the server at the specified index
String	getServerName() Return the server name
boolean	hasConfigSection(String name) Check if the specified configuration section name is available
boolean	hasConfigurationListeners() Check if there are any configuration change listeners
boolean	isServerRunning(String proto) Check if the specified protocol server exists and is running
boolean	isUpdated() Determine if the server configuration has been updated since loaded
void	loadConfiguration(String location) Load the configuration from the specified location.
int	numberOfServers() Return the number of active servers
void	removeAllConfigSections() Remove all configuration sections
ConfigSection	removeConfigSection(String name) Remove a configuration section
void	removeListener(ConfigurationListener listener) Remove a configuration change listener
NetworkServer	removeServer(String proto) Remove an active server
void	saveConfiguration(String location) Save the configuration to the specified location.
void	setServerName(String name) Set the server name
protected void	setUpdated(boolean upd) Set or clear the updated configuration flag

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerConfiguration

public ServerConfiguration(String name)

Construct a server configuration object

Parameters:

name - String

Method Detail

addConfigSection

public final void addConfigSection(ConfigSection config)

Add a configuration section

Parameters:

config - ConfigSection

hasConfigSection

public final boolean hasConfigSection(String name)

Check if the specified configuration section name is available

Parameters:

name - String

Returns:

boolean

getConfigSection

public final ConfigSection getConfigSection(String name)

Description copied from interface: ServerConfigurationAccessor

Return the required configuration section

Specified by:

getConfigSection in interface ServerConfigurationAccessor

Parameters:

name - String

Returns:

ConfigSection

removeConfigSection

public final ConfigSection removeConfigSection(String name)

Remove a configuration section

Parameters:

name - String

Returns:

ConfigSection

removeAllConfigSections

public final void removeAllConfigSections()

Remove all configuration sections

getServerName

public final String getServerName()

Description copied from interface: ServerConfigurationAccessor

Return the server name

Specified by:

getServerName in interface ServerConfigurationAccessor

Returns:

String

addServer

public final void addServer(NetworkServer srv)

Add a server to the list of active servers

Parameters:

srv - NetworkServer

findServer

public final NetworkServer findServer(String proto)

Find an active server using the protocol name

Parameters:

proto - String

Returns:

NetworkServer

removeServer

public final NetworkServer removeServer(String proto)

Remove an active server

Parameters:

proto - String

Returns:

NetworkServer

numberOfServers

public final int numberOfServers()

Return the number of active servers

Returns:

int

isServerRunning

public final boolean isServerRunning(String proto)

Description copied from interface: ServerConfigurationAccessor

Check if the specified protocol server exists and is running

Specified by:

isServerRunning in interface ServerConfigurationAccessor

Parameters:

proto - String

Returns:

boolean

getPlatformType

public final Platform.Type getPlatformType()

Return the platform type

Returns:

Platorm.Type

getPlatformTypeString

public final String getPlatformTypeString()

Return the platform type as a string

Returns:

String

getServer

public final NetworkServer getServer(int idx)

Return the server at the specified index

Parameters:

idx - int

Returns:

NetworkServer

isUpdated

public final boolean isUpdated()

Determine if the server configuration has been updated since loaded

Returns:

boolean

setUpdated

protected final void setUpdated(boolean upd)

Set or clear the updated configuration flag

Parameters:

upd - boolean

setServerName

public final void setServerName(String name)

Set the server name

Parameters:

name - String

addListener

public final void addListener(ConfigurationListener listener)

Add a configuration change listener

Parameters:

listener - ConfigurationListener

removeListener

public final void removeListener(ConfigurationListener listener)

Remove a configuration change listener

Parameters:

listener - ConfigurationListener

hasConfigurationListeners

public final boolean hasConfigurationListeners()

Check if there are any configuration change listeners

Returns:

boolean

fireConfigurationChange

protected final int fireConfigurationChange(int id,
                                            Object newVal)
                                     throws InvalidConfigurationException

Notify all registered configuration change listeners of a configuration change

Parameters:

id - int

newVal - Object

Returns:

int

Throws:

InvalidConfigurationException

loadConfiguration

public void loadConfiguration(String location)
                       throws IOException,
                              InvalidConfigurationException

Load the configuration from the specified location. The location depends on the implementation of the configuration.

Parameters:

location - String

Throws:

IOException

InvalidConfigurationException

saveConfiguration

public void saveConfiguration(String location)
                       throws IOException

Save the configuration to the specified location. The location depends on the implementation of the configuration.

Parameters:

location - String

Throws:

IOException

closeConfiguration

public void closeConfiguration()

Close the configuration