org.apache.eagle.security.userprofile.UserProfileAnomalyDetector Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.eagle.security.userprofile;

import org.apache.eagle.ml.model.MLCallbackResult;
import org.apache.eagle.ml.model.MLModelAPIEntity;
import org.apache.eagle.security.userprofile.model.UserActivityAggModel;
import org.apache.eagle.security.userprofile.model.UserProfileModel;

import java.io.IOException;
import java.util.List;

public interface UserProfileAnomalyDetector {
    /**
     * Convert from entity to model
     *
     * @param entity model entity
     * @return model in type of M
     */
    M convert(MLModelAPIEntity entity) throws IOException;

    /**
     * @param user user name
     * @param algorithm algorithm name
     * @param userActivity real-time user activity aggregation entity
     * @param model user profiling model
     * @return MLAnomalyCallback list
     */
    List detect(String user, String algorithm, UserActivityAggModel userActivity, M model);
}