blob: 4598d940b95a1f1165b7046091d228df8d079730 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/*
* 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.
*/
#if !defined(_LOG4CXX_ROLLING_ROLLING_POLICY_H)
#define _LOG4CXX_ROLLING_ROLLING_POLICY_H
#include <log4cxx/portability.h>
#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/rolling/rolloverdescription.h>
#include <log4cxx/file.h>
namespace log4cxx {
namespace rolling {
/**
* A <code>RollingPolicy</code> is responsible for performing the
* rolling over of the active log file. The <code>RollingPolicy</code>
* is also responsible for providing the <em>active log file</em>,
* that is the live file where logging output will be directed.
*
*
*
*
*/
class LOG4CXX_EXPORT RollingPolicy :
public virtual spi::OptionHandler {
DECLARE_ABSTRACT_LOG4CXX_OBJECT(RollingPolicy)
public:
virtual ~RollingPolicy() {}
/**
* Initialize the policy and return any initial actions for rolling file appender.
*
* @param file current value of RollingFileAppender.getFile().
* @param append current value of RollingFileAppender.getAppend().
* @param p pool for memory allocations during call.
* @return Description of the initialization, may be null to indicate
* no initialization needed.
* @throws SecurityException if denied access to log files.
*/
virtual RolloverDescriptionPtr initialize(
const LogString& file,
const bool append,
log4cxx::helpers::Pool& p) = 0;
/**
* Prepare for a rollover. This method is called prior to
* closing the active log file, performs any necessary
* preliminary actions and describes actions needed
* after close of current log file.
*
* @param activeFile file name for current active log file.
* @param p pool for memory allocations during call.
* @return Description of pending rollover, may be null to indicate no rollover
* at this time.
* @throws SecurityException if denied access to log files.
*/
virtual RolloverDescriptionPtr rollover(const LogString& activeFile,
log4cxx::helpers::Pool& p) = 0;
};
LOG4CXX_PTR_DEF(RollingPolicy);
}
}
#endif
|
