clirr-ignored-api-changes.xml revision 52674c7996797d28e6671590293a44c1e5f93017
<?xml version="1.0" encoding="UTF-8"?>
<!--
! 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
! 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 2014-2015 ForgeRock AS
!
-->
<differences>
<!--
For specifying ignored differences, see:
- regex when surrounded with '%regex[]'
- ant style path matching when surrounded with '%ant[]'
- ant style path matching when not surrounded by anything
For a description of ant style path expressions see:
Note: waiting on https://jira.codehaus.org/browse/MCLIRR-62 to be resolved to avoid the need to use \s* in the '<to>' tags.
-->
<difference>
<differenceType>7002</differenceType>
<justification>Moving from inetSocketAddress to host+port constructors</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>LDAPConnectionFactory(java.net.SocketAddress, org.forgerock.opendj.ldap.LDAPOptions)</method>
<justification>Moving from inetSocketAddress to host+port constructors</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<justification>Moving from inetSocketAddress to host+port constructors</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<justification>Moving from inetSocketAddress to host+port constructors</justification>
</difference>
<difference>
<differenceType>8001</differenceType>
<justification>Incorrectly reported because it is automatically generated</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.ConnectionFactory newHeartBeatConnectionFactory\(org\.forgerock\.opendj\.ldap\.ConnectionFactory, long, java\.util\.concurrent\.TimeUnit, org\.forgerock\.opendj\.ldap\.requests\.SearchRequest(, java\.util\.concurrent\.ScheduledExecutorService)?\)]</method>
<to>%regex[org\.forgerock\.opendj\.ldap\.ConnectionFactory newHeartBeatConnectionFactory\(org\.forgerock\.opendj\.ldap\.ConnectionFactory,\s*long,\s*long,\s*java\.util\.concurrent\.TimeUnit(,\s*org\.forgerock\.opendj\.ldap\.requests\.SearchRequest(,\s*java\.util\.concurrent\.ScheduledExecutorService)?)?\)]</to>
<justification>OPENDJ-1058: Added a timeout parameter to actively shutdown dead connections</justification>
</difference>
<difference>
<differenceType>7004</differenceType>
<method>org.forgerock.opendj.ldap.ConnectionFactory newHeartBeatConnectionFactory(org.forgerock.opendj.ldap.ConnectionFactory, long, java.util.concurrent.TimeUnit)</method>
<justification>OPENDJ-1058: Added a timeout parameter to actively shutdown dead connections</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.ErrorResultException newErrorResult\(org\.forgerock\.opendj\.ldap\.ResultCode, java\.lang\.String(, java\.lang\.Throwable)?\)]</method>
<to>%regex[org\.forgerock\.opendj\.ldap\.ErrorResultException newErrorResult\(org\.forgerock\.opendj\.ldap\.ResultCode, java\.lang\.CharSequence(, java\.lang\.Throwable)?\)]</to>
<justification>OPENDJ-1058: Broadened the API by accepting java.lang.CharSequence while retaining source compatibility</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<justification>OPENDJ-1270: Renamed LDAP{ConnectionFactory|Listener}.getHostname() to getHostName()</justification>
</difference>
<difference>
<differenceType>7006</differenceType>
<justification>OPENDJ-1270: Changed LDAP{ConnectionFactory|Listener}.getAddress() to return InetSocketAddresses</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<method>%regex[LDAPConnectionFactory\(java\.net\.SocketAddress(, org\.forgerock\.opendj\.ldap\.LDAPOptions)?\)]</method>
<to>%regex[LDAPConnectionFactory\(java\.net\.InetSocketAddress(, org\.forgerock\.opendj\.ldap\.LDAPOptions)?\)]</to>
<justification>OPENDJ-1270: Changed constructors to only accept InetSocketAddresses instead of more generic SocketAddress</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<method>%regex[LDAPListener\(java\.net\.SocketAddress, org\.forgerock\.opendj\.ldap\.ServerConnectionFactory(,\s*org\.forgerock\.opendj\.ldap\.LDAPListenerOptions)?\)]</method>
<to>%regex[LDAPListener\(java\.net\.InetSocketAddress,\s*org\.forgerock\.opendj\.ldap\.ServerConnectionFactory(,\s*org\.forgerock\.opendj\.ldap\.LDAPListenerOptions)?\)]</to>
<justification>OPENDJ-1270: Changed constructors to only accept InetSocketAddresses instead of more generic SocketAddress</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>%regex[org\.glassfish\.grizzly\.nio\.transport\.TCPNIOTransport getTCPNIOTransport\(\)]</method>
<justification>OPENDJ-346: Decoupled opendj-ldap-sdk from grizzly-framework</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.(LDAPOptions|LDAPListenerOptions) setTCPNIOTransport\(org\.glassfish\.grizzly\.nio\.transport\.TCPNIOTransport\)]</method>
<justification>OPENDJ-346: Decoupled opendj-ldap-sdk from grizzly-framework</justification>
</difference>
<difference>
<differenceType>8001</differenceType>
<justification>OPENDJ-175: Moved all classes from org.forgerock.opendj.asn1 package to org.forgerock.opendj.io package</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<method>boolean isEmpty()</method>
<justification>OPENDJ-701: Added method isEmpty() to interface ByteSequence</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<method>boolean isSingleEntrySearch()</method>
<justification>OPENDJ-972: Added method isSingleEntrySearch() to interface SearchRequest</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.Assertion getAssertion\(org\.forgerock\.opendj\.ldap\.ByteSequence, java\.util\.List, org\.forgerock\.opendj\.ldap\.ByteSequence\)]</method>
<justification>Renamed getAssertion() to getSubstringAssertion()</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.Assertion getAssertion\(org\.forgerock\.opendj\.ldap\.schema\.Schema, org\.forgerock\.opendj\.ldap\.ByteSequence, java\.util\.List, org\.forgerock\.opendj\.ldap\.ByteSequence\)]</method>
<justification>Renamed getAssertion() to getSubstringAssertion()</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.Assertion getSubstringAssertion\(org\.forgerock\.opendj\.ldap\.schema\.Schema, org\.forgerock\.opendj\.ldap\.ByteSequence, java\.util\.List, org\.forgerock\.opendj\.ldap\.ByteSequence\)]</method>
<justification>Renamed getAssertion() to getSubstringAssertion()</justification>
</difference>
<difference>
<differenceType>7006</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy\$Policy (checkAttributeValues|checkAttributesAndObjectClasses|checkDITContentRules|checkDITStructureRules|checkNameForms|requireSingleStructuralObjectClass)\(\)]</method>
<to>%regex[org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy\$Action]</to>
<justification>Renamed SchemaValidationPolicy.Policy to SchemaValidationPolicy.Action</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<method>%regex[org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy (checkAttributeValues|checkAttributesAndObjectClasses|checkDITContentRules|checkDITStructureRules|checkNameForms|requireSingleStructuralObjectClass)\(org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy\$Policy(, org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy\$EntryResolver)?\)]</method>
<to>%regex[org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy (checkAttributeValues|checkAttributesAndObjectClasses|checkDITContentRules|checkDITStructureRules|checkNameForms|requireSingleStructuralObjectClass)\(org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy\$Action(,\s*org\.forgerock\.opendj\.ldap\.schema\.SchemaValidationPolicy\$EntryResolver)?\)]</to>
<justification>Renamed SchemaValidationPolicy.Policy to SchemaValidationPolicy.Action</justification>
</difference>
<difference>
<differenceType>8001</differenceType>
<justification>Renamed SchemaValidationPolicy.Policy to SchemaValidationPolicy.Action</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>org.forgerock.opendj.ldap.LDAPListenerOptions setDecodeOptions(org.forgerock.opendj.ldap.DecodeOptions)</method>
<justification>OPENDJ-1197: Method return type has changed due to reification</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>org.forgerock.opendj.ldap.LDAPOptions setDecodeOptions(org.forgerock.opendj.ldap.DecodeOptions)</method>
<justification>OPENDJ-1197: Method return type has changed due to reification</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>OPENDJ-1308 Migrate schema support: allows decoupling indexing from a specific backend</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>OPENDJ-1308 Migrate schema support: allows decoupling indexing from a specific backend</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<method>boolean isIndexingSupported()</method>
<justification>OPENDJ-1308 Migrate schema support: allows decoupling indexing from a specific backend</justification>
</difference>
<difference>
<differenceType>7004</differenceType>
<method>org.forgerock.opendj.ldap.FutureResult *Async(*org.forgerock.opendj.ldap.ResultHandler)</method>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>7004</differenceType>
<method>org.forgerock.opendj.ldap.FutureResult readSchema*Async*(org.forgerock.opendj.ldap.Connection, org.forgerock.opendj.ldap.DN, org.forgerock.opendj.ldap.ResultHandler)</method>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>7006</differenceType>
<method>org.forgerock.opendj.ldap.FutureResult *Async(*org.forgerock.opendj.ldap.ResultHandler)</method>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>7004</differenceType>
<method>*handleSearch(*)</method>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>4001</differenceType>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>7004</differenceType>
<justification>OPENDJ-1285 Migrate SDK from Futures to Promises</justification>
</difference>
<difference>
<differenceType>5001</differenceType>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>5001</differenceType>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>8001</differenceType>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>7006</differenceType>
<method>*Async*</method>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>7006</differenceType>
<method>*Async*</method>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>7006</differenceType>
<method>*Async*</method>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>8001</differenceType>
<justification>OPENDJ-1536 Rename FutureResult and ErrorResultException classes hierarchy in the SDK to enhance code consistency</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>*composeFirstP(*)</method>
<justification>OPENDJ-1550 Replace SDK Function with Function from forgerock-util</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>*composeSecondP(*)</method>
<justification>OPENDJ-1550 Replace SDK Function with Function from forgerock-util</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>*fixedFunction(*)</method>
<justification>OPENDJ-1550 Replace SDK Function with Function from forgerock-util</justification>
</difference>
<difference>
<differenceType>8001</differenceType>
<justification>OPENDJ-1550 Replace SDK Function with Function from forgerock-util</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<justification>OPENDJ-1550 Replace SDK Function with Function from forgerock-util</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
<justification>OPENDJ-1550 Replace SDK Function with Function from forgerock-util</justification>
</difference>
<difference>
<differenceType>7006</differenceType>
<method>*</method>
<justification>OPENDJ-1550 Replace SDK Function with Function from forgerock-util</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>*toNormalizedString()</method>
<to>*toIrreversibleNormalizedByteString()</to>
<justification>OPENDJ-1585 Function has been renamed to avoid abuse</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<method>%regex[(boolean|org.forgerock.opendj.ldap.schema.SchemaBuilder) allow(.)*\((boolean)?\)]</method>
<justification>OPENDJ-1478 Make it easier to add compatibility options to schemas</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>Added new utility method copyTo() for a byte buffer</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>OPENDJ-1585: Added new utility method copyTo for a char buffer</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<justification>OPENDJ-1689 method has been removed because all matching rules should support the default comparator</justification>
</difference>
<difference>
<differenceType>7002</differenceType>
<justification>OPENDJ-1689 method has been removed because all matching rules should support the default comparator</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>Doesn't really seem correct to call createKeys() with different options each time.</justification>
</difference>
<difference>
<differenceType>7012</differenceType>
<justification>Lack of startsWith() forced to re-implement it multiple times at different location</justification>
</difference>
<difference>
<differenceType>7005</differenceType>
</method>
<justification>Using CharSequence instead of String allows to reduce memory copy.</justification>
</difference>
</differences>