+++ /dev/null
-<!--
- ============LICENSE_START=======================================================
- Copyright (C) 2019 Nordix Foundation.
- ================================================================================
- 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=========================================================
--->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.onap.policy.common</groupId>
- <artifactId>common-modules</artifactId>
- <version>1.4.0-SNAPSHOT</version>
- </parent>
-
- <artifactId>pdp-common</artifactId>
- <name>${project.artifactId}</name>
- <description>This module contains the common code across all the PDP's in ONAP Policy Framework.</description>
-
- <dependencies>
- <dependency>
- <groupId>org.projectlombok</groupId>
- <artifactId>lombok</artifactId>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.common</groupId>
- <artifactId>utils</artifactId>
- <version>${project.version}</version>
- </dependency>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <scope>test</scope>
- </dependency>
- </dependencies>
-</project>
\ No newline at end of file
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.enums;
-
-/**
- * Class to hold the possible values for health status of PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-public enum PdpHealthStatus {
-
- /**
- * PDP is healthy and working fine.
- */
- HEALTHY,
-
- /**
- * PDP is not healthy.
- */
- NOT_HEALTHY,
-
- /**
- * PDP is currently under test state and performing tests.
- */
- TEST_IN_PROGRESS,
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.enums;
-
-/**
- * Class to hold the possible values for the type of PDP messages.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-public enum PdpMessageType {
-
- /**
- * Used by PDPs to report status to PAP.
- */
- PDP_STATUS,
-
- /**
- * Used by PAP to update the policies running on PDPs, triggers a PDP_STATUS message with the result of the
- * PDP_UPDATE operation.
- */
- PDP_UPDATE,
-
- /**
- * Used by PAP to change the state of PDPs, triggers a PDP_STATUS message with the result of the PDP_STATE_CHANGE
- * operation.
- */
- PDP_STATE_CHANGE,
-
- /**
- * Used by PAP to order a health check on PDPs, triggers a PDP_STATUS message with the result of the
- * PDP_HEALTH_CHECK operation.
- */
- PDP_HEALTH_CHECK,
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.enums;
-
-/**
- * Class to hold the possible values for PDP response status.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-public enum PdpResponseStatus {
-
- /**
- * PDP operation was successful.
- */
- SUCCESS,
-
- /**
- * PDP operation failed.
- */
- FAIL,
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.enums;
-
-/**
- * Class to hold the possible values for state of PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-public enum PdpState {
-
- /**
- * Policy execution is always rejected irrespective of PDP type.
- */
- PASSIVE,
-
- /**
- * Policy execution proceeds, but changes to domain state or context are not carried out. The PDP returns an
- * indication that it is running in SAFE mode together with the action it would have performed if it was operating
- * in ACTIVE mode.
- */
- SAFE,
-
- /**
- * Policy execution proceeds and changes to domain and state are carried out in a test environment. The PDP returns
- * an indication that it is running in TEST mode together with the action it has performed on the test environment.
- */
- TEST,
-
- /**
- * Policy execution is executed in the live environment by the PDP.
- */
- ACTIVE,
-
- /**
- * Policy execution is terminated and not available.
- */
- TERMINATED
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-import org.onap.policy.pdp.common.enums.PdpMessageType;
-
-/**
- * Class to represent the PDP_HEALTH_CHECK message that PAP will send to either PDPGroup/Subgroup or a PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-public class PdpHealthCheck extends PdpMessage {
-
- private String name;
- private String pdpGroup;
- private String pdpSubgroup;
-
- /**
- * Constructor for instantiating PdpHealthCheck class with message name.
- *
- */
- public PdpHealthCheck() {
- super(PdpMessageType.PDP_HEALTH_CHECK);
- }
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-import org.onap.policy.pdp.common.enums.PdpMessageType;
-
-/**
- * Class to represent the base class for various messages that will ve exchanged between PAP and PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-public class PdpMessage {
-
- @Setter(AccessLevel.NONE)
- private PdpMessageType messageName;
- private String requestId;
-
- /**
- * Time-stamp, in milliseconds, when the message was created. Defaults to the current
- * time.
- */
- private long timestampMs = System.currentTimeMillis();
-
- /**
- * Constructor for instantiating PdpMessage class with message name.
- *
- * @param messageName the message name
- */
- public PdpMessage(final PdpMessageType messageName) {
- this.messageName = messageName;
- }
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-import org.onap.policy.pdp.common.enums.PdpResponseStatus;
-
-/**
- * Class to represent PDP response details.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-public class PdpResponseDetails {
-
- // The responseTo field should match the original request id in the request.
- private String responseTo;
- private PdpResponseStatus responseStatus;
- private String responseMessage;
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-import org.onap.policy.pdp.common.enums.PdpMessageType;
-import org.onap.policy.pdp.common.enums.PdpState;
-
-/**
- * Class to represent the PDP_STATE_CHANGE message that PAP will send to either PDPGroup/Subgroup or a PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-public class PdpStateChange extends PdpMessage {
-
- private String name;
- private PdpState state;
- private String pdpGroup;
- private String pdpSubgroup;
-
- /**
- * Constructor for instantiating PdpStateChange class with message name.
- *
- */
- public PdpStateChange() {
- super(PdpMessageType.PDP_STATE_CHANGE);
- }
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-/**
- * Class to represent statistics of a running PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-public class PdpStatistics {
-
- private long policyDownloadCount;
- private long policyDownloadSuccessCount;
- private long policyDownloadFailCount;
- private long policyExecutedCount;
- private long policyExecutedSuccessCount;
- private long policyExecutedFailCount;
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import java.util.List;
-
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-import org.onap.policy.pdp.common.enums.PdpHealthStatus;
-import org.onap.policy.pdp.common.enums.PdpMessageType;
-import org.onap.policy.pdp.common.enums.PdpState;
-
-/**
- * Class to represent the PDP_STATUS message that all the PDP's will send to PAP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-public class PdpStatus extends PdpMessage {
-
- private String name;
- private String version;
- private String pdpType;
- private PdpState state;
- private PdpHealthStatus healthy;
- private String description;
- private String pdpGroup;
- private String pdpSubgroup;
- private List<String> supportedPolicyTypes;
- private List<Policy> policies;
- private String instance;
- private String deploymentInstanceInfo;
- private String properties;
- private PdpStatistics statistics;
- private PdpResponseDetails response;
-
- /**
- * Constructor for instantiating PdpStatus class with message name.
- *
- */
- public PdpStatus() {
- super(PdpMessageType.PDP_STATUS);
- }
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import java.util.List;
-
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-import org.onap.policy.pdp.common.enums.PdpMessageType;
-
-/**
- * Class to represent the PDP_UPDATE message that PAP will send to a PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-public class PdpUpdate extends PdpMessage {
-
- private String name;
- private String pdpType;
- private String description;
- private String pdpGroup;
- private String pdpSubgroup;
- private List<Policy> policies;
-
- /**
- * Constructor for instantiating PdpUpdate class with message name.
- *
- */
- public PdpUpdate() {
- super(PdpMessageType.PDP_UPDATE);
- }
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import lombok.EqualsAndHashCode;
-import lombok.Getter;
-import lombok.Setter;
-import lombok.ToString;
-
-/**
- * Class to represent a policy running in a PDP.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-@Getter
-@Setter
-@ToString
-@EqualsAndHashCode
-public class Policy {
-
- private String name;
- private String policyVersion;
- private String policyType;
- private String policyTypeVersion;
- private String properties;
-}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2019 Nordix Foundation.
- * ================================================================================
- * 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.pdp.common.models;
-
-import com.openpojo.reflection.filters.FilterPackageInfo;
-import com.openpojo.validation.Validator;
-import com.openpojo.validation.ValidatorBuilder;
-import com.openpojo.validation.test.impl.GetterTester;
-import com.openpojo.validation.test.impl.SetterTester;
-
-import org.junit.Test;
-import org.onap.policy.common.utils.validation.ToStringTester;
-
-/**
- * Class to perform unit testing of models.
- *
- * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
- */
-public class TestModels {
-
- private static final String MODELS_PACKAGE = "org.onap.policy.pdp.common.models";
-
- @Test
- public void testStatisticsReport() {
- final Validator validator = ValidatorBuilder.create().with(new ToStringTester()).with(new SetterTester())
- .with(new GetterTester()).build();
- validator.validate(MODELS_PACKAGE, new FilterPackageInfo());
- }
-}
<module>integrity-audit</module>
<module>integrity-monitor</module>
<module>policy-endpoints</module>
- <module>pdp-common</module>
</modules>
<dependencyManagement>
Code Review / policy / common.git / commitdiff