HistoricalCsnOrderingMatchingRule.java revision 1bac99f5f3008a0c1baa64df5a248f48f209a399
/*
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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-2009 Sun Microsystems, Inc.
*/
package org.opends.server.replication.plugin;
import java.util.Collection;
import java.util.Collections;
import org.opends.server.api.AbstractMatchingRule;
import org.opends.server.api.OrderingMatchingRule;
import org.opends.server.types.ByteString;
import org.opends.server.types.ByteSequence;
/**
* Used to establish an order between historical information and index them.
*/
public class HistoricalCsnOrderingMatchingRule
extends AbstractMatchingRule
implements OrderingMatchingRule
{
/**
* The serial version identifier required to satisfy the compiler because this
* class implements the <CODE>java.io.Serializable</CODE> interface. This
* value was generated using the <CODE>serialver</CODE> command-line utility
* included with the Java SDK.
*/
private static final long serialVersionUID = -3424403930225609943L;
/**
* Construct a new HistoricalCsnOrderingMatchingRule object.
*
*/
public HistoricalCsnOrderingMatchingRule()
{
super();
}
/**
* Compare two ByteString values containing historical information.
* @param value1 first value to compare
* @param value2 second value to compare
* @return 0 when equals, -1 or 1 to establish order
*/
public int compareValues(ByteSequence value1, ByteSequence value2)
{
String[] token1 = value1.toString().split(":", 3);
String[] token2 = value2.toString().split(":", 3);
if ((token1[1] == null) || (token2[1] == null))
return -1;
return token1[1].compareTo(token2[1]);
}
/**
* {@inheritDoc}
*/
public Collection<String> getAllNames()
{
return Collections.singleton(getName());
}
/**
* Get the name of this class.
* @return name of the class in String form
*/
@Override
public String getName()
{
return "historicalCsnOrderingMatch";
}
/**
* Get the OID of the class.
* @return the OID of the class in String form.
*/
@Override
public String getOID()
{
return "1.3.6.1.4.1.26027.1.4.4";
}
/**
* Get the description of this Class.
* @return the Class description in String form, currently not used.
*/
@Override
public String getDescription()
{
return null;
}
/**
* Get the Syntax OID for this class.
* @return the syntax OID in String form
*/
@Override
public String getSyntaxOID()
{
return "1.3.6.1.4.1.26027.1.3.5";
}
/**
* Normalize historical information representation.
* @param value the value that must be normalized
* @return The String form that must be used for historical information
* comparison
*/
@Override
public ByteString normalizeValue(ByteSequence value)
{
String[] token = value.toString().split(":", 3);
/* Change the format of the value to index and start
* with the serverId. In that manner, the search response
* time is optimised for a particulare serverId.
* The format of the key is now :
* serverId + timestamp + seqNum
*/
String timestamp = token[1].substring(0,16);
String serverId = token[1].substring(16,20);
String seqNumber = token[1].substring(20, 28);
return ByteString.valueOf(serverId + timestamp + seqNumber);
}
/**
* Compares two normalized representation of historical information.
* @param b1 first value to compare
* @param b2 second value to compare
* @return 0, -1 or 1 depending on relative positions
*/
public int compare(byte[] b1, byte[] b2)
{
int minLength = Math.min(b1.length, b2.length);
for (int i=0; i < minLength; i++)
{
if (b1[i] == b2[i])
{
continue;
}
else if (b1[i] < b2[i])
{
return -1;
}
else if (b1[i] > b2[i])
{
return 1;
}
}
if (b1.length == b2.length)
{
return 0;
}
else if (b1.length < b2.length)
{
return -1;
}
else
{
return 1;
}
}
}