com.orange.ngsi.client

Class NgsiClient

java.lang.Object

com.orange.ngsi.client.NgsiClient

Direct Known Subclasses:

NgsiRestClient

@Service
public class NgsiClient
extends Object

Provides methods to request a NGSI 10 v1 component (supporting JSON)

Field Summary

Fields

Modifier and Type	Field and Description
org.springframework.web.client.AsyncRestTemplate	asyncRestTemplate
org.apache.http.impl.nio.conn.PoolingNHttpClientConnectionManager	poolingNHttpClientConnectionManager
ProtocolRegistry	protocolRegistry

Constructor Summary

Constructors

Constructor and Description
NgsiClient()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.HttpHeaders	getRequestHeaders() The default HTTP request headers used for the requests.
org.springframework.http.HttpHeaders	getRequestHeaders(String url) The default HTTP request headers, depends on the host supporting xml or json
org.springframework.util.concurrent.ListenableFuture<NotifyContextResponse>	notifyContext(String url, org.springframework.http.HttpHeaders httpHeaders, NotifyContext notifyContext) Send an notify request
org.springframework.util.concurrent.ListenableFuture<NotifyContextResponse>	notifyContextCustomURL(String customURL, org.springframework.http.HttpHeaders httpHeaders, NotifyContext notifyContext) Send an notify request to a custom URL
org.springframework.util.concurrent.ListenableFuture<QueryContextResponse>	queryContext(String url, org.springframework.http.HttpHeaders httpHeaders, QueryContext queryContext) Send an query request
org.springframework.util.concurrent.ListenableFuture<RegisterContextResponse>	registerContext(String url, org.springframework.http.HttpHeaders httpHeaders, RegisterContext registerContext) Send an register request
protected <T,U> org.springframework.util.concurrent.ListenableFuture<T>	request(org.springframework.http.HttpMethod method, String url, org.springframework.http.HttpHeaders httpHeaders, U body, Class<T> responseType) Make an HTTP request
protected <T,U> org.springframework.util.concurrent.ListenableFuture<T>	request(String url, org.springframework.http.HttpHeaders httpHeaders, U body, Class<T> responseType) Default POST request
void	shutdownGracefully() Let some time for the client to shutdown gracefully
org.springframework.util.concurrent.ListenableFuture<SubscribeContextResponse>	subscribeContext(String url, org.springframework.http.HttpHeaders httpHeaders, SubscribeContext subscribeContext) Send a subscription request
org.springframework.util.concurrent.ListenableFuture<UnsubscribeContextResponse>	unsubscribeContext(String url, org.springframework.http.HttpHeaders httpHeaders, String subscriptionId) Send an unsubscription request
org.springframework.util.concurrent.ListenableFuture<UpdateContextResponse>	updateContext(String url, org.springframework.http.HttpHeaders httpHeaders, UpdateContext updateContext) Send an update request
org.springframework.util.concurrent.ListenableFuture<UpdateContextSubscriptionResponse>	updateContextSubscription(String url, org.springframework.http.HttpHeaders httpHeaders, UpdateContextSubscription updateContextSubscription) Send a update subscription request

Methods inherited from class java.lang.Object

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

Field Detail

asyncRestTemplate

@Autowired
public org.springframework.web.client.AsyncRestTemplate asyncRestTemplate

poolingNHttpClientConnectionManager

@Autowired
public org.apache.http.impl.nio.conn.PoolingNHttpClientConnectionManager poolingNHttpClientConnectionManager

protocolRegistry

@Autowired
public ProtocolRegistry protocolRegistry

Constructor Detail

NgsiClient

public NgsiClient()

Method Detail

shutdownGracefully

public void shutdownGracefully()
                        throws IOException

Let some time for the client to shutdown gracefully

Throws:

IOException

updateContext

public org.springframework.util.concurrent.ListenableFuture<UpdateContextResponse> updateContext(String url,
                                                                                                 org.springframework.http.HttpHeaders httpHeaders,
                                                                                                 UpdateContext updateContext)

Send an update request

Parameters:

url - the URL of the broker

httpHeaders - the HTTP header to use, or null for default

updateContext - the UpdateContext

Returns:

a future for an UpdateContextReponse

subscribeContext

public org.springframework.util.concurrent.ListenableFuture<SubscribeContextResponse> subscribeContext(String url,
                                                                                                       org.springframework.http.HttpHeaders httpHeaders,
                                                                                                       SubscribeContext subscribeContext)

Send a subscription request

Parameters:

url - the URL of the subscription provider

httpHeaders - the HTTP header to use, or null for default

subscribeContext - the SubscriptionContext

Returns:

a future for a SubscribeContextResponse

updateContextSubscription

public org.springframework.util.concurrent.ListenableFuture<UpdateContextSubscriptionResponse> updateContextSubscription(String url,
                                                                                                                         org.springframework.http.HttpHeaders httpHeaders,
                                                                                                                         UpdateContextSubscription updateContextSubscription)

Send a update subscription request

Parameters:

url - the URL of the subscription provider

httpHeaders - the HTTP header to use, or null for default

updateContextSubscription - the UpdateContextSubscription

Returns:

a future for a UpdateContextSubscriptionResponse

unsubscribeContext

public org.springframework.util.concurrent.ListenableFuture<UnsubscribeContextResponse> unsubscribeContext(String url,
                                                                                                           org.springframework.http.HttpHeaders httpHeaders,
                                                                                                           String subscriptionId)

Send an unsubscription request

Parameters:

url - the URL of the subscription provider

httpHeaders - the HTTP header to use, or null for default

subscriptionId - the subscription ID to unsubscribe

Returns:

a future for a UnsubscribeContextResponse

notifyContext

public org.springframework.util.concurrent.ListenableFuture<NotifyContextResponse> notifyContext(String url,
                                                                                                 org.springframework.http.HttpHeaders httpHeaders,
                                                                                                 NotifyContext notifyContext)

Send an notify request

Parameters:

url - the URL of the subscription provider

httpHeaders - the HTTP header to use, or null for default

notifyContext - the notifyContext

Returns:

a future for a NotifyContextResponse

notifyContextCustomURL

public org.springframework.util.concurrent.ListenableFuture<NotifyContextResponse> notifyContextCustomURL(String customURL,
                                                                                                          org.springframework.http.HttpHeaders httpHeaders,
                                                                                                          NotifyContext notifyContext)

Send an notify request to a custom URL

Parameters:

customURL - the URL to notify

httpHeaders - the HTTP header to use, or null for default

notifyContext - the notifyContext

Returns:

a future for a NotifyContextResponse

queryContext

public org.springframework.util.concurrent.ListenableFuture<QueryContextResponse> queryContext(String url,
                                                                                               org.springframework.http.HttpHeaders httpHeaders,
                                                                                               QueryContext queryContext)

Send an query request

Parameters:

url - the URL of the registration provider

httpHeaders - the HTTP header to use, or null for default

queryContext - the queryContext

Returns:

a future for a QueryContextResponse

registerContext

public org.springframework.util.concurrent.ListenableFuture<RegisterContextResponse> registerContext(String url,
                                                                                                     org.springframework.http.HttpHeaders httpHeaders,
                                                                                                     RegisterContext registerContext)

Send an register request

Parameters:

url - the URL of the registration consumer

httpHeaders - the HTTP header to use, or null for default

registerContext - the registerContext

Returns:

a future for a RegisterContextResponse

getRequestHeaders

public org.springframework.http.HttpHeaders getRequestHeaders()

The default HTTP request headers used for the requests.

Returns:

the HTTP request headers.

getRequestHeaders

public org.springframework.http.HttpHeaders getRequestHeaders(String url)

The default HTTP request headers, depends on the host supporting xml or json

Parameters:

url -

Returns:

the HTTP request headers.

request

protected <T,U> org.springframework.util.concurrent.ListenableFuture<T> request(String url,
                                                                                org.springframework.http.HttpHeaders httpHeaders,
                                                                                U body,
                                                                                Class<T> responseType)

Default POST request

request

protected <T,U> org.springframework.util.concurrent.ListenableFuture<T> request(org.springframework.http.HttpMethod method,
                                                                                String url,
                                                                                org.springframework.http.HttpHeaders httpHeaders,
                                                                                U body,
                                                                                Class<T> responseType)

Make an HTTP request