mirror of
https://github.com/eclipse-sailing-analytics/sailing-analytics.git
synced 2026-09-25 06:58:39 +00:00
add documentation for replicable service
This commit is contained in:
+35
@@ -0,0 +1,35 @@
|
||||
package com.sap.sse.filestorage.common;
|
||||
|
||||
import com.sap.sse.common.NoCorrespondingServiceRegisteredException;
|
||||
|
||||
/**
|
||||
* OSGi service for managing {@link FileStorageService FileStorageServices}.
|
||||
*
|
||||
* @author Fredrik Teschke
|
||||
*
|
||||
*/
|
||||
public interface FileStorageManagementService {
|
||||
FileStorageService[] getAvailableFileStorageServices();
|
||||
|
||||
FileStorageService getFileStorageService(String name);
|
||||
|
||||
/**
|
||||
* Sets the property of the service, and also stores the property value so that it can be restored after a server
|
||||
* restart.
|
||||
*
|
||||
* @throws NoCorrespondingServiceRegisteredException
|
||||
* service may have disappeared from registry in the meantime
|
||||
* @throws IllegalArgumentException
|
||||
* if the property with name {@code propertyName} doesn't exist for the service
|
||||
*/
|
||||
void setFileStorageServiceProperty(String serviceName, String propertyName, String propertyValue)
|
||||
throws NoCorrespondingServiceRegisteredException, IllegalArgumentException;
|
||||
|
||||
/**
|
||||
* @throws NoCorrespondingServiceRegisteredException
|
||||
* if no service has been selected so far.
|
||||
*/
|
||||
FileStorageService getActiveFileStorageService() throws NoCorrespondingServiceRegisteredException;
|
||||
|
||||
void setActiveFileStorageService(FileStorageService service);
|
||||
}
|
||||
+7
-1
@@ -1,15 +1,21 @@
|
||||
package com.sap.sse.filestorage.impl;
|
||||
|
||||
import com.sap.sse.common.NoCorrespondingServiceRegisteredException;
|
||||
import com.sap.sse.filestorage.FileStorageManagementService;
|
||||
import com.sap.sse.filestorage.common.FileStorageService;
|
||||
|
||||
/**
|
||||
* Defines internal operations that do are called only by
|
||||
* Publishes those methods of {@link FileStorageManagementService} that are required by operations implemented as lambda
|
||||
* expressions to fulfill their tasks. These operations should not be invoked by external service clients.
|
||||
* {@link FileStorageManagementService} is the one registered with the OSGi registry and thus the publicly-visible
|
||||
* interface (description copied from ReplicableSecurityService).
|
||||
*
|
||||
* @author Fredrik Teschke
|
||||
*
|
||||
*/
|
||||
public interface ReplicableFileStorageManagementService {
|
||||
void internalSetFileStorageServiceProperty(String serviceName, String propertyName, String propertyValue)
|
||||
throws NoCorrespondingServiceRegisteredException, IllegalArgumentException;
|
||||
|
||||
void internalSetActiveFileStorageService(FileStorageService service);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user