Skip to content

Simplifying preferences handling in save-and-restore #2931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shroffk merged 1 commit into from
Feb 1, 2024
Merged

Simplifying preferences handling in save-and-restore #2931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions ...ve-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/Preferences.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,56 @@
import org.phoebus.framework.preferences.AnnotatedPreferences;
import org.phoebus.framework.preferences.Preference;

/**
* Preferences for save-and-restore client.
*/
public class Preferences {

/**
* Timeout for PV read operations when taking snapshot.
*/
@Preference
public static int readTimeout;

/**
* Page size used in search UI.
*/
@Preference
public static int search_result_page_size;

/**
* Default search query in search UI.
*/
@Preference
public static String default_search_query;

/**
* Date format of default/automatic snapshot name.
*/
@Preference
public static String default_snapshot_name_date_format;

static
{
/**
* Where to find the service...
*/
@Preference(name = "jmasar.service.url")
public static String jmasarServiceUrl;

/**
* Timeout to read response from service. This may need to be increased from default 5000 ms
* if client is handling snapshots with very large number of PVs.
*/
@Preference(name = "httpClient.readTimeout")
public static int httpClientReadTimeout;

/**
* Timeout for client connection to service.
*/
@Preference(name = "httpClient.connectTimeout")
public static int httpClientConnectTimeout;

static {
AnnotatedPreferences.initialize(Preferences.class, "/save_and_restore_preferences.properties");
AnnotatedPreferences.initialize(Preferences.class, "/save_and_restore_client_preferences.properties");
}
}
82 changes: 32 additions & 50 deletions .../main/java/org/phoebus/applications/saveandrestore/client/SaveAndRestoreJerseyClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@
import com.sun.jersey.api.client.config.DefaultClientConfig;
import com.sun.jersey.api.client.filter.HTTPBasicAuthFilter;
import org.phoebus.applications.saveandrestore.Messages;
import org.phoebus.applications.saveandrestore.Preferences;
import org.phoebus.applications.saveandrestore.SaveAndRestoreClientException;
import org.phoebus.applications.saveandrestore.model.*;
import org.phoebus.applications.saveandrestore.model.search.Filter;
import org.phoebus.applications.saveandrestore.model.search.SearchResult;
import org.phoebus.framework.preferences.PreferencesReader;
import org.phoebus.security.store.SecureStore;
import org.phoebus.security.tokens.AuthenticationScope;
import org.phoebus.security.tokens.ScopedAuthenticationToken;
Expand All @@ -47,13 +47,8 @@ public class SaveAndRestoreJerseyClient implements org.phoebus.applications.save
private static final String CONTENT_TYPE_JSON = "application/json; charset=UTF-8";
private final Logger logger = Logger.getLogger(SaveAndRestoreJerseyClient.class.getName());

private final String jmasarServiceUrl;

private static final int DEFAULT_READ_TIMEOUT = 5000; // ms
private static final int DEFAULT_CONNECT_TIMEOUT = 3000; // ms

private int httpClientReadTimeout = DEFAULT_READ_TIMEOUT;
private int httpClientConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
private static final int DEFAULT_CONNECT_TIMEOUT = 5000; // ms

ObjectMapper mapper = new ObjectMapper();

Expand All @@ -63,28 +58,15 @@ public SaveAndRestoreJerseyClient() {

mapper.registerModule(new JavaTimeModule());
mapper.setSerializationInclusion(Include.NON_NULL);

PreferencesReader preferencesReader = new PreferencesReader(SaveAndRestoreClient.class, "/save_and_restore_client_preferences.properties");
this.jmasarServiceUrl = preferencesReader.get("jmasar.service.url");

String readTimeoutString = preferencesReader.get("httpClient.readTimeout");
try {
httpClientReadTimeout = Integer.parseInt(readTimeoutString);
logger.log(Level.INFO, "Save&restore client using read timeout " + httpClientReadTimeout + " ms");
} catch (NumberFormatException e) {
logger.log(Level.INFO, "Property httpClient.readTimeout \"" + readTimeoutString + "\" is not a number, using default value " + DEFAULT_READ_TIMEOUT + " ms");
}

String connectTimeoutString = preferencesReader.get("httpClient.connectTimeout");
try {
httpClientConnectTimeout = Integer.parseInt(connectTimeoutString);
logger.log(Level.INFO, "Save&restore client using connect timeout " + httpClientConnectTimeout + " ms");
} catch (NumberFormatException e) {
logger.log(Level.INFO, "Property httpClient.connectTimeout \"" + connectTimeoutString + "\" is not a number, using default value " + DEFAULT_CONNECT_TIMEOUT + " ms");
}
}

private Client getClient() {
int httpClientReadTimeout = Preferences.httpClientReadTimeout > 0 ? Preferences.httpClientReadTimeout : DEFAULT_READ_TIMEOUT;
logger.log(Level.INFO, "Save&restore client using read timeout " + httpClientReadTimeout + " ms");

int httpClientConnectTimeout = Preferences.httpClientConnectTimeout > 0 ? Preferences.httpClientConnectTimeout : DEFAULT_CONNECT_TIMEOUT;
logger.log(Level.INFO, "Save&restore client using connect timeout " + httpClientConnectTimeout + " ms");

DefaultClientConfig defaultClientConfig = new DefaultClientConfig();
defaultClientConfig.getProperties().put(ClientConfig.PROPERTY_READ_TIMEOUT, httpClientReadTimeout);
defaultClientConfig.getProperties().put(ClientConfig.PROPERTY_CONNECT_TIMEOUT, httpClientConnectTimeout);
Expand Down Expand Up @@ -114,7 +96,7 @@ private Client getClient() {

@Override
public String getServiceUrl() {
return jmasarServiceUrl;
return Preferences.jmasarServiceUrl;
}

@Override
Expand All @@ -129,7 +111,7 @@ public Node getNode(String uniqueNodeId) {

@Override
public List<Node> getCompositeSnapshotReferencedNodes(String uniqueNodeId) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/composite-snapshot/" + uniqueNodeId + "/nodes");
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/composite-snapshot/" + uniqueNodeId + "/nodes");

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON).get(ClientResponse.class);
if (response.getStatus() != ClientResponse.Status.OK.getStatusCode()) {
Expand All @@ -148,7 +130,7 @@ public List<Node> getCompositeSnapshotReferencedNodes(String uniqueNodeId) {

@Override
public List<SnapshotItem> getCompositeSnapshotItems(String uniqueNodeId) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/composite-snapshot/" + uniqueNodeId + "/items");
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/composite-snapshot/" + uniqueNodeId + "/items");

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON).get(ClientResponse.class);
if (response.getStatus() != ClientResponse.Status.OK.getStatusCode()) {
Expand Down Expand Up @@ -179,7 +161,7 @@ public List<Node> getChildNodes(String uniqueNodeId) throws SaveAndRestoreClient

@Override
public Node createNewNode(String parentNodeId, Node node) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/node")
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/node")
.queryParam("parentNodeId", parentNodeId);
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(node, CONTENT_TYPE_JSON)
Expand All @@ -203,7 +185,7 @@ public Node updateNode(Node nodeToUpdate) {

@Override
public Node updateNode(Node nodeToUpdate, boolean customTimeForMigration) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/node")
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/node")
.queryParam("customTimeForMigration", customTimeForMigration ? "true" : "false");

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
Expand All @@ -229,7 +211,7 @@ private <T> T getCall(String relativeUrl, Class<T> clazz) {
}

private ClientResponse getCall(String relativeUrl) {
WebResource webResource = getClient().resource(jmasarServiceUrl + relativeUrl);
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + relativeUrl);

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON).get(ClientResponse.class);
if (response.getStatus() != ClientResponse.Status.OK.getStatusCode()) {
Expand All @@ -247,7 +229,7 @@ private ClientResponse getCall(String relativeUrl) {

@Override
public void deleteNodes(List<String> nodeIds) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/node");
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/node");
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(nodeIds, CONTENT_TYPE_JSON)
.delete(ClientResponse.class);
Expand All @@ -274,7 +256,7 @@ public List<Node> getAllSnapshots() {
@Override
public Node moveNodes(List<String> sourceNodeIds, String targetNodeId) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/move")
getClient().resource(Preferences.jmasarServiceUrl + "/move")
.queryParam("to", targetNodeId);

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
Expand All @@ -296,7 +278,7 @@ public Node moveNodes(List<String> sourceNodeIds, String targetNodeId) {
@Override
public Node copyNodes(List<String> sourceNodeIds, String targetNodeId) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/copy")
getClient().resource(Preferences.jmasarServiceUrl + "/copy")
.queryParam("to", targetNodeId);

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
Expand All @@ -318,7 +300,7 @@ public Node copyNodes(List<String> sourceNodeIds, String targetNodeId) {
@Override
public String getFullPath(String uniqueNodeId) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/path/" + uniqueNodeId);
getClient().resource(Preferences.jmasarServiceUrl + "/path/" + uniqueNodeId);
ClientResponse response = webResource.get(ClientResponse.class);

if (response.getStatus() != ClientResponse.Status.OK.getStatusCode()) {
Expand All @@ -341,7 +323,7 @@ public ConfigurationData getConfigurationData(String nodeId) {
@Override
public Configuration createConfiguration(String parentNodeId, Configuration configuration) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/config")
getClient().resource(Preferences.jmasarServiceUrl + "/config")
.queryParam("parentNodeId", parentNodeId);
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(configuration, CONTENT_TYPE_JSON)
Expand All @@ -360,7 +342,7 @@ public Configuration createConfiguration(String parentNodeId, Configuration conf

@Override
public Configuration updateConfiguration(Configuration configuration) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/config");
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/config");

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(configuration, CONTENT_TYPE_JSON)
Expand All @@ -386,7 +368,7 @@ public SnapshotData getSnapshotData(String nodeId) {
@Override
public Snapshot createSnapshot(String parentNodeId, Snapshot snapshot) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/snapshot")
getClient().resource(Preferences.jmasarServiceUrl + "/snapshot")
.queryParam("parentNodeId", parentNodeId);
ClientResponse response;
try {
Expand All @@ -411,7 +393,7 @@ public Snapshot createSnapshot(String parentNodeId, Snapshot snapshot) {
@Override
public Snapshot updateSnapshot(Snapshot snapshot) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/snapshot");
getClient().resource(Preferences.jmasarServiceUrl + "/snapshot");
ClientResponse response;
try {
response = webResource.accept(CONTENT_TYPE_JSON)
Expand All @@ -436,7 +418,7 @@ public Snapshot updateSnapshot(Snapshot snapshot) {
@Override
public CompositeSnapshot createCompositeSnapshot(String parentNodeId, CompositeSnapshot compositeSnapshot) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/composite-snapshot")
getClient().resource(Preferences.jmasarServiceUrl + "/composite-snapshot")
.queryParam("parentNodeId", parentNodeId);
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(compositeSnapshot, CONTENT_TYPE_JSON)
Expand All @@ -456,7 +438,7 @@ public CompositeSnapshot createCompositeSnapshot(String parentNodeId, CompositeS
@Override
public List<String> checkCompositeSnapshotConsistency(List<String> snapshotNodeIds) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/composite-snapshot-consistency-check");
getClient().resource(Preferences.jmasarServiceUrl + "/composite-snapshot-consistency-check");
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(snapshotNodeIds, CONTENT_TYPE_JSON)
.post(ClientResponse.class);
Expand All @@ -475,7 +457,7 @@ public List<String> checkCompositeSnapshotConsistency(List<String> snapshotNodeI

@Override
public CompositeSnapshot updateCompositeSnapshot(CompositeSnapshot compositeSnapshot) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/composite-snapshot");
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/composite-snapshot");

ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(compositeSnapshot, CONTENT_TYPE_JSON)
Expand All @@ -494,7 +476,7 @@ public CompositeSnapshot updateCompositeSnapshot(CompositeSnapshot compositeSnap

@Override
public SearchResult search(MultivaluedMap<String, String> searchParams) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/search")
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/search")
.queryParams(searchParams);
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.get(ClientResponse.class);
Expand All @@ -512,7 +494,7 @@ public SearchResult search(MultivaluedMap<String, String> searchParams) {

@Override
public Filter saveFilter(Filter filter) {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/filter");
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/filter");
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.entity(filter, CONTENT_TYPE_JSON)
.put(ClientResponse.class);
Expand All @@ -530,7 +512,7 @@ public Filter saveFilter(Filter filter) {

@Override
public List<Filter> getAllFilters() {
WebResource webResource = getClient().resource(jmasarServiceUrl + "/filters");
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/filters");
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.get(ClientResponse.class);
if (response.getStatus() != ClientResponse.Status.OK.getStatusCode()) {
Expand All @@ -550,7 +532,7 @@ public List<Filter> getAllFilters() {
public void deleteFilter(String name) {
// Filter name may contain space chars, need to URL encode these.
String filterName = name.replace(" ", "%20");
WebResource webResource = getClient().resource(jmasarServiceUrl + "/filter/" + filterName);
WebResource webResource = getClient().resource(Preferences.jmasarServiceUrl + "/filter/" + filterName);
ClientResponse response = webResource.accept(CONTENT_TYPE_JSON)
.delete(ClientResponse.class);
if (response.getStatus() != ClientResponse.Status.OK.getStatusCode()) {
Expand All @@ -574,7 +556,7 @@ public void deleteFilter(String name) {
public List<Node> addTag(TagData tagData) {

WebResource webResource =
getClient().resource(jmasarServiceUrl + "/tags");
getClient().resource(Preferences.jmasarServiceUrl + "/tags");
ClientResponse response;
try {
response = webResource.accept(CONTENT_TYPE_JSON)
Expand Down Expand Up @@ -605,7 +587,7 @@ public List<Node> addTag(TagData tagData) {
*/
public List<Node> deleteTag(TagData tagData) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/tags");
getClient().resource(Preferences.jmasarServiceUrl + "/tags");
ClientResponse response;
try {
response = webResource.accept(CONTENT_TYPE_JSON)
Expand All @@ -630,7 +612,7 @@ public List<Node> deleteTag(TagData tagData) {
@Override
public UserData authenticate(String userName, String password) {
WebResource webResource =
getClient().resource(jmasarServiceUrl + "/login")
getClient().resource(Preferences.jmasarServiceUrl + "/login")
.queryParam("username", userName)
.queryParam("password", password);
ClientResponse response;
Expand Down
4 changes: 2 additions & 2 deletions app/save-and-restore/app/src/main/resources/save_and_restore_client_preferences.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
jmasar.service.url=http://localhost:8080/save-restore

# Read timeout (in ms) used by the Jersey client
httpClient.readTimeout=1000
httpClient.readTimeout=5000

# Connect timeout in (ms) used by the Jersey client
httpClient.connectTimeout=1000
httpClient.connectTimeout=5000
2 changes: 2 additions & 0 deletions app/save-and-restore/app/src/main/resources/save_and_restore_preferences.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ default_search_query=tags=golden

# If declared add a date automatically in the name of the snapshot "Take Snapshot"
#default_snapshot_name_date_format=yyyy-MM-dd HH:mm:ss

this.is.a.test=MUSIGNY