001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2010-2011 ApexIdentity Inc. 015 * Portions Copyright 2011-2015 ForgeRock AS. 016 */ 017 018package org.forgerock.openig.log; 019 020import org.forgerock.openig.heap.Name; 021 022/** 023 * Receives and handles log entries. 024 */ 025public interface LogSink { 026 027 /** 028 * Logs an entry. 029 * 030 * @param entry the entry to be logged. 031 */ 032 void log(LogEntry entry); 033 034 /** 035 * Returns {@code true} if the entry may be logged based on its source and/or level. This 036 * does not guarantee that the entry will in fact be logged. 037 * 038 * @param source the object and/or event related to the log entry. 039 * @param level the logging level of the log entry. 040 * @return {@code true} if the entry may be logged. 041 */ 042 boolean isLoggable(Name source, LogLevel level); 043}