gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.service.parameters.eventprotocol;
  22
  23 import org.onap.policy.common.parameters.GroupValidationResult;
  24 import org.onap.policy.common.parameters.ValidationStatus;
  25
  26 /**
  27  * An event protocol parameter class for token delimited textual event protocols that may be specialized by event
  28  * protocol plugins that require plugin specific parameters.
  29  *
  30  * <p>The following parameters are defined:
  31  * <ol>
  32  * <li>startDelimiterToken: the token string that delimits the start of text blocks that contain events.
  33  * <li>endDelimiterToken: the token string that delimits the end of text blocks that contain events, this parameter is
  34  * optional and defaults to null.
  35  * <li>delimiterAtStart: indicates if the first text block should have a delimiter at the start (true), or whether
  36  * processing of the first block should begin at the start of the text (false). The parameter is optional and defaults
  37  * to true.
  38  * </ol>
  39  *
  40  * @author Liam Fallon (liam.fallon@ericsson.com)
  41  */
  42 public abstract class EventProtocolTextTokenDelimitedParameters extends EventProtocolParameters {
  43     // The delimiter token for text blocks
  44     private String startDelimiterToken = null;
  45     private String endDelimiterToken = null;
  46     private boolean delimiterAtStart = true;
  47
  48     /**
  49      * Constructor to create an event protocol parameters instance with the name of a sub class of this class.
  50      *
  51      * @param parameterClassName
  52      *        the class name of a sub class of this class
  53      */
  54     public EventProtocolTextTokenDelimitedParameters(final String parameterClassName) {
  55         super(parameterClassName);
  56     }
  57
  58     /**
  59      * Gets the start delimiter token that delimits events in the text.
  60      *
  61      * @return the start delimiter token
  62      */
  63     public String getStartDelimiterToken() {
  64         return startDelimiterToken;
  65     }
  66
  67     /**
  68      * Sets the start delimiter token that delimits events in the text.
  69      *
  70      * @param startDelimiterToken
  71      *        delimiterToken the delimiter token
  72      */
  73     public void setStartDelimiterToken(final String startDelimiterToken) {
  74         this.startDelimiterToken = startDelimiterToken;
  75     }
  76
  77     /**
  78      * Gets the end delimiter token that delimits events in the text.
  79      *
  80      * @return the end delimiter token
  81      */
  82     public String getEndDelimiterToken() {
  83         return endDelimiterToken;
  84     }
  85
  86     /**
  87      * Sets the end delimiter token that delimits events in the text.
  88      *
  89      * @param endDelimiterToken
  90      *        delimiterToken the delimiter token
  91      */
  92     public void setEndDelimiterToken(final String endDelimiterToken) {
  93         this.endDelimiterToken = endDelimiterToken;
  94     }
  95
  96     /**
  97      * Check if there must be a delimiter at the start of the first text block.
  98      *
  99      * @return true if there must be a delimiter at the start of the text block
 100      */
 101     public boolean isDelimiterAtStart() {
 102         return delimiterAtStart;
 103     }
 104
 105     /**
 106      * Sets if there has to be a delimiter at the start of the first text block.
 107      *
 108      * @param delimiterAtStart
 109      *        true if there must be a delimiter at the start of the text block
 110      */
 111     public void setDelimiterAtStart(boolean delimiterAtStart) {
 112         this.delimiterAtStart = delimiterAtStart;
 113     }
 114
 115     @Override
 116     public String toString() {
 117         return "EventProtocolTextTokenDelimitedParameters [startDelimiterToken=" + startDelimiterToken
 118                         + ", endDelimiterToken=" + endDelimiterToken + ", delimiterAtStart=" + delimiterAtStart + "]";
 119     }
 120
 121     /*
 122      * (non-Javadoc)
 123      *
 124      * @see org.onap.policy.apex.service.parameters.ApexParameterValidator#validate()
 125      */
 126     @Override
 127     public GroupValidationResult validate() {
 128         final GroupValidationResult result = super.validate();
 129
 130         if (startDelimiterToken == null || startDelimiterToken.length() == 0) {
 131             result.setResult("startDelimiterToken", ValidationStatus.INVALID,
 132                             "text start delimiter token not specified or is blank\n");
 133         }
 134
 135         return result;
 136     }
 137 }