001/*
002 * (C) Copyright 2014 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 */
019package org.nuxeo.segment.io;
020
021import java.io.Serializable;
022import java.util.Map;
023
024import org.nuxeo.ecm.core.api.NuxeoPrincipal;
025
026import com.github.segmentio.models.Providers;
027
028public interface SegmentIO {
029
030    String getWriteKey();
031
032    Map<String, String> getGlobalParameters();
033
034    void identify(NuxeoPrincipal principal);
035
036    void identify(NuxeoPrincipal principal, Map<String, Serializable> metadata);
037
038    void track(NuxeoPrincipal principal, String eventName);
039
040    void track(NuxeoPrincipal principal, String eventName,
041            Map<String, Serializable> metadata);
042
043    void flush();
044
045    Providers getProviders();
046
047    SegmentIOUserFilter getUserFilters();
048}