Logger.java example

Explorer
logdb-master
/*
 * Copyright 2010 NCHOVY
 * 
 * Licensed 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.araqne.log.api;

import java.util.Date;
import java.util.Map;
import java.util.Set;

public interface Logger {
	String getFullName();

	String getNamespace();

	String getName();

	String getFactoryFullName();

	String getFactoryName();

	String getFactoryNamespace();

	String getDescription();

	boolean isPassive();

	Date getLastStartDate();

	Date getLastRunDate();

	Date getLastLogDate();

	Date getLastWriteDate();

	/**
	 * @since 2.6.0
	 */
	Log getLastLog();

	LoggerStopReason getStopReason();

	/**
	 * @since 3.6.0
	 */
	Throwable getTemporaryFailure();

	/**
	 * @since 2.3.1
	 */
	long getDropCount();

	long getLogCount();

	/**
	 * TODO
	 * 
	 * @since ???
	 */
	long getDropVolume();

	long getLogVolume();

	/**
	 * state update count
	 */
	long getUpdateCount();

	/**
	 * @since 3.2.13
	 * @return logger is started/stopped by user request
	 */
	boolean isEnabled();

	boolean isRunning();

	boolean isPending();

	void setPending(boolean pending);

	/**
	 * @since 2.4.0
	 */
	boolean isManualStart();

	/**
	 * @since 2.4.0
	 */
	void setManualStart(boolean manualStart);

	LoggerStatus getStatus();

	int getInterval();

	/**
	 * @since 3.4.0
	 */
	TimeRange getTimeRange();

	/**
	 * @since 3.4.0
	 */
	void setTimeRange(TimeRange timeRange);

	void start(LoggerStartReason reason);

	void start(LoggerStartReason reason, int interval);

	void stop(LoggerStopReason reason);

	void stop(LoggerStopReason reason, int maxWaitTime);

	void addLogPipe(LogPipe pipe);

	void removeLogPipe(LogPipe pipe);

	void addEventListener(LoggerEventListener callback);

	void removeEventListener(LoggerEventListener callback);

	void clearEventListeners();

	void updateConfigs(Map<String, String> config);

	/**
	 * Use getConfigs() instead
	 */
	@Deprecated
	Map<String, String> getConfig();

	/**
	 * config parameters (specified by factory)
	 */
	Map<String, String> getConfigs();

	/**
	 * state is backed up by persistent storage
	 */
	Map<String, Object> getStates();

	/**
	 * replace current persistent state
	 */
	void setStates(Map<String, Object> state);

	/**
	 * reload log count, update count
	 */
	void reloadStates();

	/**
	 * reset log/drop count, last date, and all properties
	 */
	void resetStates();

	LogTransformer getTransformer();

	void setTransformer(LogTransformer transformer);

	LoggerFactory getFactory();

	Set<String> getUnresolvedLoggers();

	boolean hasUnresolvedLoggers();

	void addUnresolvedLogger(String fullName);

	void removeUnresolvedLogger(String fullName);
}