services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextTokenDelimitedParameters.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.service.parameters.eventprotocol;
  23
  24 import lombok.AccessLevel;
  25 import lombok.Getter;
  26 import lombok.NoArgsConstructor;
  27 import lombok.Setter;
  28 import lombok.ToString;
  29 import org.onap.policy.common.parameters.annotations.NotBlank;
  30 import org.onap.policy.common.parameters.annotations.NotNull;
  31
  32 /**
  33  * An event protocol parameter class for token delimited textual event protocols that may be specialized by event
  34  * protocol plugins that require plugin specific parameters.
  35  *
  36  * <p>The following parameters are defined:
  37  * <ol>
  38  * <li>startDelimiterToken: the token string that delimits the start of text blocks that contain events.
  39  * <li>endDelimiterToken: the token string that delimits the end of text blocks that contain events, this parameter is
  40  * optional and defaults to null.
  41  * <li>delimiterAtStart: indicates if the first text block should have a delimiter at the start (true), or whether
  42  * processing of the first block should begin at the start of the text (false). The parameter is optional and defaults
  43  * to true.
  44  * </ol>
  45  *
  46  * @author Liam Fallon (liam.fallon@ericsson.com)
  47  */
  48 @Getter
  49 @Setter
  50 @ToString
  51 @NoArgsConstructor(access = AccessLevel.PROTECTED)
  52 public abstract class EventProtocolTextTokenDelimitedParameters extends EventProtocolParameters {
  53     // The delimiter token for text blocks
  54     private @NotNull @NotBlank String startDelimiterToken = null;
  55     private String endDelimiterToken = null;
  56     private boolean delimiterAtStart = true;
  57 }