001/*
002 * (C) Copyright 2014-2017 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Thierry Delprat
018 *     Yannis JULIENNE
019 */
020package org.nuxeo.segment.io;
021
022import java.io.Serializable;
023import java.util.List;
024import java.util.Map;
025import java.util.Set;
026
027import org.nuxeo.ecm.core.api.NuxeoPrincipal;
028
029public interface SegmentIO {
030
031    enum ACTIONS {
032        track, screen, page, identify
033    }
034
035    String getWriteKey();
036
037    Map<String, String> getGlobalParameters();
038
039    /**
040     * @since 10.2
041     */
042    void identify(NuxeoPrincipal principal);
043
044    /**
045     * @since 10.2
046     */
047    void identify(NuxeoPrincipal principal, Map<String, Serializable> metadata);
048
049    /**
050     * @since 10.2
051     */
052    void track(NuxeoPrincipal principal, String eventName, Map<String, Serializable> metadata);
053
054    /**
055     * @since 10.2
056     */
057    void screen(NuxeoPrincipal principal, String screen, Map<String, Serializable> metadata);
058
059    /**
060     * @since 10.2
061     */
062    void page(NuxeoPrincipal principal, String name, Map<String, Serializable> metadata);
063
064    /**
065     * @since 10.2
066     */
067    void page(NuxeoPrincipal principal, String name, String category, Map<String, Serializable> metadata);
068
069    void flush();
070
071    /**
072     * @since 10.2
073     */
074    boolean mustTrackprincipal(String principalName);
075
076    Map<String, Boolean> getIntegrations();
077
078    SegmentIOUserFilter getUserFilters();
079
080    Set<String> getMappedEvents();
081
082    Map<String, List<SegmentIOMapper>> getMappers(List<String> events);
083
084    Map<String, List<SegmentIOMapper>> getAllMappers();
085
086    /**
087     * @return true if the service is in debug mode
088     * @since 9.10
089     */
090    boolean isDebugMode();
091}