/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2006-2008 Sun Microsystems, Inc.
|
* Portions Copyright 2014 ForgeRock AS
|
*/
|
package org.opends.server.loggers;
|
import java.util.ArrayList;
|
import java.util.Arrays;
|
import java.util.Calendar;
|
import java.util.List;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.forgerock.i18n.slf4j.LocalizedLogger;
|
import org.opends.server.admin.server.ConfigurationChangeListener;
|
import org.opends.server.admin.std.server.FixedTimeLogRotationPolicyCfg;
|
import org.opends.server.types.ConfigChangeResult;
|
import org.forgerock.opendj.ldap.ResultCode;
|
import org.opends.server.util.TimeThread;
|
|
|
/**
|
* This class implements a rotation policy based on fixed
|
* day/time of day.
|
*/
|
public class FixedTimeRotationPolicy implements
|
RotationPolicy<FixedTimeLogRotationPolicyCfg>,
|
ConfigurationChangeListener<FixedTimeLogRotationPolicyCfg>
|
{
|
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
|
|
// The scheduled rotation times as ms offsets from the beginning of the day.
|
private int[] rotationTimes;
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void initializeLogRotationPolicy(FixedTimeLogRotationPolicyCfg config)
|
{
|
rotationTimes = new int[config.getTimeOfDay().size()];
|
|
int i = 0;
|
for(String time : config.getTimeOfDay())
|
{
|
rotationTimes[i++] = Integer.valueOf(time);
|
}
|
|
Arrays.sort(rotationTimes);
|
|
config.addFixedTimeChangeListener(this);
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isConfigurationChangeAcceptable(
|
FixedTimeLogRotationPolicyCfg config, List<LocalizableMessage> unacceptableReasons)
|
{
|
// Changes should always be OK
|
return true;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public ConfigChangeResult applyConfigurationChange(
|
FixedTimeLogRotationPolicyCfg config)
|
{
|
// Default result code.
|
ResultCode resultCode = ResultCode.SUCCESS;
|
boolean adminActionRequired = false;
|
ArrayList<LocalizableMessage> messages = new ArrayList<LocalizableMessage>();
|
|
rotationTimes = new int[config.getTimeOfDay().size()];
|
|
int i = 0;
|
for(String time : config.getTimeOfDay())
|
{
|
rotationTimes[i++] = Integer.valueOf(time);
|
}
|
|
Arrays.sort(rotationTimes);
|
|
return new ConfigChangeResult(resultCode, adminActionRequired, messages);
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean rotateFile(MultifileTextWriter writer)
|
{
|
Calendar lastRotationTime = writer.getLastRotationTime();
|
|
Calendar nextRotationTime = (Calendar)lastRotationTime.clone();
|
int i = 0;
|
nextRotationTime.set(Calendar.HOUR_OF_DAY, rotationTimes[i] / 100);
|
nextRotationTime.set(Calendar.MINUTE, rotationTimes[i] % 100);
|
nextRotationTime.set(Calendar.SECOND, 0);
|
while(lastRotationTime.after(nextRotationTime))
|
{
|
if(i == rotationTimes.length - 1)
|
{
|
nextRotationTime.add(Calendar.DATE, 1);
|
i = 0;
|
}
|
else
|
{
|
i++;
|
}
|
|
nextRotationTime.set(Calendar.HOUR_OF_DAY, rotationTimes[i] / 100);
|
nextRotationTime.set(Calendar.MINUTE, rotationTimes[i] % 100);
|
}
|
|
logger.trace("The next fixed rotation time is %s", rotationTimes[i]);
|
|
return TimeThread.getCalendar().after(nextRotationTime);
|
}
|
}
|