com.fnproject.fn.testing.FnEventBuilder Maven / Gradle / Ivy
/*
* Copyright (c) 2019, 2020 Oracle and/or its affiliates. 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.
*/
package com.fnproject.fn.testing;
import java.io.IOException;
import java.io.InputStream;
/**
* Builder for function input events
*/
public interface FnEventBuilder {
/**
* Add a header to the input with a variable number of values; duplicate headers will be overwritten
*
* @param key header key
* @param value header value(s)
* @return an event builder
*/
FnEventBuilder withHeader(String key, String value);
/**
* Set the body of the request by providing an InputStream
*
* Note - setting the body to an input stream means that only one event can be enqueued using this builder.
*
* @param body the bytes of the body
* @return an event builder
*/
FnEventBuilder withBody(InputStream body) throws IOException;
/**
* Set the body of the request as a byte array
*
* @param body the bytes of the body
* @return an event builder
*/
FnEventBuilder withBody(byte[] body);
/**
* Set the body of the request as a String
*
* @param body the String of the body
* @return an event builder
*/
FnEventBuilder withBody(String body);
/**
* Consume the builder and enqueue this event to be passed into the function when it is run
*
* @return The original testing rule. The builder is consumed.
* @throws IllegalStateException if this event has already been enqueued and the event input can only be read once.
*/
// FnTestingRule enqueue();
T enqueue();
/**
* Consume the builder and enqueue multiple copies of this event.
*
* Note that if the body of the event has been set to an input stream this will fail with an
* {@link IllegalStateException}.
*
* @param n number of copies of the event to enqueue
* @return The original testing rule. The builder is consumed.
* @throws IllegalStateException if the body cannot be read multiple times.
*/
// FnTestingRule enqueue(int n);
T enqueue(int n);
}