io.katharsis.client

Class KatharsisClient

java.lang.Object

io.katharsis.client.KatharsisClient

public class KatharsisClient
extends Object

Client implementation giving access to JSON API repositories using stubs.

Constructor Summary

Constructors

Constructor and Description
KatharsisClient(ServiceUrlProvider serviceUrlProvider)
KatharsisClient(String serviceUrl)

Method Summary

Modifier and Type	Method and Description
void	addModule(Module module) Adds the given module.
ActionStubFactory	getActionStubFactory()
ClientDocumentMapper	getDocumentMapper()
ExceptionMapperRegistry	getExceptionMapperRegistry()
HttpAdapter	getHttpAdapter()
ModuleRegistry	getModuleRegistry()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
boolean	getPushAlways()
<R extends RelationshipRepositoryV2<?,?,?,?>> R	getQueryParamsRelationshipRepository(Class<R> repositoryInterfaceClass) Deprecated. make use of QuerySpec
<T,I extends Serializable> ResourceRepositoryStub<T,I>	getQueryParamsRepository(Class<T> resourceClass) Deprecated. make use of QuerySpec
<T,I extends Serializable,D,J extends Serializable> RelationshipRepositoryStub<T,I,D,J>	getQueryParamsRepository(Class<T> sourceClass, Class<D> targetClass) Deprecated. make use of QuerySpec
<T,I extends Serializable> ResourceRepositoryV2<T,I>	getQuerySpecRepository(Class<T> resourceClass) Deprecated. make use of getRepositoryForType()
<T,I extends Serializable,D,J extends Serializable> RelationshipRepositoryV2<T,I,D,J>	getQuerySpecRepository(Class<T> sourceClass, Class<D> targetClass) Deprecated. make use of getRepositoryForType()
ResourceRegistry	getRegistry()
<R extends ResourceRepositoryV2<?,?>> R	getRepositoryForInterface(Class<R> repositoryInterfaceClass)
<T,I extends Serializable> ResourceRepositoryV2<T,I>	getRepositoryForType(Class<T> resourceClass)
<T,I extends Serializable,D,J extends Serializable> RelationshipRepositoryV2<T,I,D,J>	getRepositoryForType(Class<T> sourceClass, Class<D> targetClass)
<R extends ResourceRepositoryV2<?,?>> R	getResourceRepository(Class<R> repositoryInterfaceClass) Deprecated. Make use of getRepositoryForInterface.
protected void	init()
void	setActionStubFactory(ActionStubFactory actionStubFactory) Sets the factory to use to create action stubs (like JAX-RS annotated repository methods).
void	setHttpAdapter(HttpAdapter httpAdapter)
void	setProxyFactory(ClientProxyFactory proxyFactory)
void	setPushAlways(boolean pushAlways) Older KatharsisClient implementation only supported a save() operation that POSTs the resource to the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KatharsisClient

public KatharsisClient(String serviceUrl)

KatharsisClient

public KatharsisClient(ServiceUrlProvider serviceUrlProvider)

Method Detail

setProxyFactory

public void setProxyFactory(ClientProxyFactory proxyFactory)

setPushAlways

public void setPushAlways(boolean pushAlways)

Older KatharsisClient implementation only supported a save() operation that POSTs the resource to the server. No difference is made between insert and update. The server-implementation still does not make a difference. By default the flag is enabled to maintain backward compatibility. But it is strongly adviced to turn id on. It will become the default in one of the subsequent releases.

Parameters:

pushAlways -

getPushAlways

public boolean getPushAlways()

init

protected void init()

getResourceRepository

@Deprecated
public <R extends ResourceRepositoryV2<?,?>> R getResourceRepository(Class<R> repositoryInterfaceClass)

Deprecated. Make use of getRepositoryForInterface.

getRepositoryForInterface

public <R extends ResourceRepositoryV2<?,?>> R getRepositoryForInterface(Class<R> repositoryInterfaceClass)

getQueryParamsRelationshipRepository

@Deprecated
public <R extends RelationshipRepositoryV2<?,?,?,?>> R getQueryParamsRelationshipRepository(Class<R> repositoryInterfaceClass)

Deprecated. make use of QuerySpec

getQueryParamsRepository

@Deprecated
public <T,I extends Serializable> ResourceRepositoryStub<T,I> getQueryParamsRepository(Class<T> resourceClass)

Deprecated. make use of QuerySpec

Parameters:

resourceClass - resource class

Returns:

stub for the given resourceClass

getRepositoryForType

public <T,I extends Serializable> ResourceRepositoryV2<T,I> getRepositoryForType(Class<T> resourceClass)

Parameters:

resourceClass - resource class

Returns:

stub for the given resourceClass

getQuerySpecRepository

@Deprecated
public <T,I extends Serializable> ResourceRepositoryV2<T,I> getQuerySpecRepository(Class<T> resourceClass)

Deprecated. make use of getRepositoryForType()

getQueryParamsRepository

public <T,I extends Serializable,D,J extends Serializable> RelationshipRepositoryStub<T,I,D,J> getQueryParamsRepository(Class<T> sourceClass,
                                                                                                                        Class<D> targetClass)

Deprecated. make use of QuerySpec

Parameters:

sourceClass - source class

targetClass - target class

Returns:

stub for the relationship between the given source and target class

getRepositoryForType

public <T,I extends Serializable,D,J extends Serializable> RelationshipRepositoryV2<T,I,D,J> getRepositoryForType(Class<T> sourceClass,
                                                                                                                  Class<D> targetClass)

Parameters:

sourceClass - source class

targetClass - target class

Returns:

stub for the relationship between the given source and target class

getQuerySpecRepository

@Deprecated
public <T,I extends Serializable,D,J extends Serializable> RelationshipRepositoryV2<T,I,D,J> getQuerySpecRepository(Class<T> sourceClass,
                                                                                                                                Class<D> targetClass)

Deprecated. make use of getRepositoryForType()

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Returns:

objectMapper in use

setHttpAdapter

public void setHttpAdapter(HttpAdapter httpAdapter)

getRegistry

public ResourceRegistry getRegistry()

Returns:

resource repository use.

addModule

public void addModule(Module module)

Adds the given module.

Parameters:

module -

getHttpAdapter

public HttpAdapter getHttpAdapter()

getExceptionMapperRegistry

public ExceptionMapperRegistry getExceptionMapperRegistry()

getActionStubFactory

public ActionStubFactory getActionStubFactory()

setActionStubFactory

public void setActionStubFactory(ActionStubFactory actionStubFactory)

Sets the factory to use to create action stubs (like JAX-RS annotated repository methods).

Parameters:

actionStubFactory - to use

getModuleRegistry

public ModuleRegistry getModuleRegistry()

getDocumentMapper

public ClientDocumentMapper getDocumentMapper()