com.sas.services
Interface ServiceComponentConfigInterface

All Known Implementing Classes:

AbstractServiceComponentConfig

public interface ServiceComponentConfigInterface

Interface describing operations which pertain to a foundation service's metadata.

Since:

1.1.3

Method Summary

boolean	isConfigurationUpdateable() Determines whether or not this service component's configuration is updateable.
void	mergeConfigFromFile(ServiceComponent serviceComponent, File file) Updates the service's configuration by adding new service configuration read from the specified file to the service component's pre-existing configuration.
void	writeServiceConfigToFile(File file, ServiceComponent serviceComponent) Write the service's configuration to the specified output stream.

Method Detail

isConfigurationUpdateable

public boolean isConfigurationUpdateable()

Determines whether or not this service component's configuration is updateable.

Returns:

true if the service configuration is udpateable or false if the configuration may not be updated by merging a new configuration.

mergeConfigFromFile

public void mergeConfigFromFile(ServiceComponent serviceComponent,
                                File file)
                         throws ServiceException

Updates the service's configuration by adding new service configuration read from the specified file to the service component's pre-existing configuration.

Parameters:

serviceComponent - The service whose configuration is to be updated.

file - File containing the service configuration which is to be added to the service component's current configuration. Note that only configuration data that is additive in nature can be appended. Configuration data that is non-additive will be ignored.

Throws:

ServiceException - if unable to update the service's configuration.

writeServiceConfigToFile

public void writeServiceConfigToFile(File file,
                                     ServiceComponent serviceComponent)
                              throws ServiceException

Write the service's configuration to the specified output stream.

Parameters:

file - File to which the service's configuration is to be written.

serviceComponent - Service component whose configuration is to be written to the specified file.

Throws:

ServiceException - in an exception is encountered writing the service component's configuration to the specified file.