com.dslplatform.client

Interface DomainProxy

public interface DomainProxy

Proxy service to remote REST-like API for basic domain operations such as searching, counting and event sourcing.

It is preferred to use domain patterns instead of this proxy service.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Searchable> java.util.concurrent.Future<java.lang.Long>	count(java.lang.Class<T> manifest) Returns a total number of domain objects.
<T extends Searchable> java.util.concurrent.Future<java.lang.Long>	count(Specification<T> specification) Returns a number of elements satisfying provided specification.
<T extends Identifiable> java.util.concurrent.Future<java.util.List<T>>	find(java.lang.Class<T> manifest, java.lang.Iterable<java.lang.String> uris) Returns a list of domain objects uniquely represented with their URIs.
<T extends Identifiable> java.util.concurrent.Future<java.util.List<T>>	find(java.lang.Class<T> manifest, java.lang.String[] uris) Returns a list of domain objects uniquely represented with their URIs.
<T extends Searchable> java.util.concurrent.Future<java.util.List<T>>	findAll(java.lang.Class<T> manifest) Returns a list of all domain objects
<T extends Searchable> java.util.concurrent.Future<java.util.List<T>>	findAll(java.lang.Class<T> manifest, java.lang.Integer limit, java.lang.Integer offset) Returns a list of all domain objects with up to limit results.
<T extends Searchable> java.util.concurrent.Future<java.util.List<T>>	findAll(java.lang.Class<T> manifest, java.lang.Integer limit, java.lang.Integer offset, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order) Returns a list of all domain objects with up to limit results.
<T extends Searchable> java.util.concurrent.Future<java.util.List<T>>	search(Specification<T> specification) Returns a list of domain objects satisfying specification
<T extends Searchable> java.util.concurrent.Future<java.util.List<T>>	search(Specification<T> specification, java.lang.Integer limit, java.lang.Integer offset) Returns a list of domain objects satisfying specification with up to limit results.
<T extends Searchable> java.util.concurrent.Future<java.util.List<T>>	search(Specification<T> specification, java.lang.Integer limit, java.lang.Integer offset, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order) Returns a list of domain objects satisfying specification with up to limit results.
<TEvent extends DomainEvent> java.util.concurrent.Future<java.lang.String>	submit(TEvent domainEvent) Send domain event to the server.
<TAggregate extends AggregateRoot,TEvent extends AggregateDomainEvent<TAggregate>> java.util.concurrent.Future<TAggregate>	submit(TEvent domainEvent, java.lang.String uri) Apply domain event to a single aggregate.

Method Detail

find

<T extends Identifiable> java.util.concurrent.Future<java.util.List<T>> find(java.lang.Class<T> manifest,
                                                                           java.lang.String[] uris)

Returns a list of domain objects uniquely represented with their URIs. Only found objects will be returned (list will be empty if no objects are found).

Parameters:

manifest - domain object class

uris - array of unique identifiers

Returns:

future to found domain objects

find

<T extends Identifiable> java.util.concurrent.Future<java.util.List<T>> find(java.lang.Class<T> manifest,
                                                                           java.lang.Iterable<java.lang.String> uris)

Returns a list of domain objects uniquely represented with their URIs. Only found objects will be returned (list will be empty if no objects are found).

Parameters:

manifest - domain object class

uris - sequence of unique identifiers

Returns:

future to found domain objects

search

<T extends Searchable> java.util.concurrent.Future<java.util.List<T>> search(Specification<T> specification,
                                                                           java.lang.Integer limit,
                                                                           java.lang.Integer offset,
                                                                           java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order)

Returns a list of domain objects satisfying specification with up to limit results. offset can be used to skip initial results. order should be given as a list of pairs of <String, Boolean> where first is a property name and second is whether it should be sorted ascending over this property.

Parameters:

specification - search predicate

limit - maximum number of results

offset - number of results to be skipped

order - custom ordering

Returns:

future to domain objects which satisfy search predicate

search

<T extends Searchable> java.util.concurrent.Future<java.util.List<T>> search(Specification<T> specification,
                                                                           java.lang.Integer limit,
                                                                           java.lang.Integer offset)

Returns a list of domain objects satisfying specification with up to limit results. offset can be used to skip initial results.

Parameters:

specification - search predicate

limit - maximum number of results

offset - number of results to be skipped

Returns:

future to domain objects which satisfy search predicate

search

<T extends Searchable> java.util.concurrent.Future<java.util.List<T>> search(Specification<T> specification)

Returns a list of domain objects satisfying specification

Parameters:

specification - search predicate

Returns:

future to domain objects which satisfy search predicate

findAll

<T extends Searchable> java.util.concurrent.Future<java.util.List<T>> findAll(java.lang.Class<T> manifest,
                                                                            java.lang.Integer limit,
                                                                            java.lang.Integer offset,
                                                                            java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order)

Returns a list of all domain objects with up to limit results. offset can be used to skip initial results. order should be given as a list of pairs of <String, Boolean> where first is a property name and second is whether it should be sorted ascending over this property.

Parameters:

manifest - domain object class

limit - maximum number of results

offset - number of results to be skipped

order - custom ordering

Returns:

future to found domain objects

findAll

<T extends Searchable> java.util.concurrent.Future<java.util.List<T>> findAll(java.lang.Class<T> manifest,
                                                                            java.lang.Integer limit,
                                                                            java.lang.Integer offset)

Returns a list of all domain objects with up to limit results. offset can be used to skip initial results.

Parameters:

manifest - domain object class

limit - maximum number of results

offset - number of results to be skipped

Returns:

future to found domain objects

findAll

<T extends Searchable> java.util.concurrent.Future<java.util.List<T>> findAll(java.lang.Class<T> manifest)

Returns a list of all domain objects

Parameters:

manifest - domain object class

Returns:

future to found domain objects

count

<T extends Searchable> java.util.concurrent.Future<java.lang.Long> count(java.lang.Class<T> manifest)

Returns a total number of domain objects.

Parameters:

manifest - domain object class

Returns:

future to number of domain objects

count

<T extends Searchable> java.util.concurrent.Future<java.lang.Long> count(Specification<T> specification)

Returns a number of elements satisfying provided specification.

Parameters:

specification - search predicate

Returns:

future to number of domain objects which satisfy specification

submit

<TEvent extends DomainEvent> java.util.concurrent.Future<java.lang.String> submit(TEvent domainEvent)

Send domain event to the server. Server will return identity under which it was stored. Events can't be modified once they are submitted. Only new events can be created.

Parameters:

domainEvent - event to raise

Returns:

future containing string value of event URI

submit

<TAggregate extends AggregateRoot,TEvent extends AggregateDomainEvent<TAggregate>> java.util.concurrent.Future<TAggregate> submit(TEvent domainEvent,
                                                                                                                                java.lang.String uri)

Apply domain event to a single aggregate. Server will return modified aggregate root. Events can't be modified once they are submitted. Only new events can be created.

Parameters:

domainEvent - event to apply

uri - aggregate root uri

Returns:

future containing modified aggregate root