GPTrackingService.java

/**
 *
 *    geo-platform
 *    Rich webgis framework
 *    http://geo-platform.org
 *   ====================================================================
 *
 *   Copyright (C) 2008-2017 geoSDI Group (CNR IMAA - Potenza - ITALY).
 *
 *   This program is free software: you can redistribute it and/or modify it
 *   under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version. This program is distributed in the
 *   hope that it will be useful, but WITHOUT ANY WARRANTY; without
 *   even the implied warranty of MERCHANTABILITY or FITNESS FOR
 *   A PARTICULAR PURPOSE. See the GNU General Public License
 *   for more details. You should have received a copy of the GNU General
 *   Public License along with this program. If not, see http://www.gnu.org/licenses/
 *
 *   ====================================================================
 *
 *   Linking this library statically or dynamically with other modules is
 *   making a combined work based on this library. Thus, the terms and
 *   conditions of the GNU General Public License cover the whole combination.
 *
 *   As a special exception, the copyright holders of this library give you permission
 *   to link this library with independent modules to produce an executable, regardless
 *   of the license terms of these independent modules, and to copy and distribute
 *   the resulting executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the license of
 *   that module. An independent module is a module which is not derived from or
 *   based on this library. If you modify this library, you may extend this exception
 *   to your version of the library, but you are not obligated to do so. If you do not
 *   wish to do so, delete this exception statement from your version.
 */
package org.geosdi.geoplatform.services;

import javax.jws.WebParam;
import javax.jws.WebService;
import org.codehaus.jra.Post;
import org.geosdi.geoplatform.exception.ResourceNotFoundFault;
import org.geosdi.geoplatform.gui.shared.XMPPSubjectEnum;
import org.geosdi.geoplatform.response.collection.XmppAttributesMap;

/**
 * Public interface to define the service operations mapped via REST using CXT
 * framework.
 *
 * @author Nazzareno Sileno - CNR IMAA geoSDI Group
 * @email nazzareno.sileno@geosdi.org
 */
@WebService(name = "GPTrackingService",
            targetNamespace = "http://services.geo-platform.org/")
public interface GPTrackingService {

    @Post
    void subscribeLayerNotification(@WebParam(name = "username") String username,
            @WebParam(name = "emiteResource") String emiteResource,
            @WebParam(name = "layerUUID") String layerUUID,
            @WebParam(name = "time") int secondToRefresh);

    @Post
    boolean unscribeLayerNotification(@WebParam(name = "username") String username,
            @WebParam(name = "layerUUID") String layerUUID);

    /**
     * Send a Message XMPP for every online Account to which the Project is
     * shared.
     *
     * @param projectID the Project ID
     * @param subject the Message subject
     * @param text the Message text (aka body)
     * @param attributesMap the Message attributes (aka properties)
     * @throws ResourceNotFoundFault if Project not found
     */
    @Post
    void sendSharedProjectNotification(
            @WebParam(name = "projectID") Long projectID,
            @WebParam(name = "subject") XMPPSubjectEnum subject,
            @WebParam(name = "text") String text,
            @WebParam(name = "attributesMap") XmppAttributesMap attributesMap)
            throws ResourceNotFoundFault;
}