summaryrefslogtreecommitdiffstats
path: root/artifactbroker/forwarding/src
diff options
context:
space:
mode:
Diffstat (limited to 'artifactbroker/forwarding/src')
-rw-r--r--artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwarder.java54
-rw-r--r--artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwardingException.java49
-rw-r--r--artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/parameters/ArtifactForwarderParameters.java126
-rw-r--r--artifactbroker/forwarding/src/test/java/org/onap/policy/distribution/forwarding/PolicyDecodingExceptionTest.java44
4 files changed, 273 insertions, 0 deletions
diff --git a/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwarder.java b/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwarder.java
new file mode 100644
index 0000000..7e0d42b
--- /dev/null
+++ b/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwarder.java
@@ -0,0 +1,54 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2018 Ericsson. All rights reserved.
+ * ================================================================================
+ * Licensed 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.forwarding;
+
+import java.util.Collection;
+import org.onap.sdc.api.notification.IArtifactInfo;
+
+/**
+ * Forwards polices.
+ *
+ * <p>To create a Artifact forwarder a class implementing this interface must be created, along with a
+ * concrete sub class of ArtifactForwarderConfigurationParameterGroup to handle configuration
+ * parameters for the Artifact forwarder.
+ */
+public interface ArtifactForwarder {
+
+ /**
+ * Configure the Artifact forwarder.
+ *
+ * <p>This method will be invoked immediately after instantiation in order for the Artifact forwarder
+ * to configure itself.
+ *
+ * @param parameterGroupName the name of the parameter group which contains the configuration
+ * for the Artifact forwarder
+ */
+ void configure(String parameterGroupName);
+
+ /**
+ * Forward the given policies.
+ *
+ * @param policies the policies to forward
+ * @throws ArtifactForwardingException if an error occurs when forwarding the given Artifact
+ */
+ void forward(Collection<IArtifactInfo> artifacts) throws ArtifactForwardingException;
+
+}
diff --git a/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwardingException.java b/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwardingException.java
new file mode 100644
index 0000000..289e5b0
--- /dev/null
+++ b/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwardingException.java
@@ -0,0 +1,49 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2018 Ericsson. All rights reserved.
+ * ================================================================================
+ * Licensed 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.forwarding;
+
+/**
+ * An error has occured when forwarding a policy.
+ */
+public class ArtifactForwardingException extends Exception {
+
+ private static final long serialVersionUID = 3866850096319435806L;
+
+ /**
+ * Construct an instance with the given message.
+ *
+ * @param message the error message
+ */
+ public ArtifactForwardingException(String message) {
+ super(message);
+ }
+
+ /**
+ * Construct an instance with the given message and cause.
+ *
+ * @param message the error message
+ * @param cause the cause
+ */
+ public ArtifactForwardingException(String message, Throwable cause) {
+ super(message, cause);
+ }
+
+}
diff --git a/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/parameters/ArtifactForwarderParameters.java b/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/parameters/ArtifactForwarderParameters.java
new file mode 100644
index 0000000..6221b6e
--- /dev/null
+++ b/artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/parameters/ArtifactForwarderParameters.java
@@ -0,0 +1,126 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2018 Ericsson. All rights reserved.
+ * ================================================================================
+ * Licensed 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.forwarding.parameters;
+
+import org.onap.policy.common.logging.flexlogger.FlexLogger;
+import org.onap.policy.common.logging.flexlogger.Logger;
+import org.onap.policy.common.parameters.GroupValidationResult;
+import org.onap.policy.common.parameters.ParameterGroup;
+import org.onap.policy.common.parameters.ValidationStatus;
+
+/**
+ * Class to hold all the Artifact forwarder parameters.
+ *
+ * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
+ */
+public class ArtifactForwarderParameters implements ParameterGroup {
+
+ private static final Logger LOGGER = FlexLogger.getLogger(ArtifactForwarderParameters.class);
+
+ private String forwarderType;
+ private String forwarderClassName;
+ private String forwarderConfigurationName;
+
+ /**
+ * Constructor for instantiating ArtifactForwarderParameters.
+ *
+ * @param forwarderType the Artifact forwarder type
+ * @param forwarderClassName the Artifact forwarder class name
+ * @param forwarderConfigurationName the name of the configuration for the Artifact forwarder
+ */
+ public ArtifactForwarderParameters(final String forwarderType, final String forwarderClassName,
+ final String forwarderConfigurationName) {
+ this.forwarderType = forwarderType;
+ this.forwarderClassName = forwarderClassName;
+ this.forwarderConfigurationName = forwarderConfigurationName;
+ }
+
+ /**
+ * Return the forwarderType of this ArtifactForwarderParameters instance.
+ *
+ * @return the forwarderType
+ */
+ public String getForwarderType() {
+ return forwarderType;
+ }
+
+ /**
+ * Return the forwarderClassName of this ArtifactForwarderParameters instance.
+ *
+ * @return the forwarderClassName
+ */
+ public String getForwarderClassName() {
+ return forwarderClassName;
+ }
+
+ /**
+ * Return the name of the forwarder configuration of this ArtifactForwarderParameters instance.
+ *
+ * @return the the name of the forwarder configuration
+ */
+ public String getForwarderConfigurationName() {
+ return forwarderConfigurationName;
+ }
+
+ /**
+ * {@inheritDoc}.
+ */
+ @Override
+ public String getName() {
+ return getForwarderType();
+ }
+
+ /**
+ * {@inheritDoc}.
+ */
+ @Override
+ public void setName(final String name) {
+ this.forwarderType = name;
+ }
+
+ /**
+ * {@inheritDoc}.
+ */
+ @Override
+ public GroupValidationResult validate() {
+ final GroupValidationResult validationResult = new GroupValidationResult(this);
+ if (forwarderType == null || forwarderType.trim().length() == 0) {
+ validationResult.setResult("forwarderType", ValidationStatus.INVALID, "must be a non-blank string");
+ }
+ if (forwarderClassName == null || forwarderClassName.trim().length() == 0) {
+ validationResult.setResult("forwarderClassName", ValidationStatus.INVALID,
+ "must be a non-blank string containing full class name of the forwarder");
+ } else {
+ validateArtifactForwarderClass(validationResult);
+ }
+ return validationResult;
+ }
+
+ private void validateArtifactForwarderClass(final GroupValidationResult validationResult) {
+ try {
+ Class.forName(forwarderClassName);
+ } catch (final ClassNotFoundException exp) {
+ LOGGER.trace("Artifact forwarder class not found in classpath", exp);
+ validationResult.setResult("forwarderClassName", ValidationStatus.INVALID,
+ "Artifact forwarder class not found in classpath");
+ }
+ }
+}
diff --git a/artifactbroker/forwarding/src/test/java/org/onap/policy/distribution/forwarding/PolicyDecodingExceptionTest.java b/artifactbroker/forwarding/src/test/java/org/onap/policy/distribution/forwarding/PolicyDecodingExceptionTest.java
new file mode 100644
index 0000000..6ba0ab0
--- /dev/null
+++ b/artifactbroker/forwarding/src/test/java/org/onap/policy/distribution/forwarding/PolicyDecodingExceptionTest.java
@@ -0,0 +1,44 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2018 Ericsson. All rights reserved.
+ * ================================================================================
+ * Licensed 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.forwarding;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+
+public class PolicyDecodingExceptionTest {
+
+ @Test
+ public void testPolicyDecodingExceptionString() {
+ final ArtifactForwardingException policyDecodingException = new ArtifactForwardingException("error message");
+ assertEquals("error message", policyDecodingException.getMessage());
+ }
+
+ @Test
+ public void testPolicyDecodingExceptionStringThrowable() {
+ final Exception cause = new IllegalArgumentException();
+ final ArtifactForwardingException policyDecodingException =
+ new ArtifactForwardingException("error message", cause);
+ assertEquals("error message", policyDecodingException.getMessage());
+ assertEquals(cause, policyDecodingException.getCause());
+ }
+
+}