MCR-3348 rename static factory methods as per new convention and deprecate old methods (#2434)

Author: toKrause

mycore-acl-editor2/src/main/java/org/mycore/frontend/acl2/resources/MCRAclEditorResource.java

@@ -64,9 +64,9 @@
 @Path("ACLE")
 public class MCRAclEditorResource {
 
-    private static final MCRRuleStore RULE_STORE = MCRRuleStore.getInstance();
+    private static final MCRRuleStore RULE_STORE = MCRRuleStore.obtainInstance();
 
-    private static final MCRAccessStore ACCESS_STORE = MCRAccessStore.getInstance();
+    private static final MCRAccessStore ACCESS_STORE = MCRAccessStore.obtainInstance();
 
     private static final String JSON_ACCESSID = "accessID";
 

mycore-acl/src/main/java/org/mycore/mcr/acl/accesskey/restapi/v2/MCRAccessKeyRestExceptionMapper.java

@@ -52,7 +52,7 @@ public static Response fromException(MCRAccessKeyException e) {
     }
 
     private static Response getResponse(Exception e, int statusCode, String errorCode) {
-        MCRErrorResponse response = MCRErrorResponse.fromStatus(statusCode)
+        MCRErrorResponse response = MCRErrorResponse.ofStatusCode(statusCode)
             .withCause(e)
             .withMessage(e.getMessage())
             .withDetail(Optional.of(e)

mycore-acl/src/main/java/org/mycore/mcr/acl/accesskey/restapi/v2/MCRRestAccessKeyHelper.java

@@ -52,7 +52,7 @@ public class MCRRestAccessKeyHelper {
     protected static final String QUERY_PARAM_SECRET_ENCODING = "secret_encoding";
 
     private static WebApplicationException getUnknownObjectException(final MCRObjectID objectId) {
-        return MCRErrorResponse.fromStatus(Response.Status.NOT_FOUND.getStatusCode())
+        return MCRErrorResponse.ofStatusCode(Response.Status.NOT_FOUND.getStatusCode())
             .withMessage(objectId + " does not exist!")
             .withErrorCode("objectNotFound")
             .toException();

mycore-base/src/main/java/org/mycore/access/MCRAccessCacheHelper.java

@@ -61,7 +61,7 @@ public static void clearAllPermissionCaches(String id) {
 
     private static void collectDescendants(List<String> idsToClear, String parent) {
         // get derivates
-        final MCRLinkTableManager ltManager = MCRLinkTableManager.instance();
+        final MCRLinkTableManager ltManager = MCRLinkTableManager.getInstance();
         idsToClear.addAll(ltManager.getDestinationOf(parent, MCRLinkTableManager.ENTRY_TYPE_DERIVATE));
 
         // get children

mycore-base/src/main/java/org/mycore/access/facts/MCRFactsAccessSystem.java

@@ -120,7 +120,7 @@ public void setProperties(Map<String, String> properties) {
     }
 
     private MCRCondition buildRulesFromXML() {
-        Element eRules = MCRURIResolver.instance().resolve(rulesURI);
+        Element eRules = MCRURIResolver.obtainInstance().resolve(rulesURI);
         Objects.requireNonNull(eRules, "The rulesURI " + rulesURI + " resolved to null!");
         MCRJDOMContent content = new MCRJDOMContent(eRules);
         try {
@@ -227,7 +227,7 @@ private boolean isCategory(String checkID) {
             return false;
         }
         try {
-            return MCRCategoryDAOFactory.getInstance().exist(MCRCategoryID.fromString(checkID));
+            return MCRCategoryDAOFactory.getInstance().exist(MCRCategoryID.ofString(checkID));
         } catch (IllegalArgumentException e) {
             return false;
         }

mycore-base/src/main/java/org/mycore/access/facts/MCRObjectCacheFactory.java

@@ -40,19 +40,27 @@ public final class MCRObjectCacheFactory extends MCREventHandlerBase {
 
     private static final Logger LOGGER = LogManager.getLogger();
 
-    private static final MCRObjectCacheFactory SINGLETON = new MCRObjectCacheFactory();
+    private static final MCRObjectCacheFactory SINGLETON_INSTANCE = new MCRObjectCacheFactory();
 
     private static final int CACHE_MAX_SIZE = 100;
 
     private final MCRCache<MCRObjectID, MCRObject> objectCache;
 
     private MCRObjectCacheFactory() {
         objectCache = new MCRCache<>(CACHE_MAX_SIZE, this.getClass().getName());
-        MCREventManager.instance().addEventHandler(MCREvent.ObjectType.OBJECT, this);
+        MCREventManager.getInstance().addEventHandler(MCREvent.ObjectType.OBJECT, this);
     }
 
+    /**
+     * @deprecated Use {@link #getInstance()} instead
+     */
+    @Deprecated
     public static MCRObjectCacheFactory instance() {
-        return SINGLETON;
+        return getInstance();
+    }
+
+    public static MCRObjectCacheFactory getInstance() {
+        return SINGLETON_INSTANCE;
     }
 
     public MCRObject getObject(MCRObjectID oid) {

mycore-base/src/main/java/org/mycore/access/facts/condition/fact/MCRCategoryCondition.java

@@ -71,7 +71,7 @@ public Optional<MCRCategoryIDFact> computeFact(MCRFactsHolder facts) {
         if (idc.isPresent()) {
             MCRObjectID objectID = idc.get().getValue();
             if (objectID != null) {
-                MCRCategoryID categoryID = MCRCategoryID.fromString(getTerm());
+                MCRCategoryID categoryID = MCRCategoryID.ofString(getTerm());
                 MCRCategLinkService linkService = MCRCategLinkServiceFactory.getInstance();
                 if (linkService.isInCategory(new MCRCategLinkReference(objectID), categoryID)) {
                     MCRCategoryIDFact result = new MCRCategoryIDFact(getFactName(), getTerm());

mycore-base/src/main/java/org/mycore/access/facts/fact/MCRObjectIDFact.java

@@ -49,7 +49,7 @@ public Optional<MCRObject> getObject() {
         if (objectID == null) {
             return Optional.empty();
         }
-        return Optional.ofNullable(MCRObjectCacheFactory.instance().getObject(objectID));
+        return Optional.ofNullable(MCRObjectCacheFactory.getInstance().getObject(objectID));
     }
 
 }

mycore-base/src/main/java/org/mycore/access/mcrimpl/MCRAccessControlSystem.java

@@ -75,8 +75,8 @@ private MCRAccessControlSystem() {
             disabled = true;
         }
 
-        accessStore = MCRAccessStore.getInstance();
-        ruleStore = MCRRuleStore.getInstance();
+        accessStore = MCRAccessStore.obtainInstance();
+        ruleStore = MCRRuleStore.obtainInstance();
         dummyRule = new MCRAccessRule(null, null, null, null, "dummy rule, always true");
     }
 

mycore-base/src/main/java/org/mycore/access/mcrimpl/MCRAccessStore.java

@@ -49,8 +49,6 @@ public abstract class MCRAccessStore {
     protected static final String ACCESS_POOLS = MCRConfiguration2.getString("MCR.AccessPools")
         .orElse("read,write,delete");
 
-    private static volatile MCRAccessStore implementation;
-
     public abstract String getRuleID(String objID, String acPool);
 
     public abstract void createAccessDefinition(MCRRuleMapping accessdata);
@@ -77,16 +75,17 @@ public abstract class MCRAccessStore {
      */
     public abstract Collection<String> getDistinctStringIDs();
 
+
+    /**
+     * @deprecated Use {@link #obtainInstance()} instead
+     */
+    @Deprecated
     public static MCRAccessStore getInstance() {
-        if (implementation == null) {
-            synchronized (MCRAccessStore.class) {
-                if(implementation == null) {
-                    implementation = MCRConfiguration2.getSingleInstanceOfOrThrow(
-                        MCRAccessStore.class, "MCR.Persistence.Access.Store.Class");
-                }
-            }
-        }
-        return implementation;
+        return obtainInstance();
+    }
+
+    public static MCRAccessStore obtainInstance() {
+        return LazyInstanceHolder.SHARED_INSTANCE;
     }
 
     public static Collection<String> getPools() {
@@ -104,21 +103,21 @@ public static Collection<String> getPools() {
     public Collection<MCRAccessDefinition> getDefinition(String type) {
         try {
             Map<String, Collection<String>> sqlDefinition = new HashMap<>();
-            Collection<String> pools = getInstance().getDatabasePools();
+            Collection<String> pools = obtainInstance().getDatabasePools();
             //merge pools
             pools.removeAll(getPools());
             pools.addAll(getPools());
 
             for (String pool : pools) {
-                sqlDefinition.put(pool, getInstance().getMappedObjectId(pool));
+                sqlDefinition.put(pool, obtainInstance().getMappedObjectId(pool));
             }
 
             Collection<MCRAccessDefinition> ret = new ArrayList<>();
             Collection<String> elements;
             MCRAccessDefinition def = null;
 
             if (MCRConfiguration2.getOrThrow("MCR.Metadata.Type." + type, Boolean::parseBoolean)) {
-                elements = MCRXMLMetadataManager.instance().listIDsOfType(type);
+                elements = MCRXMLMetadataManager.getInstance().listIDsOfType(type);
             } else {
                 return Collections.emptySet();
             }
@@ -145,7 +144,7 @@ public Collection<MCRAccessDefinition> getDefinition(String type) {
 
     public Collection<MCRAccessDefinition> getRules(String objid) {
         try {
-            Collection<String> pools = getInstance().getDatabasePools();
+            Collection<String> pools = obtainInstance().getDatabasePools();
             //merge pools
             pools.removeAll(getPools());
             pools.addAll(getPools());
@@ -163,4 +162,9 @@ public Collection<MCRAccessDefinition> getRules(String objid) {
         }
     }
 
+    private static final class LazyInstanceHolder {
+        public static final MCRAccessStore SHARED_INSTANCE = MCRConfiguration2.getInstanceOfOrThrow(
+            MCRAccessStore.class, "MCR.Persistence.Access.Store.Class");
+    }
+
 }