Package net.dona.doip.client
Interface DoipClientInterface
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
AbstractDoipClient
,DoipClient
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
create
(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo) create
(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) void
delete
(String targetId, AuthenticationInfo authInfo) void
delete
(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) void
delete
(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) static DoipException
hello
(String targetId, AuthenticationInfo authInfo) hello
(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) listOperations
(String targetId, AuthenticationInfo authInfo) listOperations
(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) listOperations
(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) performOperation
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes) performOperation
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, com.google.gson.JsonElement input) performOperation
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, com.google.gson.JsonElement input, ServiceInfo serviceInfo) performOperation
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, ServiceInfo serviceInfo) performOperation
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, InDoipMessage input) performOperation
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, InDoipMessage input, ServiceInfo serviceInfo) performOperation
(DoipRequestHeaders headers, InDoipMessage input) performOperation
(DoipRequestHeaders headers, InDoipMessage input, ServiceInfo serviceInfo) com.google.gson.JsonElement
performOperationWithJsonResponse
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes) com.google.gson.JsonElement
performOperationWithJsonResponse
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, com.google.gson.JsonElement input, ServiceInfo serviceInfo) com.google.gson.JsonElement
performOperationWithJsonResponse
(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, ServiceInfo serviceInfo) retrieve
(String targetId, boolean includeElementData, AuthenticationInfo authInfo) retrieve
(String targetId, boolean includeElementData, AuthenticationInfo authInfo, ServiceInfo serviceInfo) retrieve
(String targetId, com.google.gson.JsonObject attributes, AuthenticationInfo authInfo, ServiceInfo serviceInfo) retrieve
(String targetId, AuthenticationInfo authInfo) retrieve
(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) retrieveElement
(String targetId, String elementId, AuthenticationInfo authInfo) retrieveElement
(String targetId, String elementId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) retrieveElement
(String targetId, String elementId, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) retrievePartialElement
(String targetId, String elementId, Long start, Long end, AuthenticationInfo authInfo) retrievePartialElement
(String targetId, String elementId, Long start, Long end, AuthenticationInfo authInfo, ServiceInfo serviceInfo) retrievePartialElement
(String targetId, String elementId, Long start, Long end, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) search
(String targetId, String query, QueryParams params, AuthenticationInfo authInfo) search
(String targetId, String query, QueryParams params, AuthenticationInfo authInfo, ServiceInfo serviceInfo) searchIds
(String targetId, String query, QueryParams params, AuthenticationInfo authInfo) searchIds
(String targetId, String query, QueryParams params, AuthenticationInfo authInfo, ServiceInfo serviceInfo) update
(DigitalObject dobj, AuthenticationInfo authInfo) update
(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo) update
(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes)
-
Method Details
-
doipExceptionFromDoipResponse
- Throws:
IOException
-
close
void close()- Specified by:
close
in interfaceAutoCloseable
-
performOperationWithJsonResponse
com.google.gson.JsonElement performOperationWithJsonResponse(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-
performOperationWithJsonResponse
com.google.gson.JsonElement performOperationWithJsonResponse(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
performOperationWithJsonResponse
com.google.gson.JsonElement performOperationWithJsonResponse(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, com.google.gson.JsonElement input, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, com.google.gson.JsonElement input) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, InDoipMessage input) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, com.google.gson.JsonElement input, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(String targetId, String operationId, AuthenticationInfo authInfo, com.google.gson.JsonObject attributes, InDoipMessage input, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(DoipRequestHeaders headers, InDoipMessage input) throws DoipException - Throws:
DoipException
-
performOperation
DoipClientResponse performOperation(DoipRequestHeaders headers, InDoipMessage input, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
create
DigitalObject create(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
create
DigitalObject create(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-
update
- Throws:
DoipException
-
update
DigitalObject update(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
update
DigitalObject update(DigitalObject dobj, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-
retrieve
- Throws:
DoipException
-
retrieve
DigitalObject retrieve(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
retrieve
DigitalObject retrieve(String targetId, boolean includeElementData, AuthenticationInfo authInfo) throws DoipException - Throws:
DoipException
-
retrieve
DigitalObject retrieve(String targetId, boolean includeElementData, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
retrieve
DigitalObject retrieve(String targetId, com.google.gson.JsonObject attributes, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
delete
- Throws:
DoipException
-
delete
void delete(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
delete
void delete(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-
listOperations
- Throws:
DoipException
-
listOperations
List<String> listOperations(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
listOperations
List<String> listOperations(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-
searchIds
SearchResults<String> searchIds(String targetId, String query, QueryParams params, AuthenticationInfo authInfo) throws DoipException - Throws:
DoipException
-
searchIds
SearchResults<String> searchIds(String targetId, String query, QueryParams params, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
search
SearchResults<DigitalObject> search(String targetId, String query, QueryParams params, AuthenticationInfo authInfo) throws DoipException - Throws:
DoipException
-
search
SearchResults<DigitalObject> search(String targetId, String query, QueryParams params, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
hello
- Throws:
DoipException
-
hello
DigitalObject hello(String targetId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
retrieveElement
InputStream retrieveElement(String targetId, String elementId, AuthenticationInfo authInfo) throws DoipException - Throws:
DoipException
-
retrieveElement
InputStream retrieveElement(String targetId, String elementId, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
retrieveElement
InputStream retrieveElement(String targetId, String elementId, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-
retrievePartialElement
InputStream retrievePartialElement(String targetId, String elementId, Long start, Long end, AuthenticationInfo authInfo) throws DoipException - Throws:
DoipException
-
retrievePartialElement
InputStream retrievePartialElement(String targetId, String elementId, Long start, Long end, AuthenticationInfo authInfo, ServiceInfo serviceInfo) throws DoipException - Throws:
DoipException
-
retrievePartialElement
InputStream retrievePartialElement(String targetId, String elementId, Long start, Long end, AuthenticationInfo authInfo, ServiceInfo serviceInfo, com.google.gson.JsonObject attributes) throws DoipException - Throws:
DoipException
-