CHANGELOG.md

Changelog

Version 2.6.0 (01.06.2021)

Protocol

• Make ProtocolRequestWriter implement Flushable to allow on-demand sending of already written responses.

Version 2.5.3 (13.05.2021)

Client

• Fix a resource leak due to SSLSocket not being closed properly.

Version 2.5.2 (22.02.2021)

Composer

• Fix a NPE when close() is called on non-successful DataApiResponse instances.

Version 2.5.1 (17.02.2021)

Composer

• Fix a case in DataApiResponseAdapter where an API call with a non-success result code being adapted to a DataApiResponse will result in the underlying Response and Connection not being closed (and potentially reused).

Version 2.5.0 (28.07.2020)

Client

• Deprecate ResponseBody.writeTo(), ResponseBody.valuesBytes(), ResponseBody.valuesByteArray().

  The one-shot stream of data being held by a ResponseBody needs to be decoded by a ProtocolReader before use. ResponseBody.reader() returns such an instance which is already configured and ready for reading making these methods redundant. Also the aforementioned methods bring some behavior ambiguity in cases where the stream may be partially consumed through the exposed ProtocolReader.

  The methods will now throw an IllegalStateException if called when the response has been partially read via a ProtocolReader.

  The methods will be removed in the next major release of the library.

• Fix potential connection leaks in Call.enqueue() and Call.enqueueAndWait() implementations.

• Review connection closing/recycling in the MultiCall implementation.

• Add more assertions regarding connection recycling/closure in Call and MultiCall unit tests.

Version 2.4.1 (20.03.2020)

Protocol

• Fix a bug in BytesReader.skipValue().
• Make read scope checks more consistent in BytesReader

Version 2.4.0 (10.03.2020)

Client

• Add the ResponseBody.writeTo(BufferedSink) method.

Protocol

• Fix a bug in BytesReader.peek() where an TypeToken.END_ARRAY instead of a TypeToken.END_OBJECT would be returned.
• Reduce memory allocations in BytesReader by replacing the internal structure storing scopes.

Version 2.3.0 (23.10.2019)

Composer

• Add the methodName() property to Call<T> to allow for better error reporting.
• Add the API method name in the stacktrace when an error is thrown via an Observable created with a RxJava adapter.
• Add the ability to override the target endpoint of a Call<T> is being made by adding a single Endpoint method parameter. Example:

  interface MyInterface {
     @Method("someapicall")
     Call<ResponseBody> getResponseBody(Endpoint endpoint);
  
     @Method("someapicallwithparams")
     Call<ResponseBody> getResponseBody(@Request SomeRequest request, Endpoint endpoint);
  }

  • Extract the composer-related annotations in a separate module and the composer-annotations maven artifact.

Client

• Add an endpoint() property to ResponseData that returns the source Endpoint.

Serialization

• Give a better error message when trying to serialize a type as a request parameter not resulting in a single value.

Protocol

• Update to Okio 1.17.4
• Drop the peeking source implementation in favor of the one shipped with Okio.
• BytesReader instances returned from BytesReader.peek() will not close their parent when being closed.
• BytesReader instances returned from BytesReader.peek() will throw exceptions if used when their parent has bytes consumed beyond the peek start point.

General

• Update to Gradle 5.6.2
• Refactor the project build scripts

Version 2.2.3 (19.09.2018)

Client

• Simplify the connection establishment and error reporting logic.
• Code style improvements & small bugfixes.

Version 2.2.2 (18.09.2018)

Serialization

• Fix a bug where boolean primitive fields where not serialized.

Version 2.2.1 (17.09.2018)

Client

• Update the default HostnameVerifier implementation to the skip the fallback to the use of Common Name, which has been deprecated.
• Update the socket connection establishing logic to properly honor read and connect timeouts.

Version 2.2.0 (08.08.2018)

Serialization

• Reduce the object allocation count by modifying ClassTypeAdapter.Binding's API and introducing primitive-specific LongBinding, IntBinding, ...
• Extract a new serialization-annotations artifact containing only serialization-related annotations.

Protocol

• Reduce the object allocation count in BytesReader.readNumber() and similar underlying number reading operations.

Version 2.1.1 (04.04.2018)

Composer

• Fix a ConcurrentModificationException when creating new ApiComposer.Builder instances.

Version 2.1.0 (23.03.2018)

Serialization

• Update Okio to v1.14.0

RxJava 1.x Call Adapters

• RxCallAdapter has been renamed to RxObservableCallAdapter
• Add RxSingleCallAdapter to allow declaring methods that return rx.Single<T>
• Update to the latest release of the 1.x branch of RxJava

Version 2.0.0 (05.01.2018)

Protocol

• ProtocolWriter no longer implements Flushable
• BytesWriter instances can be reused for writing multiple requests.
• Internal optimizations in BytesWriter to minimize allocations
• More unit tests for BytesWriter
• ProtocolResponseReader can now directly read the data after data-enriched responses.
• Added the SCOPE_DATA scope in ProtocolResponseReader will be entered after all the values of a data-enriched response are read and the ProtocolResponseReader is at the begging of the attached data bytes.
• Add delegating implementations for ProtocolReader, ProtocolResponseReader, ProtocolRequestWriterand ProtocolWriter.

Client

• Add the ApiChannel low-level interface for writing and reading binary-encoded data to an API connection.
  • This addition exposes the lowest possible level of detail when writing/reading messages from the API by still abstracting away the details of connection establishment, TLS handshaking and so on.
  • The interface allows for pipelining of requests and reading/writing on separate threads.
  • Instances of the interface can be opened via PCloudApiClient.newChannel().

Serialization

• Move the UnserializableTypeException to the serialization module (was in the protocol module).
• Add built-in support for the char and Character primitive types.
• Add logic for serializing objects of arbitrary types that get transformed to a single value. Serializing a collection or an array of such a type will produce a single comma-separated String object containing all the serialized values converted via String.valueOf() to a their string representation.

Previously it was not possible to serialize custom types due to the unability to force an object to be serialized to a single value (e.g with a single call to ProtocolWriter.writeValue()).

Example:

    // An adapter that serializes a custom type to a single int/long/float/double/.../String primitive value
    TypeAdapter<MyType> adapter = new TypeAdapter<MyType>() {
        ...
        @Override
        public void serialize(ProtocolWriter writer, MyType value) throws IOException {
            if (value != null) {
                writer.writeValue("some value");
            }
        }
    };

	// Get an adapter for a collection or an array
    TypeAdapter<Collection<MyType>> collectionAdapter = ...

    ProtocolWriter writer = ...
    Collection<MyType> collection = ...

Calling:

   collectionAdapter.serialize(writer, collection);

is equivalent to:

writer.writeValue("some value,some value,some value");

Composer

• Allow null objects to be assigned as @Parameter-annotated method arguments.
• Allow @Parameter-annotated method arguments of arbitrary types.
• Disallow null objects to be assigned as @ResponseData-annotated method arguments.

Version 1.3.1 (10.10.2017)

Composer

• Fix a bug where a call to Call<T>.clone() or to MultiCall<T>.clone() was causing an IllegalStateException.

Version 1.3.0 (04.10.2017)

Serialization

• Enums can now be deserialized from both NUMBER and STRING protocol types.

Version 1.2.3 (21.08.2017)

• The only modification is the change of the Maven groupId property from pcloud-networking-java to com.pcloud.pcloud-networking-java. Users wanting to use this version or any other futures will need to update their dependencies list.

For Gradle users

	dependencies {
    	...
    	compile "pcloud-networking-java:composer:1.2.2"
    }

becomes

	dependencies {
    	...
    	compile "com.pcloud.pcloud-networking-java:composer:1.2.3"
    }

Version 1.2.2 (17.08.2017)

Composer

• Fix a bug leading to NullPointerException errors when calling no-arg methods of objects returned by ApiComposer.compose().

Version 1.2.1 (15.08.2017)

Client

• Add a missing getter in PCloudAPIClient for the EndpointProvider supplied by PCloudAPIClient.Builder.endpointProvider(EndpointProvider) method.

Version 1.2.0 (15.08.2017)

Client

• The ability ot set an EndpointProvider has been moved one level below in the abstraction layers and now can be set to a PCloudAPIClient instance via the PCloudAPIClient.Builder.endpointProvider() method. See the example below on how to migrate from the previous version:

EndpointProvider myEndpointProvider = new ...;

// Building an ApiComposer instance with custom EndpointProvider as of version 1.1.0 and below:
ApiComposer composer = new APiComposer.Builder()
	.endpointProvider(myEndpointProvider)
    .build();


// Setting a custom EndpointProvider for version 1.2.0 and above:
PCloudAPIClient client = PCloudAPIClient.newClient()
	.endpointProvider(myEndpointProvider)
    .create();

ApiComposer composer = new APiComposer.Builder()
	.apiClient(client)
    .build();

• EndpointProvider.endpointConnectionError() will now be properly called for errors during connection initiation and for all reads/writes.

• Request.endpoint() can now return a null Endpoint if none or null has been set via Request.Builder.endpoint(Endpoint).

• Call instances created via PCloudAPIClient.newCall(Request) for Request objects without an explictly set Endpoint, will be done to an endpoint returned by the supplied or default EndpointProiver instance.

• MultiCall instances can now created for a user-specified Endpoint via the PCloudAPIClient.newCall(List<Request>, Endpoint) method. Previous behavior was to pick up the Endpoint set to the first Request instance from the request list.

• Fixes for potential race conditions leading to NPEs when cancelling/closing Call and MultiCall instances too early.

Composer

• The ApiComposer.Builder.endpointProvider() method has been removed (see the related changes in the Client module).

Version 1.1.0 (24.07.2017)

Transformer

• Add the Transformer.Builder().addTypeAlias() method for adding type aliases. The method can be used to register concrete implementations of interface types such as in the example below:

interface Model {
...
}

class DefaultModel implements Model {
...
}

Transformer transformer = Transformer.create()
		...
		.addTypeAlias(Model.class, DefaultModel.class)
        ...
    	.build();

Version 1.0.5 (21.07.2017)

Client

• Fix a bug where PCloudAPIClient instances sharing a common ConnectionPool having different timeout settings would use recycled connections with timeouts different from the ones set via PCLoudAPIClient.Builder. The changes are entirely internal.

Version 1.0.4 (19.07.2017)

This is a maintenance release with updated documentation and removed unused classes

Utils

• Remove the unused ByteCountingSource from the utils module.
• Move FixedLengthSource from utils to the binapi-client module

Composer-Adapter-RxJava

• Remove MultiCallProducer and MultiCallOnSubscribe as they are not used anymore.

Version 1.0.3 (18.07.2017)

Composer

• Adapted interface methods will always use Endpoint.DEFAULT as endpoint, to leave the opportunity to have the final endpoint resolved from the PCloudAPIClient's EndpointProvider instance.

Version 1.0.2 (11.07.2017)

Client

• Remove the akward ConnectException thrown from RealConnection.connect(), the method will pass-through any thrown IOExceptions in its body.

Version 1.0.1 (07.07.2017)

Client

• Fix a NPE when calling Interactor.close().
• Throw IOException when calling Interactor.submitRequests() or Interactor.nextResponse() on a closed Interactor instance.
• Fix the non-respected read and write timeouts when using Call, MultiCall or Interactor objects.

Test

• Supress and fix compiler warnings in some of the test utility classes.

Version 1.0.0 (09.06.2017)

• Initial release.