com.orange.ngsi.client

Class NgsiRestClient

java.lang.Object

com.orange.ngsi.client.NgsiClient

com.orange.ngsi.client.NgsiRestClient

@Service
public class NgsiRestClient
extends NgsiClient

NGSI REST convenient operations - NGSI-10 operations only - except attribute domains operations

Field Summary

Fields inherited from class com.orange.ngsi.client.NgsiClient

asyncRestTemplate, poolingNHttpClientConnectionManager, protocolRegistry

Constructor Summary

Constructors

Constructor and Description
NgsiRestClient()

Method Summary

Modifier and Type	Method and Description
org.springframework.util.concurrent.ListenableFuture<StatusCode>	appendContextAttribute(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, String attributeName, UpdateContextAttribute updateContextAttribute) Append an attribute to a context element
org.springframework.util.concurrent.ListenableFuture<AppendContextElementResponse>	appendContextElement(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, AppendContextElement appendContextElement) Append attributes to a context element
org.springframework.util.concurrent.ListenableFuture<SubscribeContextResponse>	appendContextSubscription(String url, org.springframework.http.HttpHeaders httpHeaders, SubscribeContext subscribeContext) Add a subscription
org.springframework.util.concurrent.ListenableFuture<StatusCode>	deleteContextAttribute(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, String attributeName) Retrieve an attribute of a context element
org.springframework.util.concurrent.ListenableFuture<StatusCode>	deleteContextAttributeValue(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, String attributeName, String valueID) Delete the attribute value instance of a context element
org.springframework.util.concurrent.ListenableFuture<StatusCode>	deleteContextElement(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID) Delete a context element
org.springframework.util.concurrent.ListenableFuture<UnsubscribeContextResponse>	deleteContextSubscription(String url, org.springframework.http.HttpHeaders httpHeaders, String subscriptionID) Delete a subscription
org.springframework.util.concurrent.ListenableFuture<ContextAttributeResponse>	getContextAttribute(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, String attributeName) Retrieve an attribute of a context element
org.springframework.util.concurrent.ListenableFuture<ContextAttributeResponse>	getContextAttributeValue(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, String attributeName, String valueID) Retrieve the attribute value instance of a context element
org.springframework.util.concurrent.ListenableFuture<ContextElementResponse>	getContextElement(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID) Retrieve a context element
org.springframework.util.concurrent.ListenableFuture<QueryContextResponse>	getContextEntityType(String url, org.springframework.http.HttpHeaders httpHeaders, String typeName) Retrieve a context entity type
org.springframework.util.concurrent.ListenableFuture<QueryContextResponse>	getContextEntityTypeAttribute(String url, org.springframework.http.HttpHeaders httpHeaders, String typeName, String attributeName) Retrieve a context entity type attribute
org.springframework.util.concurrent.ListenableFuture<StatusCode>	updateContextAttribute(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, String attributeName, UpdateContextAttribute updateContextAttribute) Update the attribute of a context element
org.springframework.util.concurrent.ListenableFuture<StatusCode>	updateContextAttributeValue(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, String attributeName, String valueID, UpdateContextAttribute updateContextAttribute) Update the attribute value instance of a context element
org.springframework.util.concurrent.ListenableFuture<UpdateContextElementResponse>	updateContextElement(String url, org.springframework.http.HttpHeaders httpHeaders, String entityID, UpdateContextElement updateContextElement) Append attributes to a context element
org.springframework.util.concurrent.ListenableFuture<UpdateContextSubscriptionResponse>	updateContextSubscription(String url, org.springframework.http.HttpHeaders httpHeaders, String subscriptionID, UpdateContextSubscription updateContextSubscription) Update a subscription

Methods inherited from class com.orange.ngsi.client.NgsiClient

getRequestHeaders, getRequestHeaders, notifyContext, notifyContextCustomURL, queryContext, registerContext, request, request, shutdownGracefully, subscribeContext, unsubscribeContext, updateContext, updateContextSubscription

Methods inherited from class java.lang.Object

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

Constructor Detail

NgsiRestClient

public NgsiRestClient()

Method Detail

appendContextElement

public org.springframework.util.concurrent.ListenableFuture<AppendContextElementResponse> appendContextElement(String url,
                                                                                                               org.springframework.http.HttpHeaders httpHeaders,
                                                                                                               String entityID,
                                                                                                               AppendContextElement appendContextElement)

Append attributes to a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

appendContextElement - attributes to append

Returns:

a future for an AppendContextElementResponse

updateContextElement

public org.springframework.util.concurrent.ListenableFuture<UpdateContextElementResponse> updateContextElement(String url,
                                                                                                               org.springframework.http.HttpHeaders httpHeaders,
                                                                                                               String entityID,
                                                                                                               UpdateContextElement updateContextElement)

Append attributes to a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

updateContextElement - attributes to update

Returns:

a future for an UpdateContextElementResponse

getContextElement

public org.springframework.util.concurrent.ListenableFuture<ContextElementResponse> getContextElement(String url,
                                                                                                      org.springframework.http.HttpHeaders httpHeaders,
                                                                                                      String entityID)

Retrieve a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

Returns:

a future for a ContextElementResponse

deleteContextElement

public org.springframework.util.concurrent.ListenableFuture<StatusCode> deleteContextElement(String url,
                                                                                             org.springframework.http.HttpHeaders httpHeaders,
                                                                                             String entityID)

Delete a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

Returns:

a future for a StatusCode

appendContextAttribute

public org.springframework.util.concurrent.ListenableFuture<StatusCode> appendContextAttribute(String url,
                                                                                               org.springframework.http.HttpHeaders httpHeaders,
                                                                                               String entityID,
                                                                                               String attributeName,
                                                                                               UpdateContextAttribute updateContextAttribute)

Append an attribute to a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

attributeName - the name of the attribute

updateContextAttribute - attribute to append

Returns:

a future for a StatusCode

updateContextAttribute

public org.springframework.util.concurrent.ListenableFuture<StatusCode> updateContextAttribute(String url,
                                                                                               org.springframework.http.HttpHeaders httpHeaders,
                                                                                               String entityID,
                                                                                               String attributeName,
                                                                                               UpdateContextAttribute updateContextAttribute)

Update the attribute of a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

attributeName - the name of the attribute

updateContextAttribute - attribute to update

Returns:

a future for a StatusCode

getContextAttribute

public org.springframework.util.concurrent.ListenableFuture<ContextAttributeResponse> getContextAttribute(String url,
                                                                                                          org.springframework.http.HttpHeaders httpHeaders,
                                                                                                          String entityID,
                                                                                                          String attributeName)

Retrieve an attribute of a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

attributeName - the name of the attribute

Returns:

a future for a ContextAttributeResponse

deleteContextAttribute

public org.springframework.util.concurrent.ListenableFuture<StatusCode> deleteContextAttribute(String url,
                                                                                               org.springframework.http.HttpHeaders httpHeaders,
                                                                                               String entityID,
                                                                                               String attributeName)

Retrieve an attribute of a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

attributeName - the name of the attribute

Returns:

a future for a StatusCode

updateContextAttributeValue

public org.springframework.util.concurrent.ListenableFuture<StatusCode> updateContextAttributeValue(String url,
                                                                                                    org.springframework.http.HttpHeaders httpHeaders,
                                                                                                    String entityID,
                                                                                                    String attributeName,
                                                                                                    String valueID,
                                                                                                    UpdateContextAttribute updateContextAttribute)

Update the attribute value instance of a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

attributeName - the name of the attribute

valueID - the instant ID of the attribute

updateContextAttribute - attribute values to update

Returns:

a future for a StatusCode

getContextAttributeValue

public org.springframework.util.concurrent.ListenableFuture<ContextAttributeResponse> getContextAttributeValue(String url,
                                                                                                               org.springframework.http.HttpHeaders httpHeaders,
                                                                                                               String entityID,
                                                                                                               String attributeName,
                                                                                                               String valueID)

Retrieve the attribute value instance of a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

attributeName - the name of the attribute

valueID - the instant ID of the attribute

Returns:

a future for a ContextAttributeResponse

deleteContextAttributeValue

public org.springframework.util.concurrent.ListenableFuture<StatusCode> deleteContextAttributeValue(String url,
                                                                                                    org.springframework.http.HttpHeaders httpHeaders,
                                                                                                    String entityID,
                                                                                                    String attributeName,
                                                                                                    String valueID)

Delete the attribute value instance of a context element

Parameters:

url - the URL of the broker

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

entityID - the ID of the entity

attributeName - the name of the attribute

valueID - the instant ID of the attribute

Returns:

a future for a StatusCode

getContextEntityType

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

Retrieve a context entity type

Parameters:

url - the URL of the broker

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

typeName - the name of the entity type

Returns:

a future for a ContextElementResponse

getContextEntityTypeAttribute

public org.springframework.util.concurrent.ListenableFuture<QueryContextResponse> getContextEntityTypeAttribute(String url,
                                                                                                                org.springframework.http.HttpHeaders httpHeaders,
                                                                                                                String typeName,
                                                                                                                String attributeName)

Retrieve a context entity type attribute

Parameters:

url - the URL of the broker

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

typeName - the name of the entity type

attributeName - the name of the attribute

Returns:

a future for a ContextElementResponse

appendContextSubscription

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

Add a subscription

Parameters:

url - the URL of the broker

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

subscribeContext - the parameters for subscription

Returns:

a future for an SubscribeContextResponse

updateContextSubscription

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

Update a subscription

Parameters:

url - the URL of the broker

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

subscriptionID - the ID of the subscription to update

updateContextSubscription - the parameters to update

Returns:

a future for an UpdateContextSubscriptionResponse

deleteContextSubscription

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

Delete a subscription

Parameters:

url - the URL of the broker

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

subscriptionID - the ID of the subscription to delete

Returns:

a future for an UnsubscribeContextResponse