001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Portions Copyright 2011-2014 UnboundID Corp. 026 */ 027 package com.unboundid.directory.sdk.common.types; 028 029 import com.unboundid.util.ThreadSafety; 030 import com.unboundid.util.ThreadSafetyLevel; 031 032 033 /** 034 * This interface provides methods to interact with a log writer within the 035 * core server logging framework. 036 */ 037 @ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 038 public interface LogWriter 039 { 040 041 /** 042 * Writes the given message to the underlying logger. 043 * <p> 044 * A timestamp will automatically be prepended to the message, and an 045 * end-of-line marker will be added to the end. The message can contain its 046 * own EOLs if it needs to span multiple lines, but the server will always add 047 * one at the very end. 048 * 049 * @param message the message to log. 050 */ 051 void write(CharSequence message); 052 053 }