platform/southbound/http/http-device/src/main/java/org/eclipse/sensinact/gateway/sthbnd/http/task/HttpUnsubscribingTask.java

/*
* Copyright (c) 2020 Kentyou.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
*    Kentyou - initial API and implementation
 */
package org.eclipse.sensinact.gateway.sthbnd.http.task;

import org.eclipse.sensinact.gateway.common.bundle.Mediator;
import org.eclipse.sensinact.gateway.protocol.http.client.Request;
import org.eclipse.sensinact.gateway.sthbnd.http.HttpProtocolStackEndpoint;
import org.eclipse.sensinact.gateway.sthbnd.http.HttpResponse;

/**
 * Extended {@link HttpTask} dedicated to discovery process
 *
 * @author <a href="mailto:christophe.munilla@cea.fr">Christophe Munilla</a>
 */
public class HttpUnsubscribingTask<RESPONSE extends HttpResponse, REQUEST extends Request<RESPONSE>> 
extends HttpDiscoveryTask<RESPONSE, REQUEST> {
    
	/**
     * Constructor
     *
     * @param mediator       
     * 		the {@link Mediator} allowing to interact with the OSGi host environment
     * @param transmitter    
     * 		the {@link HttpProtocolStackEndpoint} transmitting the requests build by 
     * 		the HttpUnsubscribingTask to be instantiated
     * @param requestType    
     * 		the extended {@link Request} type of the Http request created by the
     * 		the HttpUnsubscribingTask to be instantiated
     * @param subscriptionId 
     * 		the String identifier of the subscription to be deleted
     */
    public HttpUnsubscribingTask(Mediator mediator, HttpProtocolStackEndpoint transmitter, Class<REQUEST> requestType, String subscriptionId) {
        super(mediator, CommandType.UNSUBSCRIBE, transmitter, requestType, new Object[] {subscriptionId});
    }

	/**
     * Constructor
     *
     * @param mediator       
     * 		the {@link Mediator} allowing to interact with the OSGi host environment
     * @param transmitter    
     * 		the {@link HttpProtocolStackEndpoint} transmitting the requests build by 
     * 		the HttpUnsubscribingTask to be instantiated
     * @param requestType    
     * 		the extended {@link Request} type of the Http request created by the
     * 		the HttpUnsubscribingTask to be instantiated
     * @param subscribingTask
     * 		the HttpSubscribingTask holding the string identifier of the subscription 
     * 		to be deleted
     */
    public HttpUnsubscribingTask(Mediator mediator, HttpProtocolStackEndpoint transmitter, Class<REQUEST> requestType, HttpSubscribingTask<?,?> subscribingTask) {
        super(mediator, CommandType.UNSUBSCRIBE, transmitter, requestType, new Object[] {subscribingTask});
    }

    /**
     * @inheritDoc
     * 
     * @see HttpTask#isDirect()
     */
    public boolean isDirect() {
        return true;
    }
}