/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.apex.auth.clieditor;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class holds the definition of an argument of a CLI command.
/*
* (non-Javadoc)
- *
+ *
* @see java.lang.Object#toString()
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
if (this == obj) {
return true;
}
-
+
if (obj == null) {
return false;
}
-
+
if (getClass() != obj.getClass()) {
return false;
}
-
+
CommandLineArgument other = (CommandLineArgument) obj;
if (argumentName == null) {
if (other.argumentName != null) {
} else if (!argumentName.equals(other.argumentName)) {
return false;
}
-
+
if (description == null) {
if (other.description != null) {
return false;
} else if (!description.equals(other.description)) {
return false;
}
-
+
return nullable == other.nullable;
}
}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import java.util.ArrayList;
import java.util.List;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class represents a single Apex CLI command that is issued to the Apex Editor Java API
/*
* (non-Javadoc)
- *
+ *
* @see java.lang.Object#toString()
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
if (result != 0) {
return result;
}
-
+
if (!argumentList.equals(otherCommand.argumentList)) {
return (argumentList.hashCode() - otherCommand.argumentList.hashCode());
}
-
+
if (systemCommand != otherCommand.systemCommand) {
return (this.hashCode() - otherCommand.hashCode());
}
-
+
return apiMethod.compareTo(otherCommand.apiMethod);
}
return 1;
}
}
-
+
return 0;
}
if (this == obj) {
return true;
}
-
+
if (obj == null) {
return false;
}
-
+
if (getClass() != obj.getClass()) {
return false;
}
-
+
return this.compareTo((CommandLineCommand) obj) == 0;
}
}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import java.util.TreeMap;
import java.util.TreeSet;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* The Class KeywordNode holds the structure of a command keyword for the Apex CLI editor. The
if (this == obj) {
return true;
}
-
+
if (obj == null) {
return false;
}
-
+
if (getClass() != obj.getClass()) {
return false;
}
-
+
return this.compareTo((KeywordNode) obj) == 0;
}
}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
import org.glassfish.jersey.media.multipart.MultiPartFeature;
import org.glassfish.jersey.server.ResourceConfig;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.glassfish.grizzly.http.server.HttpServer;
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
import org.glassfish.jersey.server.ResourceConfig;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
import org.glassfish.jersey.media.multipart.MultiPartFeature;
import org.glassfish.jersey.server.ResourceConfig;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.glassfish.grizzly.http.server.HttpServer;
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
import org.glassfish.jersey.server.ResourceConfig;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextAlbum;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.context.parameters.ContextParameterConstants;
import org.onap.policy.apex.context.parameters.DistributorParameters;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
-import org.onap.policy.apex.model.utilities.Assertions;
import org.onap.policy.common.parameters.ParameterService;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.context.parameters.ContextParameterConstants;
import org.onap.policy.apex.context.parameters.PersistorParameters;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
-import org.onap.policy.apex.model.utilities.Assertions;
import org.onap.policy.common.parameters.ParameterService;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
throw new ContextRuntimeException(returnString);
}
}
-
+
/* (non-Javadoc)
* @see org.onap.policy.apex.context.SchemaHelper#createNewSubInstance(java.lang.String)
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.service.ModelService;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchemas;
-import org.onap.policy.apex.model.utilities.Assertions;
import org.onap.policy.common.parameters.ParameterService;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.core.engine.engine.impl;
-import static org.onap.policy.apex.model.utilities.Assertions.argumentNotNull;
+import static org.onap.policy.common.utils.validation.Assertions.argumentNotNull;
import java.util.LinkedHashMap;
import java.util.Map;
for (int increment = ApexEngineConstants.STOP_EXECUTION_WAIT_TIMEOUT;
increment > 0; increment -= ApexEngineConstants.APEX_ENGINE_STOP_EXECUTION_WAIT_INCREMENT) {
ThreadUtilities.sleep(ApexEngineConstants.APEX_ENGINE_STOP_EXECUTION_WAIT_INCREMENT);
-
+
synchronized (state) {
switch (state) {
// Engine is OK to stop or has been stopped on return of an event
synchronized (state) {
state = AxEngineState.STOPPED;
}
-
+
throw new ApexException(STOP + key.getId() + "," + state + ", error stopping engine, engine stop timed out");
}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.core.engine.executor;
-import static org.onap.policy.apex.model.utilities.Assertions.argumentOfClassNotNull;
+import static org.onap.policy.common.utils.validation.Assertions.argumentOfClassNotNull;
import java.util.Map;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.eventmodel.concepts.AxEvents;
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
import org.onap.policy.apex.model.policymodel.concepts.AxStateOutput;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is the output of a state, and is used by the engine to decide what the next state for execution is.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.core.engine.executor;
-import static org.onap.policy.apex.model.utilities.Assertions.argumentOfClassNotNull;
+import static org.onap.policy.common.utils.validation.Assertions.argumentOfClassNotNull;
import java.util.Iterator;
import java.util.Map;
/**
* If the input field exists on the output and it is not set in the task, then it should be copied to the output.
- *
+ *
* @param field the input field
*/
private void copyInputField2Output(String field) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.core.engine.executor;
-import static org.onap.policy.apex.model.utilities.Assertions.argumentNotNull;
+import static org.onap.policy.common.utils.validation.Assertions.argumentNotNull;
import org.onap.policy.apex.context.ContextException;
import org.onap.policy.apex.core.engine.ExecutorParameters;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.policymodel.concepts.AxState;
import org.onap.policy.apex.model.policymodel.concepts.AxStateFinalizerLogic;
import org.onap.policy.apex.model.policymodel.concepts.AxTask;
-import org.onap.policy.apex.model.utilities.Assertions;
import org.onap.policy.common.parameters.ParameterService;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import javax.xml.bind.annotation.XmlType;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* An artifact key uniquely identifies every first order entity in the system. Every first order concept in the system
* must have an {@link AxArtifactKey} to identify it. Concepts that are wholly contained in another concept are
* identified using a {@link AxReferenceKey} key.
- *
+ *
* <p>Key validation checks that the name and version fields match the NAME_REGEXP and VERSION_REGEXP
* regular expressions respectively.
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import javax.xml.bind.annotation.XmlType;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is the base class for all Apex concept classes. It enforces implementation of abstract methods and
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxConcept(final AxConcept copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import java.util.Set;
import java.util.TreeSet;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* Implements concept getting from navigable maps.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.apex.model.basicmodel.dao.converters.CDataConditioner;
import org.onap.policy.apex.model.basicmodel.dao.converters.Uuid2String;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* The key information on an {@link AxArtifactKey} key in an Apex policy model. Each {@link AxArtifactKey} must have an
* {@link AxKeyInfo} object. THe information held is the key's UUID and it's description.
- *
+ *
* <p>Validation checks that all fields are defined and that the key is valid. It also observes that descriptions are
* blank and warns if the UUID is a zero UUID.
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import javax.xml.bind.annotation.XmlType;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* The Class AxKeyInformation holds a map of the key information for the entire Apex model. All Apex models
* {@link AxModel} must have an {@link AxKeyInformation} field. The {@link AxKeyInformation} class implements the helper
* methods of the {@link AxConceptGetter} interface to allow {@link AxKeyInfo} instances to be retrieved by calling
* methods directly on this class without referencing the contained map.
- *
+ *
* <p>Validation checks that the key is not null, that the key information map is not empty, that each key and value in
* the map is defined, that the key in each map entry matches the key if each entry value, and that no duplicate UUIDs
* exist. Each key information entry is then validated individually.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import java.util.List;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class records a usage of a key in the system. When the list of keys being used by a concept is built using the
* getKeys() method of the {@link AxConcept} class, an instance of this class is created for every key occurrence. The
* list of keys returned by the getKeys() method is a list of {@link AxKeyUse} objects.
- *
+ *
* <p>Validation checks that each key is valid.
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.apex.model.basicmodel.service.ModelService;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is the base class for all models in Apex. All model classes inherit from this model so all models must
* have a key and have key information.
- *
+ *
* <p>Validation checks that the model key is valid. It goes on to check for null keys and checks each key for
* uniqueness in the model. A check is carried out to ensure that an {@link AxKeyInfo} instance exists for every
* {@link AxArtifactKey} key. For each {@link AxReferenceKey} instance, a check is made that its parent and local name
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import javax.xml.bind.annotation.XmlType;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* A reference key identifies entities in the system that are contained in other entities. Every contained concept in
* the system must have an {@link AxReferenceKey} to identify it. Non-contained first order concepts are identified
* using an {@link AxArtifactKey} key.
- *
+ *
* <p>An {@link AxReferenceKey} contains an {@link AxArtifactKey} key reference to the first order entity that contains
* it. The local name of the reference key must uniquely identify the referenced concept among those concepts contained
* in the reference key's parent. In other words, if a parent concept has more than one child, the local name in the key
* of all its children must be unique.
- *
+ *
* <p>If a reference key's parent is itself a reference key, then the parent's local name must be set in the reference
* key. If the parent is a first order concept, then the parent's local name in the key will be set to NULL.
- *
+ *
* <p>Key validation checks that the parent name and parent version fields match the NAME_REGEXP and
* VERSION_REGEXP regular expressions respectively and that the local name fields match the
* LOCAL_NAME_REGEXP regular expression.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.model.basicmodel.concepts;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* A validation message is created for each validation observation observed during validation of a concept. The message
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.model.basicmodel.dao;
import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.eclipse.persistence.oxm.MediaType;
import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
import org.onap.policy.apex.model.utilities.TextFileUtils;
import org.onap.policy.common.utils.resources.ResourceUtils;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
import org.onap.policy.apex.model.basicmodel.concepts.AxModel;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.eclipse.persistence.oxm.MediaType;
import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
import org.w3c.dom.Document;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is used to define an album of context.
- *
+ *
* <p>A context album is a distributed map of context that will be distributed across all process instances that require
* access to it. This class defines the schema (structure) of the items in the context album, whether the items on the
* context album are writable or not, and what the scope of the context album is.
- *
+ *
* <p>The structure of items (objects) the context album is defined as a schema, which is understood by whatever schema
* implementation is being used for the context album.
- *
+ *
* <p>The scope of a context album is a string field, understood by whatever distribution mechanism is being used for
* the context album. The distribution mechanism uses the scope of the context album to decide to which executable
* entities a given context album is distributed.
- *
+ *
* <p>The writable flag on a context album defines whether users of a context album can write to the context album or
* just read objects from the context album.
- *
+ *
* <p>Validation checks that the album key and the context schema key are not null and that the scope field is not
* undefined and matches the regular expression SCOPE_REGEXP.
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is a context album container and holds a map of the context albums for an entire Apex model. All Apex
* models that use context albums must have an {@link AxContextAlbums} field. The {@link AxContextAlbums} class
* implements the helper methods of the {@link AxConceptGetter} interface to allow {@link AxContextAlbum} instances to
* be retrieved by calling methods directly on this class without referencing the contained map.
- *
+ *
* <p>Validation checks that the container key is not null. An observation is issued if no context albums are defined in
* the container. If context albums do exist, they are checked to ensure that keys and values are not null and that the
* map key matches the key in the map value for all album entries. Each context album entry is then validated
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxModel;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.service.ModelService;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* A container class for an Apex context model. This class is a container class that allows an Apex model to be
* constructed that just contains context and the key information for that context. The model contains schema
* definitions and the definitions of context albums that use those schemas. In the case where Apex context is being
* used without policy or independent of policy, an Apex context model is sufficient to get Apex context working.
- *
+ *
* <p>Validation runs {@link AxModel} validation on the model. In addition, the {@link AxContextSchemas} and
* {@link AxContextAlbums} validation is run on the context schemas and albums in the model.
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.apex.model.basicmodel.dao.converters.CDataConditioner;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class holds a data schema definition in Apex. A data schema describes the structure of a single atom of data
* schema flavour defines the type of schema being defined and the schema itself defines the schema. The schema flavour
* is used by Apex to look up and load a plugin class that understands and interprets the schema definition and can
* create instances of classes for the schema.
- *
+ *
* <p>An {@link AxContextSchema} is used to define each parameter in Apex events, the messages that enter, exit, and are
* passed internally in Apex. In addition, an Apex {@link AxContextAlbum} instances hold a map of
* {@link AxContextSchema} instances to represent the context being managed as an {@link AxContextAlbum}. For example,
* the state of all cells in a mobile network might be represented as an {@link AxContextAlbum} with its
* {@link AxContextSchema} being defined as @code cell} objects.
- *
+ *
* <p>Validation checks that the schema key is not null. It also checks that the schema flavour is defined and matches
* the regular expression SCHEMA_FLAVOUR_REGEXP. Finally, validation checks that the defined schema is not a blank or
* empty string.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is a context schema container and holds a map of the context schemas for an entire Apex model. All Apex
* models that use context schemas must have an {@link AxContextSchemas} field. The {@link AxContextSchemas} class
* implements the helper methods of the {@link AxConceptGetter} interface to allow {@link AxContextSchema} instances to
* be retrieved by calling methods directly on this class without referencing the contained map.
- *
+ *
* <p>Validation checks that the container key is not null. An error is issued if no context schemas are defined in the
* container. Each context schema entry is checked to ensure that its key and value are not null and that the key
* matches the key in the map value. Each context schema entry is then validated individually.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.contextmodel.concepts.AxContextAlbums;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextModel;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchemas;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* A container class for an Apex engine model. This class is a container class that allows an Apex
* is used by an Apex engine to pass its current execution state to any system that wishes to query
* that information. The time stamp of the engine model is the time at which the state and
* statistics of the engine were read.
- *
+ *
* <p>Validation checks that the current state {@link AxEngineState} is defined and that the time stamp
* is set on the engine model.
*/
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxEngineModel(final AxEngineModel copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is a java bean that is used to record statistics on Apex engines as they execute.
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxEngineStats(final AxEngineStats copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class defines an Apex event. An {@link AxEvent} is used to kick off execution of policies in Apex and is emitted
* by policies when they completer execution. In addition, Apex uses {@link AxEvent} instances internally to pass
* control from one Apex state to the next during execution.
- *
+ *
* <p>The {@link AxArtifactKey} of an event uniquely identifies it in an Apex system and the name field in the key is
* the name of the event.
- *
+ *
* <p>Each {@link AxEvent} has a name space, which is usually set to identify the domain of application of an event. For
* example a 4G cell power event might have the name space {@code org.onap.radio.4g} and the name {@code PowerEvent}.
* The source and target of the event are reserved to hold an identifier that defines the sender and receiver of an
* event respectively. The definition and structure of these fields is reserved for future use and their use by
* applications is currently not recommended.
- *
+ *
* <p>The parameters that an event has are defined as a map of {@link AxField} instances.
- *
+ *
* <p>Validation checks that the event key is valid. If name space is a blank string, a warning is issued. Blank source
* or target fields result in observations being issued. An event may not have any parameters. If it has parameters, the
* name and value of each parameter entry is checked to ensure they are not null. Then the local name of each parameter
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.service.ModelService;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchemas;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* A container class for an Apex event model. This class is a container class that allows an Apex model to be
* constructed that contains events and context and the key information for those events and context. The model contains
* schema definitions and the definitions of events that use those schemas.
- *
+ *
* <p>Validation runs {@link AxModel} validation on the model. In addition, the {@link AxContextSchemas} and
* {@link AxEvents} validation is run on the context schemas and events in the model.
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is an event container and holds a map of the events for an entire Apex model. All Apex models that use
* events must have an {@link AxEvents} field. The {@link AxEvents} class implements the helper methods of the
* {@link AxConceptGetter} interface to allow {@link AxEvents} instances to be retrieved by calling methods directly on
* this class without referencing the contained map.
- *
+ *
* <p>Validation checks that the container key is not null. An error is issued if no events are defined in the
* container. Each event entry is checked to ensure that its key and value are not null and that the key matches the key
* in the map value. Each event entry is then validated individually.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.apex.model.basicmodel.xml.AxReferenceKeyAdapter;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* In Apex, a field is an input or output parameter to or from a concept. For example, the parameters of an event are
* fields and the input and output of a task is defined as a collection of fields.
- *
+ *
* <p>A field has an {@link AxReferenceKey} key that defines its name and parent, and a {@link AxArtifactKey} key to a
* context schema that defines the structure of the data atom that holds the value of the field. Fields can be specified
* as being optional but are mandatory by default.
- *
+ *
* <p>Validation checks that the field key and the field schema reference key are not null.
*/
@Entity
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
import org.onap.policy.apex.model.modelapi.ApexApiResult;
import org.onap.policy.apex.model.modelapi.ApexModel;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class acts as a facade for operations towards a policy model for context schema operations.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
import org.onap.policy.apex.model.modelapi.ApexApiResult;
import org.onap.policy.apex.model.modelapi.ApexModel;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class acts as a facade for operations towards a policy model for event operations
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.modelapi.ApexApiResult;
import org.onap.policy.apex.model.modelapi.ApexModel;
import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class acts as a facade for operations towards a policy model.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.policymodel.handling.PolicyModelComparer;
import org.onap.policy.apex.model.policymodel.handling.PolicyModelMerger;
import org.onap.policy.apex.model.policymodel.handling.PolicyModelSplitter;
-import org.onap.policy.apex.model.utilities.Assertions;
import org.onap.policy.apex.model.utilities.TextFileUtils;
import org.onap.policy.common.utils.resources.ResourceUtils;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
import org.onap.policy.apex.model.policymodel.concepts.AxStateTaskReference;
import org.onap.policy.apex.model.policymodel.concepts.AxTask;
import org.onap.policy.apex.model.policymodel.concepts.AxTaskSelectionLogic;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class acts as a facade for operations towards a policy model for policy operations.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.policymodel.concepts.AxTask;
import org.onap.policy.apex.model.policymodel.concepts.AxTaskLogic;
import org.onap.policy.apex.model.policymodel.concepts.AxTaskParameter;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class acts as a facade for operations towards a policy model for task operations.
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.apex.model.basicmodel.dao.converters.CDataConditioner;
import org.onap.policy.apex.model.basicmodel.xml.AxReferenceKeyAdapter;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class holds Logic for executing a task or task selection on an Apex policy state. The flavour of the logic
* executes it. In the Apex engine, executors are deployed as plugins. Apex also provides the executor with run-time
* context, which makes context such as input fields, output fields, and context albums available to the task at
* runtime.
- *
+ *
* <p>Validation checks that the logic key is valid, that the logic flavour is defined and is valid when checked against
* the {@code LOGIC_FLAVOUR_REGEXP} regular expression, and that the specified logic string is not null or blank.
*/
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxLogic(final AxLogic copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is a policy container and holds a map of the policies for an entire Apex model. All Apex models that use
* policies must have an {@link AxPolicies} field. The {@link AxPolicies} class implements the helper methods of the
* {@link AxConceptGetter} interface to allow {@link AxPolicy} instances to be retrieved by calling methods directly on
* this class without referencing the contained map.
- *
+ *
* <p>Validation checks that the container key is not null. An error is issued if no policies are defined in the
* container. Each policy entry is checked to ensure that its key and value are not null and that the key matches the
* key in the map value. Each policy entry is then validated individually.
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxPolicies(final AxPolicies copyConcept) {
/*
* (non-Javadoc)
- *
+ *
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKey()
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKeys()
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#validate(org.onap.policy.apex.model.
* basicmodel.concepts.AxValidationResult)
*/
/*
* (non-Javadoc)
- *
+ *
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean()
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString()
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode()
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object)
*/
@Override
/*
* (non-Javadoc)
- *
+ *
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
* {@link AxState} instance. The states of a policy are held in a map in the policy. The state tree is built up at
* policy design time by a policy editor and each state is connected to its next state by an {@link AxStateOutput}
* instance.
- *
+ *
* <p>Execution of a policy is triggered by an event. A policy starts execution from its first state so the trigger
* event for the first sate is the trigger event for the entire policy. Execution from that first state can continue to
* one or more subsequent states and so on down branches of states. The state output of the final state in a branch has
* in the policy are the possible set of output events on the policy. A state may only be used once in the state tree of
* a policy and recursive execution of states in the same execution branch is not allowed, so the same state may not
* execute more than once on a single execution of a policy.
- *
+ *
* <p>The template of a policy is a string that can be used by policy editors to store meta information on the policy
* that can be used at design time. The policy template string is not used during policy execution.
- *
+ *
* <p>During validation of a policy, the validation checks listed below are executed: <ol> <li>The policy key must not
* be a null key <li>The policy key must be valid <li>If the policy template is not set, an observation is issued <li>At
* least one state must be defined <li>Keys and values must all be defined, that is not null <li>The key on each entry
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxPolicy(final AxPolicy copyConcept) {
/**
* Validate a state entry.
- *
+ *
* @param stateEntry the state entry to validate
* @param result The validation result to append to
* @return The result of the validation
/**
* Validate a state tree to ensure there are no circular references in it.
- *
+ *
* @param result The validation result to append to
* @return The result of the validation
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
import org.onap.policy.apex.model.eventmodel.concepts.AxEvents;
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* A container class for an Apex policy model. This class is a container class that allows an Apex
* required to run policies in Apex. The model contains schema definitions, definitions of events
* and context albums that use those schemas, definitions of tasks for policies and definitions of
* the policies themselves.
- *
+ *
* <p>An Apex policy model is an important artifact in Apex. At editing time, an Apex editor creates
* and edits a policy model and a policy model is loaded into and is executed by an Apex engine.
* Therefore, an Apex model and the set of policies that it holds is the way that the policy domain
* that an Apex engine or a group of Apex engines executes across is expressed, both at design time
* and run time. The Apex deployment system is responsible for deploying Apex models to and the
* context they need the appropriate engines for execution.
- *
+ *
* <p>Model registration is carried out by calling the {@code register()} method, which registers the
* policy model and all its constituent containers with the model service. The containers for
* context schemas, events, context albums, tasks, policies, and key information are all registered.
- *
+ *
* <p>Once a policy model is composed, the overall structure of the policy model and all its references
* can be validated. During validation of a policy model, the validation checks listed below are
* executed:
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxPolicyModel(final AxPolicyModel copyConcept) {
/**
* Validate all fundamental concepts keyed in tasks exist.
- *
+ *
* @param task The task to validate the keys of
* @param result the validation result to return
* @return the result
/**
* Validate that the references used on a state are valid.
- *
+ *
* @param state The state to check
* @param result the validation result to append to
*/
/**
* Validate that the fields on tasks and events that trigger them and are output by them are
* compatible for all tasks used on a state.
- *
+ *
* @param state The state to check
* @param result the validation result to append to
*/
/**
* Validate that the fields on a task of a state output and the events that trigger it are
* compatible.
- *
+ *
* @param state The state to check
* @param task The task to check
* @param stateOutput The state output to check
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2018 Samsung Electronics Co., Ltd.
+ * Modifications 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.
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class holds the definition of a single state in a policy. A state is a single stage in a policy. A state has a
/**
* Compare the object fields on this state to another state.
- *
+ *
* @param the other state to compare with
- * @return the result of the comparison
+ * @return the result of the comparison
*/
private int compareObjectFields(final AxState other) {
if (!key.equals(other.key)) {
if (!taskReferenceMap.equals(other.taskReferenceMap)) {
return (taskReferenceMap.hashCode() - other.taskReferenceMap.hashCode());
}
-
+
return 0;
}
}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class defines a single output that a state can have. A state can have many outputs with each
* state output is selected. If no next state is defined (the next state is a null
* {@link AxReferenceKey} key), then this state output outputs its event to an external system and
* is an output state for the full policy.
- *
+ *
* <p>During validation of a state output, the validation checks listed below are executed:
* <ol>
* <li>The state output key must not be a null key and must be valid, see validation in
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxStateOutput(final AxStateOutput copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class defines the type of output handling that will be used when a task in a state completes
* case of {@link AxStateTaskOutputType#LOGIC} output selection, the output reference key held in
* this {@link AxStateTaskReference} instance to an instance of an {@link AxStateFinalizerLogic}
* class. See the explanation in the {@link AxState} class for a full description of this handling.
- *
+ *
* <p>During validation of a state task reference, the validation checks listed below are executed:
* <ol>
* <li>The state task reference key must not be a null key and must be valid, see validation in
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxStateTaskReference(final AxStateTaskReference copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import java.util.TreeSet;
import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* The Class is used to return the tree that represents the state branches or chains in a policy. It
* creates a tree that holds the state fan out branches in a policy that starts from the given top
* state of the tree. Each branch from a state is held in a set of next states for the top state and
* each branch in the state tree is itself a {@link AxStateTree} instance.
- *
+ *
* <p>Validation checks for recursive state use, in other words validation forbids the use of a given
* state more than once in a state tree.
*/
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
import org.onap.policy.apex.model.eventmodel.concepts.AxInputField;
import org.onap.policy.apex.model.eventmodel.concepts.AxOutputField;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class holds the definition of a task in Apex. A task is executed by a state and performs
* some domain specific logic to carry out work required to be done by a policy. The Task Logic that
* is executed by a task is held in a {@link AxTaskLogic} instance.
- *
+ *
* <p>A task has a set of input fields and output fields, which are passed to and are emitted from the
* task during a task execution cycle. A task may have task parameters {@link AxTaskParameter},
* which are configuration values passed to a task at initialization time.
- *
+ *
* <p>The Task Logic in a task may use information in context albums to perform their domain specific
* work. The context albums that the task uses and that should be made available to the task by Apex
* policy distribution are held as a set of references to context albums in the task.
- *
+ *
* <p>During validation of a task, the validation checks listed below are executed:
* <ol>
* <li>The task key must not be a null key and must be valid, see validation in
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxTask(final AxTask copyConcept) {
/**
* Validate a field.
- *
+ *
* @param key the key of the field to validate
* @param field the field to validate
* @param direction The direction of the field
/**
* Validate a task parameter entry.
- *
+ *
* @param taskParameterEntry the task parameter entry to validate
* @param result The validation result to append to
* @return The result of the validation
/**
* Validate a context album reference entry.
- *
+ *
* @param taskParameterEntry the context album reference entry to validate
* @param result The validation result to append to
* @return The result of the validation
}
copy.setContextAlbumReferences(newContextUsage);
- copy.setTaskLogic(new AxTaskLogic((AxLogic) taskLogic));
+ copy.setTaskLogic(new AxTaskLogic(taskLogic));
return copy;
}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is used to specify the configuration parameters that may be passed to a task
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxTaskParameter(final AxTaskParameter copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is a task container and holds a map of the tasks for an entire Apex model. All Apex
* models that use tasks must have an {@link AxTasks} field. The {@link AxTasks} class implements
* the helper methods of the {@link AxConceptGetter} interface to allow {@link AxTask} instances to
* be retrieved by calling methods directly on this class without referencing the contained map.
- *
+ *
* <p>Validation checks that the container key is not null. An error is issued if no tasks are defined
* in the container. Each task entry is checked to ensure that its key and value are not null and
* that the key matches the key in the map value. Each task entry is then validated individually.
/**
* Copy constructor.
- *
+ *
* @param copyConcept the concept to copy from
*/
public AxTasks(final AxTasks copyConcept) {
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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=========================================================
*/
import org.onap.policy.apex.model.policymodel.concepts.AxState;
import org.onap.policy.apex.model.policymodel.concepts.AxStateOutput;
import org.onap.policy.apex.model.policymodel.concepts.AxTask;
-import org.onap.policy.apex.model.utilities.Assertions;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* This class analyses a policy model and shows what the usage of each context album, context item, data type, and event
+++ /dev/null
-/*
- * ============LICENSE_START=======================================================
- * Copyright (C) 2016-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.apex.model.utilities;
-
-import org.slf4j.ext.XLogger;
-import org.slf4j.ext.XLoggerFactory;
-
-/**
- * The Class Assertions is a template class that is used as a shorthand for assertions in the source code.
- *
- * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
- * @author Liam Fallon (liam.fallon@ericsson.com)
- */
-public final class Assertions {
- // Logger for this class
- private static final XLogger LOGGER = XLoggerFactory.getXLogger(Assertions.class);
-
- /**
- * Private constructor used to prevent sub class instantiation.
- */
- private Assertions() {
- }
-
- /**
- * Gets the validation message for a string parameter.
- *
- * @param parameterName the string parameter name
- * @param parameterValue the string parameter value
- * @param pattern The regular expression
- * @return null if the parameter is valid, the validation message otherwise
- */
- public static String getStringParameterValidationMessage(final String parameterName, final String parameterValue,
- final String pattern) {
- try {
- validateStringParameter(parameterName, parameterValue, pattern);
- } catch (IllegalArgumentException e) {
- String message = "parameter " + parameterName + " with value " + parameterValue
- + " does not match regular expression " + pattern;
- if (LOGGER.isTraceEnabled()) {
- LOGGER.trace(message, e);
- }
-
- return message;
- }
-
- return null;
- }
-
- /**
- * Checks if a string parameter matches a regular expression.
- *
- * @param parameterName the string parameter name
- * @param parameterValue the string parameter value
- * @param pattern The regular expression
- * @return the trimmed string
- */
- public static String validateStringParameter(final String parameterName, final String parameterValue,
- final String pattern) {
- argumentNotNull(parameterName, "parameter name is null");
- argumentNotNull(parameterValue, "parameter \"" + parameterName + "\" is null");
- argumentNotNull(pattern, "parameter pattern is null");
-
- final String trimmedValue = parameterValue.trim();
- if (trimmedValue.matches(pattern)) {
- return trimmedValue;
- } else {
- throw new IllegalArgumentException("parameter \"" + parameterName + "\": value \"" + parameterValue
- + "\", does not match regular expression \"" + pattern + "\"");
- }
- }
-
- /**
- * Used as a shorthand to check that method arguments are not null, throws IllegalArgumentException on error.
- *
- * @param <T> the generic type of the argument to check
- * @param value the value of the type
- * @param message the error message to issue
- */
- public static <T> void argumentNotNull(final T value, final String message) {
- if (value == null) {
- throw new IllegalArgumentException(message);
- }
- }
-
- /**
- * Used as a shorthand to check that method arguments are not false, throws IllegalArgumentException on error.
- *
- * @param value the value to check if false
- * @param message the error message to issue
- */
- public static void argumentNotFalse(final boolean value, final String message) {
- if (!value) {
- throw new IllegalArgumentException(message);
- }
- }
-
- /**
- * Used as a shorthand to check that method arguments are not null, throws an exception of the specified type on
- * error.
- *
- * @param <T> the generic type of the argument to check
- * @param <E> the exception to throw if incoming value is null
- * @param value the value of the type
- * @param exceptionClass the class of exception to return an instance of
- * @param message the error message to issue
- * @throws E an instance of the passed Exception Class
- */
- public static <T, E extends Exception> void argumentOfClassNotNull(final T value, final Class<E> exceptionClass,
- final String message) throws E {
- if (value == null) {
- // Instantiate the exception and throw it
- try {
- throw exceptionClass.getConstructor(String.class).newInstance(message);
- } catch (final Exception errorException) {
- throw new IllegalArgumentException(message, errorException);
- }
- }
- }
-
- /**
- * Used as a shorthand to check that method argument is not false, throws an exception of the specified type on
- * error.
- *
- * @param <E> the exception to throw if incoming value is false
- * @param value the value to check if false
- * @param exceptionClass the class of exception to return an instance of
- * @param message the error message to issue
- * @throws E an instance of the passed Exception Class
- */
- public static <E extends Exception> void argumentOfClassNotFalse(final boolean value, final Class<E> exceptionClass,
- final String message) throws E {
- if (!value) {
- // Instantiate the exception and throw it
- try {
- throw exceptionClass.getConstructor(String.class).newInstance(message);
- } catch (final Exception errorException) {
- throw new IllegalArgumentException(message, errorException);
- }
- }
- }
-
- /**
- * Used as a shorthand to check that an object is an instance of a given class, throws IllegalArgumentException on
- * error.
- *
- * @param <T> the generic type of the argument to check
- * @param objectInstance the object instance for which to check the class
- * @param requiredClass the class that the object should be an instance of
- * @throws IllegalArgumentException if the incoming object is not an instance of requiredClass
- */
- public static <T> void instanceOf(final Object objectInstance, final Class<T> requiredClass) {
- if (!requiredClass.isAssignableFrom(objectInstance.getClass())) {
- throw new IllegalArgumentException(objectInstance.getClass().getCanonicalName() + " is not an instance of "
- + requiredClass.getCanonicalName());
- }
- }
-
- /**
- * Used as a shorthand to check that an instance of a class can be an instance of a given class, throws
- * IllegalArgumentException on error.
- *
- * @param <T> the generic type of the argument to check
- * @param checkClass the class to check
- * @param requiredClass the class that the object should be an instance of
- * @throws IllegalArgumentException if the incoming object is not an instance of requiredClass
- */
- public static <T> void assignableFrom(final Class<?> checkClass, final Class<T> requiredClass) {
- if (!requiredClass.isAssignableFrom(checkClass)) {
- throw new IllegalArgumentException(checkClass.getCanonicalName() + " is not an instance of "
- + requiredClass.getCanonicalName());
- }
- }
-}
+++ /dev/null
-/*
- * ============LICENSE_START=======================================================
- * Copyright (C) 2016-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.apex.model.utilities;
-
-import static org.junit.Assert.assertEquals;
-
-import org.junit.Test;
-import org.onap.policy.apex.model.utilities.Assertions;
-
-/**
- * The Class ResourceUtilsTest.
- *
- * @author Liam Fallon (liam.fallon@ericsson.com)
- */
-public class AssertionsTest {
- @Test
- public void testAssertions() {
- Assertions.argumentNotFalse(true, "it is true");
-
- try {
- Assertions.argumentNotFalse(false, "it is false");
- } catch (IllegalArgumentException e) {
- assertEquals("it is false", e.getMessage());
- }
-
- Assertions.argumentOfClassNotFalse(true, ArithmeticException.class, "it is true");
-
- try {
- Assertions.argumentOfClassNotFalse(false, ArithmeticException.class, "it is false");
- } catch (Exception e) {
- assertEquals("it is false", e.getMessage());
- }
-
- Assertions.argumentNotNull("Hello", "it is OK");
-
- try {
- Assertions.argumentNotNull(null, "it is null");
- } catch (IllegalArgumentException e) {
- assertEquals("it is null", e.getMessage());
- }
-
- Assertions.argumentOfClassNotNull(true, ArithmeticException.class, "it is OK");
-
- try {
- Assertions.argumentOfClassNotNull(null, ArithmeticException.class, "it is null");
- } catch (Exception e) {
- assertEquals("it is null", e.getMessage());
- }
-
- Assertions.assignableFrom(java.util.TreeMap.class, java.util.Map.class);
-
- try {
- Assertions.assignableFrom(java.util.Map.class, java.util.TreeMap.class);
- } catch (IllegalArgumentException e) {
- assertEquals("java.util.Map is not an instance of java.util.TreeMap", e.getMessage());
- }
-
- Assertions.instanceOf("Hello", String.class);
-
- try {
- Assertions.instanceOf(100, String.class);
- } catch (IllegalArgumentException e) {
- assertEquals("java.lang.Integer is not an instance of java.lang.String", e.getMessage());
- }
-
- Assertions.validateStringParameter("name", "MyName", "^M.*e$");
-
- try {
- Assertions.validateStringParameter("name", "MyName", "^M.*f$");
- } catch (IllegalArgumentException e) {
- assertEquals("parameter \"name\": value \"MyName\", does not match regular expression \"^M.*f$\"",
- e.getMessage());
- }
- }
-}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.plugins.executor.mvel;
-import static org.onap.policy.apex.model.utilities.Assertions.argumentNotNull;
+import static org.onap.policy.common.utils.validation.Assertions.argumentNotNull;
import java.io.Serializable;
import java.util.HashMap;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.plugins.executor.mvel;
-import static org.onap.policy.apex.model.utilities.Assertions.argumentNotNull;
+import static org.onap.policy.common.utils.validation.Assertions.argumentNotNull;
import java.io.Serializable;
import java.util.HashMap;
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * Modifications 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.
package org.onap.policy.apex.plugins.executor.mvel;
-import static org.onap.policy.apex.model.utilities.Assertions.argumentNotNull;
+import static org.onap.policy.common.utils.validation.Assertions.argumentNotNull;
import java.io.Serializable;
import java.util.HashMap;
import org.onap.policy.apex.context.impl.distribution.DistributorFactory;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextModel;
-import org.onap.policy.apex.model.utilities.Assertions;
import org.onap.policy.apex.testsuites.integration.context.concepts.TestContextLongItem;
import org.onap.policy.apex.testsuites.integration.context.factory.TestContextAlbumFactory;
import org.onap.policy.apex.testsuites.integration.context.lock.modifier.AlbumModifier;
import org.onap.policy.apex.testsuites.integration.context.lock.modifier.LockType;
+import org.onap.policy.common.utils.validation.Assertions;
/**
* The Class ConfigrationProviderImpl provides configuration information for a context test back to the caller.
Code Review / policy / apex-pdp.git / commitdiff