Content Manager Library
The Content Manager Library offers linguistic abstractions over the content model and interface of the Content Manager service . In this role, it acts both as a client library and as a service-side library for plugin developments. In particular, it is a dependency of the service as well as a dependency of service clients.
The library includes:
- the API for
gDoc
trees; - the API for
gDoc
tree predicates; - the stubs of the service automatically generated from the WSDL definition of its port-types;
- the high-level calls, a set of abstractions over the service stubs;
- a Java protocol handler and associated facilities for deriving and resolving content URIs, i.e. resolvable URIs to arbitrary nodes of
gDoc
trees.
We have previously presented most of the APIs for gDoc
trees and tree predicates. We concentrate here on high-level calls and content URIs, completing the presentation of the tree and tree predicate APIs in the process.
Contents
High-Level Calls
High-level calls are Java objects that model single-step or multi-step interactions with the Content Management service. The objects encapsulate stub-based interactions behind local object-oriented interfaces that offer transparencies over the remote interfaces of the service port-types.
The local interfaces are based on language features that are not found in the service stubs, including high-level models of inputs and outputs, method overloading, parametric types, asynchronous callbacks.
Behind these abstractions, the call objects engage in optimised and best-effort interactions with the WS-Resources of the services; in particular, they can hide from clients the complexity of resource discovery while keeping visible the remote nature of the interactions and the possibility of their failure.
High-level calls are defined in the package org.gcube.contentmanagement.contentmanager.stubs.calls
and in the package org.gcube.contentmanagement.contentmanager.stubs.calls.iterators
. The main components are depicted below:
-
BaseCall
: the base class for all high-level calls. -
FactoryCall
: aBaseCall
that represents calls to theFactory
resource of the service. -
FactoryParams
: used inFactoryCall
to model the input of operations to theFactory
resource of the service. -
FactoryConsumer
: used inFactoryCall
to callback invokers of the asynchronous operation of theFactory
resource of the service. -
ManagerCall
: an abstract extension ofBaseCall
for calls to the Collection Managers of the service. -
ReadManagerCall
: aManagerCall
that represents calls toReadManager
resources of the service. -
WriteManagerCall
: aManagerCall
that represents calls toWriteManager
resources of the service. -
AdminCalls
: a set of static facilities to delete collection managers of both of either type at individual instances as well as across the system in a given scope. -
MappingRegistry
: a central registry of type mappings for I/O. -
Constants
: a collection of service-specific constants. -
Utils
: a collection of utilities for I/O conversions.
-
BaseRSIterators<T>
: the base class for all iterators backed by a ResultSet of records that can be parsed by aResultSetParser<T>
.
-
ResultParser<T>
: a parser of ResultSet records into objects of typeT
. -
GDocParser
: aResultParser
ofgDoc
trees that uses thegDoc
native API. -
NodeParser
: aResultParser
ofgDoc
tree nodes that uses thegDoc
native API. -
AddOutcomeParser
: aResultParser
ofAddOutcome
s. -
UpdateFailureParser
: aResultParser
ofUpdateFailureOutcome
s.
-
RSIterator<T>
: aBaseRSIterator
that delivers parsing failures synchronously. -
RSIterator<GDoc>
: aRSIterator
that uses aGDocParser
. -
RSIterator<Node>
: aRSIterator
that uses aNodeParser
.
-
AsyncRSIterator<T>
: aBaseRSIterator
that tolerates parsing failures and delivers them asynchronously, to aFaultReader
. -
FaultReader
: a processor of parsing failures during ResultSet iterations.
-
RSCollection<T>
: a lazy collection that can iterated over by aAsyncRSIterator<T>
. -
GDocRSCollection
: anRSCollection
that uses aAsyncRSIterator<GDoc>
. -
NodeRSCollection
: anRSCollection
that uses aAsyncRSIterator<Node>
.
In what follows, we exemplify the use of FactoryCall
s, ReadManagerCall
s, and WriteManagerCalls
.
Factory Calls
A FactoryCall
is created in a a scope:
//some scope GCUBEScope scope = ..... FactoryCall call = new FactoryCall(scope);
In a secure infrastructure, the call may also be created with a security manager:
//some scope GCUBEScope scope = ..... //some security manager = .... GCUBESecurityManager manager = .... FactoryCall call = new FactoryCall(scope,manager);
The call may then be issued, i.e. used to create CollectionManagers. In line with the operations of the remote port-type, this can be done synchronously or asynchronously.
The synchronous invocation requires the preparation of FactoryParameters
;
FactoryParameters params = new FactoryParameters() ; params.setPlugin("..somepluginname..."); params.setBroadcast(false); //the DOM serialisation of plugin-specific creation parameters org.w3c.dom.Element payload = ... params.setPayload(payload) //issue the call List<CollectionReference> references = call.create(params); //process the response for (CollectionReference ref : references) .... ref.getCollectionID() ... ref.getReader() ... ref.getWriter() ... //endpoint references, at least one will be not null
note: typically, plugin will offer object bindings for the payloads that they support. The payload input to the |
The asynchronous invocation requires the additional preparation of a FactoryConsumer
:
//prepare as above FactoryParameters params = ..... //creates consumer FactoryConsumer consumer = new FactoryConsumer { protected void onCompletion(List<CollectionReference> references) { .... process references as above }; protected void onFailure(Exception e) { ... handle failure }; }; //issue the call call.createASync(params,consumer);
In both interactions above, the FactoryCall
will attempt to discover Factory
WS-Resources that host the plugin named in the parameters. It will then try to interact with each resource in turn, until one responds successfully or else indicates that continuing will be to no avail (by returning a GCUBEUnretrievableFault
).
note: clients can obtain and customise the query that underlies the strategy (cf. note: while call objects are often created anew for individual calls to the remote port-type, clients can use the same object for multiple calls (though this is unlikely for |
Clients who know and wish to target a specific Factory
resource, can disable the best-effort strategy by configuring the call with a reference to its endpoint:
//a reference to the endpoint of a Content Manager RI EndpointReferenceType epr = ... call.setEndpointReferenceType(epr); //alternatively: call.setEndpoint("... somehostname ...",".. someport ..");
ReadManager Calls
A ReadManagerCall
gives high-level write access to the content of a given collection, as allowed by a ReadManager
resource bound to that collection.
It follows the same patterns already illustrated for FactoryCall
s. In particular, it is created in a scope and, optionally, with a security manager.
//some scope GCUBEScope scope = ..... ReadManagerCall call = new ReadManagerCall(scope); //some security manager = .... GCUBESecurityManager manager = .... ReadManagerCall secureCall = new ReadManagerCall(scope,manager);
As a further option, it may be crated with the identifier of the target collection:
//some scope GCUBEScope scope = ..... ReadManagerCall call = new ReadManagerCall("... some collection identifier ...",scope); //some security manager = .... GCUBESecurityManager manager = .... ReadManagerCall secureCall = new ReadManagerCall("... some collection identifier ...",scope,manager);
note: the collection identifier may also be set after call construction (cf. |
The call object may be configured as a FactoryCall
, i.e. setting reference to resource endpoint for targeted interactions (cf. setEndpointReference(EndpointReference)
), or else relying on implicit discovery and best-effort strategy. In the latter case, the query that underlie the strategy can be customised and reset (cf. getQuery()
,resetQuery()
).
Document Lookups
The call object may then be used to retrieve gDoc
trees from the target collection. To this end, its operations may be classified in two groups: the those that return single trees and those that return multiple trees. The first class includes lookup operations while the second class includes both lookup and query operations based on tree predicates. Multi-valued operations are execute asynchronously at the service, based on the ResultSet mechanism.
The following example illustrates the use single-valued lookups:
//synchronous: return one gDoc tree GDoc doc1 = call.get("... tree root identifier ..."); //some tree predicate to use for pruning Predicate projection = .... //synchronous: prune and return one gDoc tree GDoc doc2 = call.get("... tree root identifier ...",projection);
Here, get(String)
and get(String,Predicate)
bind the output tree to the object model of gDoc
tree API.
We note that there are semantically equivalent operations that return DOM bindings, so as to raise no further parsing costs if a binding other than to the gDoc
tree API is required upstream (cf. getAsElement(String)
and getAsElement(String,Predicate)
).
Muti-valued lookups may be exemplified as follows:
//a locator to a ResultSet of tree root identifiers, produced using standard ResultSet production idioms RSLocator identifiers = .... //asynchronous: returns a locator to a remote ResultSet of gDoc trees with given identifiers RSLocator locator1 = call.get(identifiers); //asynchronous: returns a locator to a remote ResultSet of gDoc trees with given identifiers, pruned by a tree predicate RSLocator locator2 = call.get(identifiers,predicate);
Iterators and Collections
The ResultSets returned by the lookups contain XML representations of gDoc
trees. Standard ResultSet consumption idioms may then be used to extract the XML representations and bind them to object models of choice. The library supports more transparent idioms, however:
//a locator to a ResultSet of gDoc trees. RSLocator locator = .... GDocRSCollection docs = new GDocRSCollection(locator); //use standard for (GDoc doc : doc) ...process document...
Here, GDocRSCollection
is a collection of gDoc
trees which is backed by the ResultSet identified by the locator. The collection is 'lazily' assembled, in that it does not allow direct access to its elements, but can only be iterated over with standard language idioms, as shown. The iteration subsumes XML bindings to the native object model and hides binding failures in the process. Clients that wish to process failures can do so asynchronously with respect to the iteration, by previously registering a FaultListener
with the collection (e.g. at construction time):
//a locator to a ResultSet of gDoc trees. RSLocator locator = .... FaultListener listener = new FaultListener() { @Override void onFault(String unparsedResult, Throwable failure) {...process failure...} } GDocRSCollection docs = new GDocRSCollection(locator, listener); for (GDoc doc : doc) ...process document...
note: a note: a |
Clients which are not well-served by the asynchronous delivery of failures can instead opt for a GDocRSIterator
, which again offers binding transparencies but delivers failures synchronously:
//a locator to a ResultSet of gDoc trees. RSLocator locator = .... GDocRSIterator it = new GDocRSCollection(iterator); while (it.hasNext) { ... try { GDoc doc = it.next(); ....process document... } catch (Throwable failure) { ...handle failure... } ... }
note: |
Node Lookups
Single-valued and multi-valued lookups apply also to inner nodes of gDoc
documents, not only to the documents themselves. What identifies such nodes is a now the path of identifiers that connect them to the document roots. Often, these paths are distributed within content URIs (see below). The following examples illustrate:
//a path to node 3 into document 1 String[] ids = {"1","2","3"}; //synchronous: return one gDoc tree node Node node = call.getNode(ids); //starting from some content URI URI contentURI = .... //synchronous: return one gDoc tree node Node node = call.getNode(URIs.getNodeIDs(contentURI)); //in bulk now, construct a RS of paths from uris //assume we have URIs in memory List<URI> uris =....; RSXMLWriter writer = RSXMLWriter.getRSXMLWriter(); //populate RS for (URI uri : uris) writer.addResults(URIs.toRSElement(uri)); //hiding conversions URIs-serialised paths here writer.close(); //get locator, somewhere RSLocator paths = writer.getRSLocator(...); //prepare call ReadManagerCall call = new ReadManagerCall(...some collection id...,...some scope....); call.setEndpointReference(...some reader 's endpoint...); RSLocator nodes =call.getNodes(paths); //use abstractions above to process nodes, e.g. RS-backed collections for (Node node : new NodeRSCollection(nodeLocator,2)) ...node...
Projections
Finally, we give an example of queries for gDoc
trees:
//asynchronous: return a locator to a remote ResultSet of many gDoc trees pruned by a tree predicate RSLocator locator3 = call.get(projection); //some tree predicate to use for filtering Predicate filter = .... //asynchronous: return a locator to a remote ResultSet of many pruned gDoc trees that satisfy a given filter RSLocator locator4= call.get(projection,filter); //asynchronous: return a locator to a remote ResultSet of all the gDoc trees in the collection RSLocator locator5 = call.get();
Again, the ResultSets returned by the queries can be consumed with standard ResultSet consumption idioms as well as with RS-backed iterators and collections discussed above.
WriteManager Calls
A WriteManagerCall
gives high-level write access to the content of a given collection, as allowed by a WriteManager
resource bound to that collection.
It follows the same patterns already seen for FactoryCall
s. In particular, it is created in a scope and, optionally, with a security manager:
//some scope GCUBEScope scope = ..... WriteManagerCall call = new WriteManagerCall(scope); //some security manager = .... GCUBESecurityManager manager = .... WriteManagerCall secureCall = new WriteManagerCall(scope,manager);
As a further option, it may be crated with the identifier of the target collection:
//some scope GCUBEScope scope = ..... WriteManagerCall call = new WriteManagerCall("... some collection identifier ...",scope); //some security manager = .... GCUBESecurityManager manager = .... ReadManagerCall secureCall = new WriteManagerCall("... some collection identifier ...",scope,manager);
note: the collection identifier may also be set after call construction (cf. |
The call may be configured as a FactoryCall
, i.e. setting reference to resource endpoint for targeted interactions (cf. setEndpointReference(EndpointReference)
). or else relying on implicit discovery and best-effort strategy; in the latter case, the query that underlie the strategy can be customised (cf. getQuery()
,resetQuery()
).
The call may then be used to add or update individual or multiple gDoc
trees into the target collection. Additions and updates can be applied to individual trees as well as in bulk. In the latter case, the changes are applied by the service asynchronously, based on the ResultSet mechanism.
Adding Documents
Additions operations may be illustrated as follows:
//A gDoc tree without identifiers GDoc doc = .... //synchronous: adds a gDoc tree and receives the identifier assigned to its root String rootID = call.add(doc); //a locator to a ResultSet of gDoc trees without identifiers. RSLocator locator1 = .... //asynchronous: adds many gDoc trees and receives a locator to a remote ResultSet of AddOutcome objects (see WSDL) RSLocator locator2 = call.add(locator);
Here, add(Gdoc)
requires a binding of the input tree to the object model of gDoc
tree API.
There is semantically equivalent operation that takes DOM bindings, so as to raise no further serialisation costs if a binding other than to the gDoc
tree API is already used upstream (cf. getAsElement(String)
and add(Element)
).
The ResultSet returned by the second method may be consumed with standard ResultSet idioms but, as already shown for ReadManager calls, RSCollection<T>
and RSIterator<T>
are more convenient options. In particular, the library offers a AddOutcomeParser
to use in conjunction with RSCollection<AddOutcome>
or RSIterator<AddOutcome>
:
//A locator to ResultSet of AddOutcomes RSLocator locator = ... //may also set a FaultListener, if required RSCollection<AddOutcome> outcomes = new RSCollection<AddOutcome>(locator, new AddOutcomeParser()); for (AddOutcome outcome : outcomes) ...process outcomes... //or, alternatively.. RSIterator<AddOutcome> it = new RSIterator<AddOutcome>(locator, new AddOutcomeParser()); while (it.hasNext() { ... try { AddOutcome outcome = it.next(); ... process outcome... } catch(Throwable failure) { ...handle failure... } }
note: since the |
Updating and Deleting Documents
The next example illustrates update operations, which rely on the notion of delta document:
//A delta tree GDoc delta = .... //synchronous: updates the document with a delta tree call.update(delta); //a locator to a ResultSet of DOM representations of delta trees. RSLocator deltas = ... //asynchronous: updates zero or more documents with corresponding delta trees and receives a locator to a ResultSet of UpdateFailure objects (see WSDL) RSLocator locator3 = call.update(deltas);
As for the add
operations, consuming the ResultSet can conveniently rely on appropriate type specialisation of RSCollection<T>
and RSIterator<T>
. In particular, the library offers a UpdateFailureParser
to use in conjunction with RSCollection<UpdateFailure>
or RSIterator<UpdateFailure>
:
//A locator to ResultSet of UpdateFailures RSLocator locator = ... //may also set a FaultListener, if required RSCollection<UpdateFailure> failures = new RSCollection<UpdateFailure>(locator, new UpdateFailureParser()); for (UpdateFailure failure : failures) ...process failure... //or, alternatively.. RSIterator<UpdateFailure> it = new RSIterator<UpdateFailure>(locator, new UpdateFailureParser()); while (it.hasNext() { ... try { UpdateFailure failure = it.next(); ... process failure... } catch(Throwable f) { ...handle iteration failure... } }
A difficulty in issuing updates is to produce the corresponding delta documents. To this end, the gDoc
tree API offers a method delta(GDoc)
on its GDoc
class for root nodes. The method takes the root of a second gDoc
tree and computes the delta document between the two trees in the assumption that the second tree represents the evolution of the first under update (i.e. its future version).
Computing Delta Documents
Accordingly, the API supports the following 'clone-change-compare' model of update at the client-side:
- the client clones trees;
- the client updates the clones;
- the client computes and uses delta documents between the original trees and the evolved clones;
The following example illustrates the model:
//original tree, as obtained from the service, directly or indirectly. GDoc doc = ..... //use copy-constructor to clone the tree GDoc clone = new GDoc(doc); ... update the clone ... //compute delta document GDoc delta = doc.delta(clone); ... use delta in update operations ...
note: note: the model does not require that the clone is updated using the |
Admin Calls
Sufficiently privileged users can issue administrative calls to destroy collection managers resources in the system. Grouped as static methods in the AdminCalls
class, the calls can be used to complement the actions taken autonomically by running instances of the Content Manager service to react to the removal of collection profiles in the Information System.
Administrative calls allow to destroy managers of both types as well as of a given type (only ReadManager
s, only WriteManager
s, both). In addition, they can do so targeting a particular instance of the Content Manager service as well as all the instances that operate within a given scope:
-
deleteManagers(String, URI, GCUBEScope, GCUBESecurityManager?)
: deletes all the collection managers for a collection with a given identifier, at a given running instance of the service, in a given scope and, optionally, with a given security manager. The deletion is performed in parallel and asynchronously, i.e. clients are returned a list of at most twoFuture<?>
outcomes - one for each manager type - which they may wish to block against, pass around, or poll at a time of their choice, in accordance with standard usage patterns for JavaFuture
s.
-
deleteAllManagers(String, GCUBEScope, GCUBESecurityManager?)
: deletes all the collection managers for a collection with a given identifier at all running instances of the service in a given scope, optionally using a given security manager. The deletion is performed in parallel and asynchronously, i.e. clients are returned a list ofFuture<RPDocument>
outcomes.
-
deleteManager(ManagerCall)
: deletes the collection manager of the call type for a given collection in a given scope at given instance. Collection identifier, scope, and target instance must be configured in the input call. The operation returns itsFuture<?>
outcome.
-
deleteAllManagersByType(ManagerCall)
: deletes all the collection manager of the call type for a given collection in a given scope. Collection identifier and scope must be configured in the input call, while a target instance must not. The operation returns a list ofFuture<RPDocument>
outcomes.
The following examples illustrate the use of admin calls:
ReadManagerCall call = new ReadManagerCall(...some collection..., ...some scope...); call.setEndpointReference(...some reader's endpoint reference...); //destroys the reader Future<?> outcome = AdminCalls.deleteManager(call); //sync-ing on outcome straightaway here outcome.get(); //another example //destroys reader and writer List<Future<?>> outcome = AdminCalls.deleteManagers(...some collection..., ...some instance URI, ...some scope...); //sync-ing on outcome straightaway for (Future<?> o : outcome) ....o.get().... //one more WriteManagerCall call = new WriteManagerCall(...some collection..., ...some scope...); //destroy all writers in scope (essentially makes the collection read-only there) List<Future<RPDDocument>> outcome = AdminCalls.deleteManagersByType(call); //sync-ing on outcome straightaway for (Future<RPDocument> o : outcome) ...o.get().getRIID()...
Content URIs
ReadManagerCall
s allows clients to easily lookup gDoc
trees if they know the collections that contain them. Lookups thus need context, and this context complicates the dissemination of content within the system. In particular, we cannot exchange root identifiers as references to the trees, as these alone are sufficient for neither identification nor lookup. The problem worsens if we wish to exchange references an arbitrary tree node, as in this case the context increases to include not only the collection that contains the tree but also all the path that connects the root of the tree to the node. To solve this problem, the library defines a scheme for URIs that point to arbitrary nodes of gDoc
trees, encapsulating all the information required to resolve the trees and access the nodes.
A content URI is a URI of the following form:
where:
-
cms
is the scheme of the URI; - id(0) is the identifier of a collection;
- id(1) is the identifier of the root a
gDoc
tree in the collection; - id(i) is the identifier of a child of the node identified by id(i-1), where i>1.
Overall, a content URI identifies a node of a gDoc
tree in some collection, and service clients can disseminate it as a compact reference to it.
Resolving URIs
Of course, of our URIs should be resolvable, i.e. should have the semantics of URLs. The library provides two means of resolving content URIs. The first is via the static method get(URI)
of the ReadManagerCall
:
//A content URI URI uri = .... //Scope of resolution GCUBEScope scope = ... //resolve Node node = ReadManagerCall.get(uri,scope);
Essentially, the method extracts the collection identifier from the URI in input and uses it to create a ReadManagerCall
in the input scope. It then extracts the document identifier from the URI and passes it to the method get(String)
of the call object to resolve the corresponding gDoc
tree. It then navigates the tree along the node identifiers in the URI and returns the node with the last identifier.
The second method of resolution is stream-based and relies on standard Java APIs for URL resolution:
import static org.gcube.contentmanagement.contentmanager.stubs.model.protocol.URIs.*; import static org.gcube.contentmanagement.contentmanager.stubs.model.trees.Bindings.*; ... //A content URI URI uri = .... //Scope of resolution GCUBEScope scope = ... //resolve URLConnection connection = connection(uri,scope);Node node = fromXML(connection.getInputStream());
Here, we work with a standard URLConnection
, though we obtain it from a utility of the URIs
class. The utility converts the URI to a URL, obtains from it a URLConnection
and configures it with the target scope (cf. URIs.connection(URI,scope)
). We then obtain a stream from the connection and use the binding facilities in Bindings
to parse the stream into a node (other bindings are of course possible).
note: URL-based resolution requires the registration of a protocol handler for the |
Constructing, Deconstructing, and Converting URIs
As for the generation of content URIs for given nodes of gDoc
trees, clients may invoke the method uri()
of the Node
class of the gDoc
tree API:
//a node of a gDoc tree Node n = ... //Its content URI URI uri = node.uri()
note: |
Besides the method connection()
discussed above, the class URIs
offers a number facilities to create and manipulate content URLs, including:
-
make(String, String*)
: creates a content URI from a collection identifier and a number of object identifiers.
- the method is invoked by the method
uri()
just discussed, but clients may also invoke it directly if they obtain the components of the URI through other means.
-
collectionID(URI)
: returns the identifier of the collection in a content URI; -
documentID(URI)
: returns the identifier of the document in a content URI; -
nodeID(URI)
: returns the identifier of the node referred to by the content URI; -
nodeIDs(URI)
: returns the all the node identifiers in a content URI; -
parentURI(URI)
: returns the content URI of the parent of the node referred to by the content URI; -
documentURI(URI)
: returns the content URI of the document in the content URI; -
predicate(URI)
: returns agDoc
tree predicate for the existence of the path comprised of the identifiers in a content URI; -
toRSElement(URI)
: returns an element of a ResultSet of paths to document nodes, extracting the path identifiers from the URI ;