fineract-provider/src/main/java/org/apache/fineract/infrastructure/hooks/processor/WebHookService.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 org.apache.fineract.infrastructure.hooks.processor;

import java.util.Map;

import org.apache.fineract.infrastructure.hooks.processor.data.SmsProviderData;

import retrofit.Callback;
import retrofit.client.Response;
import retrofit.http.Body;
import retrofit.http.FieldMap;
import retrofit.http.FormUrlEncoded;
import retrofit.http.GET;
import retrofit.http.Header;
import retrofit.http.POST;

import com.google.gson.JsonObject;

public interface WebHookService {

	final static String ENTITY_HEADER = "X-Fineract-Entity";
	final static String ACTION_HEADER = "X-Fineract-Action";
	final static String TENANT_HEADER = "Fineract-Platform-TenantId";
	final static String ENDPOINT_HEADER = "X-Fineract-Endpoint";
	final static String API_KEY_HEADER = "X-Fineract-API-Key";

	// Ping
	@GET("/")
	Response sendEmptyRequest();

	// Template - Web
	@POST("/")
	void sendJsonRequest(@Header(ENTITY_HEADER) String entityHeader,
			@Header(ACTION_HEADER) String actionHeader,
			@Header(TENANT_HEADER) String tenantHeader,
			@Header(ENDPOINT_HEADER) String endpointHeader,
			@Body JsonObject result, Callback<Response> callBack);

	@FormUrlEncoded
	@POST("/")
	void sendFormRequest(@Header(ENTITY_HEADER) String entityHeader,
			@Header(ACTION_HEADER) String actionHeader,
			@Header(TENANT_HEADER) String tenantHeader,
			@Header(ENDPOINT_HEADER) String endpointHeader,
			@FieldMap Map<String, String> params, Callback<Response> callBack);

	// Template - SMS Bridge
	@POST("/")
	void sendSmsBridgeRequest(@Header(ENTITY_HEADER) String entityHeader,
			@Header(ACTION_HEADER) String actionHeader,
			@Header(TENANT_HEADER) String tenantHeader,
			@Header(API_KEY_HEADER) String apiKeyHeader,
			@Body JsonObject result, Callback<Response> callBack);

	@POST("/configuration")
	String sendSmsBridgeConfigRequest(@Body SmsProviderData config);

}