Author: mpetria
Date: Mon Dec 15 12:16:35 2014
New Revision: 1645630
URL: http://svn.apache.org/r1645630
Log:
SLING-4153: changing distribution response to a provider interface
Added:
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/SimpleDistributionResponse.java
Modified:
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionRequest.java
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/agent/impl/SimpleDistributionAgent.java
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/DefaultDistributor.java
Modified:
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionRequest.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionRequest.java?rev=1645630&r1=1645629&r2=1645630&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionRequest.java
(original)
+++
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionRequest.java
Mon Dec 15 12:16:35 2014
@@ -18,6 +18,9 @@
*/
package org.apache.sling.distribution.communication;
+import aQute.bnd.annotation.ProviderType;
+
+import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import java.util.Arrays;
@@ -25,6 +28,7 @@ import java.util.Arrays;
* A {@link org.apache.sling.distribution.communication.DistributionRequest}
represents the need from the caller to have
* some content being distributed from a source instance to a target instance.
*/
+@ProviderType
public interface DistributionRequest {
@@ -33,6 +37,7 @@ public interface DistributionRequest {
*
* @return the type of the request as a {@link DistributionRequestType}
*/
+ @Nonnull
public DistributionRequestType getRequestType();
/**
@@ -40,6 +45,7 @@ public interface DistributionRequest {
*
* @return an array of paths
*/
+ @CheckForNull
public String[] getPaths();
@@ -49,7 +55,7 @@ public interface DistributionRequest {
* @param path the path to be checked
* @return <code>true</code> if the paths are deep
*/
- public boolean isDeep(String path);
+ public boolean isDeep(@Nonnull String path);
}
Modified:
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java?rev=1645630&r1=1645629&r2=1645630&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java
(original)
+++
sling/trunk/contrib/extensions/distribution/api/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java
Mon Dec 15 12:16:35 2014
@@ -18,6 +18,9 @@
*/
package org.apache.sling.distribution.communication;
+import aQute.bnd.annotation.ProviderType;
+
+import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
@@ -28,27 +31,30 @@ import javax.annotation.Nullable;
* the {@link org.apache.sling.distribution.communication.DistributionRequest
request} and optionally a message for more
* verbose information about the outcome of the request.
*/
-public class DistributionResponse {
-
- private final DistributionRequestState state;
- private final String message;
-
- public DistributionResponse(@Nonnull DistributionRequestState state,
@Nullable String message) {
- this.state = state;
- this.message = message;
- }
-
- public DistributionRequestState getState() {
- return state;
- }
-
- public String getMessage() {
- return message != null ? message : "";
- }
-
- @Override
- public String toString() {
- return "{\"state\":" + state + ", \"message\":\"" + message + "\"}";
- }
+@ProviderType
+public interface DistributionResponse {
+ /**
+ * returns the status of the request, whether it is successful or not.
+ * A successful request it is not necessarily distributed, it is just
successfully received by the agent.
+ * To check the exact state of the request one can retrieve it with
<code>getState</code>
+ *
+ * @return <code>true</code> if request has been accepted by the agent.
+ */
+ boolean isSuccessful();
+
+ /**
+ * returns the state of the associated {@link DistributionRequest}
+ *
+ * @return the state of the associated request
+ */
+ @Nonnull
+ DistributionRequestState getState();
+
+ /**
+ * returns a verbose message of the response
+ * @return
+ */
+ @CheckForNull
+ String getMessage();
}
Modified:
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/agent/impl/SimpleDistributionAgent.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/agent/impl/SimpleDistributionAgent.java?rev=1645630&r1=1645629&r2=1645630&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/agent/impl/SimpleDistributionAgent.java
(original)
+++
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/agent/impl/SimpleDistributionAgent.java
Mon Dec 15 12:16:35 2014
@@ -37,6 +37,7 @@ import org.apache.sling.distribution.age
import org.apache.sling.distribution.communication.DistributionRequest;
import org.apache.sling.distribution.communication.DistributionRequestState;
import org.apache.sling.distribution.communication.DistributionResponse;
+import
org.apache.sling.distribution.communication.impl.SimpleDistributionResponse;
import org.apache.sling.distribution.event.DistributionEventType;
import org.apache.sling.distribution.event.impl.DistributionEventFactory;
import org.apache.sling.distribution.packaging.DistributionPackage;
@@ -189,13 +190,13 @@ public class SimpleDistributionAgent imp
Iterable<DistributionQueueItemStatus> states =
queueDistributionStrategy.add(distributionPackage, queueProvider);
for (DistributionQueueItemStatus state : states) {
DistributionRequestState requestState =
getRequestStateFromQueueState(state.getItemState());
- distributionResponses.add(new
DistributionResponse(requestState, state.getItemState().toString()));
+ distributionResponses.add(new
SimpleDistributionResponse(requestState, state.getItemState().toString()));
}
distributionEventFactory.generateAgentPackageEvent(DistributionEventType.AGENT_PACKAGE_QUEUED,
name, distributionPackage.getInfo());
} catch (Exception e) {
log.error("an error happened during dispatching items to the
queue(s)", e);
- distributionResponses.add(new
DistributionResponse(DistributionRequestState.FAILED, e.toString()));
+ distributionResponses.add(new
SimpleDistributionResponse(DistributionRequestState.FAILED, e.toString()));
}
return distributionResponses;
@@ -431,7 +432,7 @@ public class SimpleDistributionAgent imp
}
}
- private class CompositeDistributionResponse extends DistributionResponse {
+ private class CompositeDistributionResponse extends
SimpleDistributionResponse {
private DistributionRequestState state;
@@ -456,6 +457,11 @@ public class SimpleDistributionAgent imp
}
@Override
+ public boolean isSuccessful() {
+ return !DistributionRequestState.FAILED.equals(state);
+ }
+
+ @Override
public DistributionRequestState getState() {
return state;
}
Modified:
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/DefaultDistributor.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/DefaultDistributor.java?rev=1645630&r1=1645629&r2=1645630&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/DefaultDistributor.java
(original)
+++
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/DefaultDistributor.java
Mon Dec 15 12:16:35 2014
@@ -1,3 +1,22 @@
+/*
+ * 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.sling.distribution.communication.impl;
import org.apache.felix.scr.annotations.Component;
@@ -36,14 +55,14 @@ public class DefaultDistributor implemen
DistributionAgent agent =
componentProvider.getComponent(DistributionAgent.class, agentName);
if (agentName == null) {
- return new DistributionResponse(DistributionRequestState.FAILED,
"Agent is not available");
+ return new
SimpleDistributionResponse(DistributionRequestState.FAILED, "Agent is not
available");
}
try {
return agent.execute(resourceResolver, distributionRequest);
} catch (DistributionAgentException e) {
log.error("cannot execute", e);
- return new DistributionResponse(DistributionRequestState.FAILED,
"Cannot execute request");
+ return new
SimpleDistributionResponse(DistributionRequestState.FAILED, "Cannot execute
request");
}
}
}
Added:
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/SimpleDistributionResponse.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/SimpleDistributionResponse.java?rev=1645630&view=auto
==============================================================================
---
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/SimpleDistributionResponse.java
(added)
+++
sling/trunk/contrib/extensions/distribution/core/src/main/java/org/apache/sling/distribution/communication/impl/SimpleDistributionResponse.java
Mon Dec 15 12:16:35 2014
@@ -0,0 +1,51 @@
+/*
+ * 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.sling.distribution.communication.impl;
+
+import org.apache.sling.distribution.communication.DistributionRequestState;
+import org.apache.sling.distribution.communication.DistributionResponse;
+
+/**
+ * Simple implementation of {@link DistributionResponse} where success is
given by not being in FAILED state.
+ *
+ */
+public class SimpleDistributionResponse implements DistributionResponse {
+
+ private final DistributionRequestState state;
+ private final String message;
+
+ public SimpleDistributionResponse(DistributionRequestState state, String
message) {
+
+ this.state = state;
+ this.message = message;
+ }
+
+ public boolean isSuccessful() {
+ return !DistributionRequestState.FAILED.equals(state);
+ }
+
+ public DistributionRequestState getState() {
+ return state;
+ }
+
+ public String getMessage() {
+ return message;
+ }
+}
