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 String getWriteKey(); 032 033 Map<String, String> getGlobalParameters(); 034 035 void identify(NuxeoPrincipal principal); 036 037 void identify(NuxeoPrincipal principal, Map<String, Serializable> metadata); 038 039 void track(NuxeoPrincipal principal, String eventName, Map<String, Serializable> metadata); 040 041 void flush(); 042 043 Map<String, Boolean> getIntegrations(); 044 045 SegmentIOUserFilter getUserFilters(); 046 047 Set<String> getMappedEvents(); 048 049 Map<String, List<SegmentIOMapper>> getMappers(List<String> events); 050 051 Map<String, List<SegmentIOMapper>> getAllMappers(); 052 053 /** 054 * @return true if the service is in debug mode 055 * @since 9.10 056 */ 057 boolean isDebugMode(); 058}