You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2017/10/16 12:43:40 UTC

[isis] 15/26: ISIS-1742: renames UrlEncodingUtils to UrlDecoderUtil, and deletes unused constants

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch dev/2.0.0/ISIS-1742-remove-deprecations
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 829b7b17ca4aa4e587c57b991d8e24e590f5c825
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Oct 16 12:49:26 2017 +0100

    ISIS-1742: renames UrlEncodingUtils to UrlDecoderUtil, and deletes unused constants
---
 .../package-info.java => url/UrlDecoderUtil.java}  | 35 +++++++++---
 .../isis/core/commons/url/UrlEncodingUtils.java    | 66 ----------------------
 .../isis/core/metamodel/adapter/oid/RootOid.java   |  4 +-
 .../resources/DomainObjectResourceServerside.java  |  5 +-
 .../resources/DomainServiceResourceServerside.java |  5 +-
 .../server/resources/ResourceAbstract.java         |  7 +--
 6 files changed, 37 insertions(+), 85 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/isis/core/commons/xml/package-info.java b/core/metamodel/src/main/java/org/apache/isis/core/commons/url/UrlDecoderUtil.java
similarity index 58%
rename from core/metamodel/src/main/java/org/apache/isis/core/commons/xml/package-info.java
rename to core/metamodel/src/main/java/org/apache/isis/core/commons/url/UrlDecoderUtil.java
index 9ec3da4..1f246d9 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/commons/xml/package-info.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/commons/url/UrlDecoderUtil.java
@@ -16,13 +16,30 @@
  *  specific language governing permissions and limitations
  *  under the License.
  */
+package org.apache.isis.core.commons.url;
 
-/**
- * Provides helper classes for writing alternative implementations
- * that just persist to a proprietary XML format.
- *
- * <p>
- * Specifically, these classes are used by the <i>XmlObjectStore</i>
- * and the <i>XmlProfileStore</i>.
- */
-package org.apache.isis.core.commons.xml;
\ No newline at end of file
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+
+public final class UrlDecoderUtil {
+
+    private UrlDecoderUtil() {
+    }
+
+    public static String urlDecode(final String input) {
+        try {
+            return URLDecoder.decode(input, "UTF-8");
+        } catch (final UnsupportedEncodingException e) {
+            return "";
+        }
+    }
+
+    public static String urlDecodeNullSafe(final String input) {
+        if (input == null) {
+            return null;
+        }
+
+        return urlDecode(input);
+    }
+
+}
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/commons/url/UrlEncodingUtils.java b/core/metamodel/src/main/java/org/apache/isis/core/commons/url/UrlEncodingUtils.java
deleted file mode 100644
index ee11718..0000000
--- a/core/metamodel/src/main/java/org/apache/isis/core/commons/url/UrlEncodingUtils.java
+++ /dev/null
@@ -1,66 +0,0 @@
-/*
- *  Licensed to the Apache Software Foundation (ASF) under one
- *  or more contributor license agreements.  See the NOTICE file
- *  distributed with this work for additional information
- *  regarding copyright ownership.  The ASF licenses this file
- *  to you under the Apache License, Version 2.0 (the
- *  "License"); you may not use this file except in compliance
- *  with the License.  You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing,
- *  software distributed under the License is distributed on an
- *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- *  KIND, either express or implied.  See the License for the
- *  specific language governing permissions and limitations
- *  under the License.
- */
-package org.apache.isis.core.commons.url;
-
-import java.io.UnsupportedEncodingException;
-import java.net.URLDecoder;
-
-import com.google.common.base.Function;
-
-public final class UrlEncodingUtils {
-
-    public final static Function<String, String> FUNCTION = new Function<String, String>() {
-
-        @Override
-        public String apply(final String input) {
-            try {
-                return URLDecoder.decode(input, "UTF-8");
-            } catch (final UnsupportedEncodingException e) {
-                return "";
-            }
-        }
-    };
-
-    public final static Function<String, String> FUNCTION_NULLSAFE = new Function<String, String>() {
-
-        @Override
-        public String apply(final String input) {
-            if (input == null) {
-                return null;
-            }
-            try {
-                return URLDecoder.decode(input, "UTF-8");
-            } catch (final UnsupportedEncodingException e) {
-                return "";
-            }
-        }
-    };
-
-    private UrlEncodingUtils() {
-    }
-
-    public static String urlDecode(final String string) {
-        return FUNCTION.apply(string);
-    }
-
-    public static String urlDecodeNullSafe(final String string) {
-        return FUNCTION_NULLSAFE.apply(string);
-    }
-
-}
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/adapter/oid/RootOid.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/adapter/oid/RootOid.java
index 14e8100..32215cb 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/adapter/oid/RootOid.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/adapter/oid/RootOid.java
@@ -30,7 +30,7 @@ import org.slf4j.LoggerFactory;
 import org.apache.isis.applib.services.bookmark.Bookmark;
 import org.apache.isis.core.commons.encoding.DataInputExtended;
 import org.apache.isis.core.commons.encoding.DataOutputExtended;
-import org.apache.isis.core.commons.url.UrlEncodingUtils;
+import org.apache.isis.core.commons.url.UrlDecoderUtil;
 import org.apache.isis.core.metamodel.adapter.version.Version;
 import org.apache.isis.core.metamodel.spec.ObjectSpecId;
 import org.apache.isis.schema.common.v1.BookmarkObjectState;
@@ -160,7 +160,7 @@ public class RootOid implements TypedOid, Serializable {
 
     //region > deString'able, enString
     public static RootOid deStringEncoded(final String urlEncodedOidStr) {
-        final String oidStr = UrlEncodingUtils.urlDecode(urlEncodedOidStr);
+        final String oidStr = UrlDecoderUtil.urlDecode(urlEncodedOidStr);
         return deString(oidStr);
     }
 
diff --git a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainObjectResourceServerside.java b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainObjectResourceServerside.java
index 6afa9f4..5d7afcd 100644
--- a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainObjectResourceServerside.java
+++ b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainObjectResourceServerside.java
@@ -32,7 +32,7 @@ import javax.ws.rs.core.Response;
 
 import org.apache.isis.applib.annotation.Where;
 import org.apache.isis.applib.services.command.Command;
-import org.apache.isis.core.commons.url.UrlEncodingUtils;
+import org.apache.isis.core.commons.url.UrlDecoderUtil;
 import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
 import org.apache.isis.core.metamodel.consent.Consent;
 import org.apache.isis.core.metamodel.consent.InteractionInitiatedBy;
@@ -456,7 +456,8 @@ public class DomainObjectResourceServerside extends ResourceAbstract implements
             final @PathParam("actionId") String actionId,
             final @QueryParam("x-isis-querystring") String xIsisUrlEncodedQueryString) {
 
-        final String urlUnencodedQueryString = UrlEncodingUtils.urlDecodeNullSafe(xIsisUrlEncodedQueryString != null? xIsisUrlEncodedQueryString: httpServletRequest.getQueryString());
+        final String urlUnencodedQueryString = UrlDecoderUtil
+                .urlDecodeNullSafe(xIsisUrlEncodedQueryString != null? xIsisUrlEncodedQueryString: httpServletRequest.getQueryString());
         init(RepresentationType.ACTION_RESULT, Where.STANDALONE_TABLES, RepresentationService.Intent.NOT_APPLICABLE, urlUnencodedQueryString);
 
         setCommandExecutor(Command.Executor.USER);
diff --git a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainServiceResourceServerside.java b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainServiceResourceServerside.java
index 010785c..bbc7ab2 100644
--- a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainServiceResourceServerside.java
+++ b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/DomainServiceResourceServerside.java
@@ -37,7 +37,7 @@ import com.google.common.collect.Lists;
 import org.apache.isis.applib.annotation.NatureOfService;
 import org.apache.isis.applib.annotation.Where;
 import org.apache.isis.applib.services.command.Command;
-import org.apache.isis.core.commons.url.UrlEncodingUtils;
+import org.apache.isis.core.commons.url.UrlDecoderUtil;
 import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
 import org.apache.isis.core.metamodel.facets.object.domainservice.DomainServiceFacet;
 import org.apache.isis.core.metamodel.spec.ObjectSpecification;
@@ -202,7 +202,8 @@ public class DomainServiceResourceServerside extends ResourceAbstract implements
             final @PathParam("actionId") String actionId,
             final @QueryParam("x-isis-querystring") String xIsisUrlEncodedQueryString) {
 
-        final String urlUnencodedQueryString = UrlEncodingUtils.urlDecodeNullSafe(xIsisUrlEncodedQueryString != null? xIsisUrlEncodedQueryString: httpServletRequest.getQueryString());
+        final String urlUnencodedQueryString = UrlDecoderUtil
+                .urlDecodeNullSafe(xIsisUrlEncodedQueryString != null? xIsisUrlEncodedQueryString: httpServletRequest.getQueryString());
         init(RepresentationType.ACTION_RESULT, Where.STANDALONE_TABLES, RepresentationService.Intent.NOT_APPLICABLE, urlUnencodedQueryString);
 
         setCommandExecutor(Command.Executor.USER);
diff --git a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/ResourceAbstract.java b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/ResourceAbstract.java
index 8806959..34ce3cb 100644
--- a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/ResourceAbstract.java
+++ b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/ResourceAbstract.java
@@ -35,7 +35,7 @@ import org.apache.isis.applib.services.command.Command;
 import org.apache.isis.applib.services.command.CommandContext;
 import org.apache.isis.core.commons.authentication.AuthenticationSession;
 import org.apache.isis.core.commons.config.IsisConfiguration;
-import org.apache.isis.core.commons.url.UrlEncodingUtils;
+import org.apache.isis.core.commons.url.UrlDecoderUtil;
 import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
 import org.apache.isis.core.metamodel.consent.InteractionInitiatedBy;
 import org.apache.isis.core.metamodel.deployment.DeploymentCategory;
@@ -53,7 +53,6 @@ import org.apache.isis.viewer.restfulobjects.rendering.service.RepresentationSer
 import org.apache.isis.viewer.restfulobjects.rendering.util.Util;
 import org.apache.isis.viewer.restfulobjects.server.ResourceContext;
 import org.apache.isis.viewer.restfulobjects.server.util.OidUtils;
-import org.apache.isis.viewer.restfulobjects.server.util.UrlDecoderUtils;
 
 public abstract class ResourceAbstract {
 
@@ -96,7 +95,7 @@ public abstract class ResourceAbstract {
 
     private String getUrlDecodedQueryStringIfAny() {
         final String queryStringIfAny = httpServletRequest.getQueryString();
-        return UrlEncodingUtils.urlDecodeNullSafe(queryStringIfAny);
+        return UrlDecoderUtil.urlDecodeNullSafe(queryStringIfAny);
     }
 
     protected void init(
@@ -143,7 +142,7 @@ public abstract class ResourceAbstract {
         ObjectAdapter objectAdapter = getObjectAdapterElseNull(domainType, instanceId);
 
         if (objectAdapter == null) {
-            final String instanceIdUnencoded = UrlDecoderUtils.urlDecode(instanceId);
+            final String instanceIdUnencoded = org.apache.isis.viewer.restfulobjects.server.util.UrlDecoderUtils.urlDecode(instanceId);
             throw RestfulObjectsApplicationException.createWithMessage(HttpStatusCode.NOT_FOUND, "could not determine adapter for OID: '%s:%s'", domainType, instanceIdUnencoded);
         }
         return objectAdapter;

-- 
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.