001/*******************************************************************************
002 * Copyright 2014 The MITRE Corporation
003 *   and the MIT Kerberos and Internet Trust Consortium
004 * 
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 * 
009 *   http://www.apache.org/licenses/LICENSE-2.0
010 * 
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 ******************************************************************************/
017/**
018 * 
019 */
020package org.mitre.openid.connect.service;
021
022import java.util.Map;
023
024/**
025 * @author jricher
026 *
027 */
028public interface StatsService {
029
030        /**
031         * Calculate summary statistics
032         *      approvalCount: total approved sites
033         *      userCount: unique users
034         *      clientCount: unique clients
035         * 
036         * @return
037         */
038        public Map<String, Integer> getSummaryStats();
039
040        /**
041         * Calculate usage count for all clients
042         * 
043         * @return a map of id of client object to number of approvals
044         */
045        public Map<Long, Integer> getByClientId();
046
047        /**
048         * Calculate the usage count for a single client
049         * 
050         * @param id the id of the client to search on
051         * @return
052         */
053        public Integer getCountForClientId(Long id);
054
055        /**
056         * Trigger the stats to be recalculated upon next update.
057         */
058        public void resetCache();
059
060}