|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectWSCall
org.gcube.contentmanagement.contentmanager.stubs.calls.BaseCall
org.gcube.contentmanagement.contentmanager.stubs.calls.ManagerCall
org.gcube.contentmanagement.contentmanager.stubs.calls.WriteManagerCall
public class WriteManagerCall
A high-level call to the WriteManager port-type of the Content Manager service.
A WriteManagerCall
call may target known service instances or else do its best
to find and talk with those which have the required properties.
It may be used repeatedly and it will remember the service instance it last used successfully.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.gcube.contentmanagement.contentmanager.stubs.calls.ManagerCall |
---|
ManagerCall.DiscoveryException |
Constructor Summary | |
---|---|
WriteManagerCall(GCUBEScope scope,
GCUBESecurityManager... securityManager)
Creates an instance to use in a given scope and, optionally, with a given a security manager. |
|
WriteManagerCall(java.lang.String collectionID,
GCUBEScope scope,
GCUBESecurityManager... securityManager)
Creates an instance to use for a certain collection, in a given scope and, optionally, with a given a security manager. |
Method Summary | |
---|---|
java.lang.String |
add(org.w3c.dom.Element doc)
Adds a document to the target collection. |
java.lang.String |
add(GDoc doc)
Adds a document to the target collection. |
java.net.URI |
add(java.net.URI locator)
Adds zero or more documents to the target collection. |
void |
update(GDoc doc)
Updates a document in the target collection. |
java.net.URI |
update(java.net.URI locator)
Updates zero or more documents in the target collection. |
Methods inherited from class org.gcube.contentmanagement.contentmanager.stubs.calls.ManagerCall |
---|
getCollectionID, resetQuery, setCollectionID |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WriteManagerCall(GCUBEScope scope, GCUBESecurityManager... securityManager) throws java.lang.Exception
scope
- the scope.securityManager
- (optional) the security manager.
java.lang.Exception
- if the instance could not be created.public WriteManagerCall(java.lang.String collectionID, GCUBEScope scope, GCUBESecurityManager... securityManager) throws java.lang.Exception
collectionID
- the collection identifier.scope
- the scope.securityManager
- (optional) the security manager.
java.lang.Exception
- if the instance could not be created.Method Detail |
---|
public java.lang.String add(GDoc doc) throws java.lang.Exception, ManagerCall.DiscoveryException, InvalidDocumentException, GCUBEException
doc
- the document.
java.lang.Exception
- if the document could not be added to the target collection due to a local error.
DiscoveryException
- if a Write Manager for the target collection could not be found.
InvalidDocumentException
- if the document is invalid.
java.lang.Exception
- if the document could not be added to the target collection due to a general local error.
GCUBEException
- if the document could not be added to the target collection due to a general remote error.
ManagerCall.DiscoveryException
public java.lang.String add(org.w3c.dom.Element doc) throws java.lang.Exception, ManagerCall.DiscoveryException, InvalidDocumentException, GCUBEException
doc
- the (DOM representation of the) document.
DiscoveryException
- if a Write Manager for the target collection could not be found.
InvalidDocumentException
- if the document is invalid.
java.lang.Exception
- if the document could not be added to the target collection due to a general local error.
GCUBEException
- if the document could not be added to the target collection due to a general remote error.
ManagerCall.DiscoveryException
public java.net.URI add(java.net.URI locator) throws java.lang.Exception, ManagerCall.DiscoveryException, GCUBEException
a
- locator to a ResultSet of of gDoc
documents.
AddOutcome
s.
java.lang.Exception
- if the document could not be added to the target collection due to a local error.
DiscoveryException
- if a Write Manager for the target collection could not be found.
GCUBEException
- if the document could not be added to the target collection due to a remote error.
ManagerCall.DiscoveryException
public void update(GDoc doc) throws java.lang.Exception, ManagerCall.DiscoveryException, InvalidDocumentException, UnknownDocumentException, GCUBEException
doc
- the delta document that captures the update.
java.lang.Exception
- if the document could not be added to the target collection due to a local error.
DiscoveryException
- if a Write Manager for the target collection could not be found.
InvalidDocumentException
- if the delta document is invalid.
UnknownDocumentException
- if the document is unknown (cannot be identified from the delta document).
GCUBEException
- if the document could not be added to the target collection due to a remote error.
ManagerCall.DiscoveryException
public java.net.URI update(java.net.URI locator) throws java.lang.Exception, ManagerCall.DiscoveryException, GCUBEException
locator
- a locator to a ResultSet of delta documents that capture the updates.
UpdateFailure
s.
java.lang.Exception
- if the document could not be added to the target collection due to a local error.
DiscoveryException
- if a Write Manager for the target collection could not be found.
GCUBEException
- if the document could not be added to the target collection due to a remote error.
ManagerCall.DiscoveryException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |