Difference between revisions of "IS-Registry"

From Gcube Wiki
Jump to: navigation, search
(→‎Functions)
(→‎Removing a GCUBE resource)
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
The IS-Registry is a gCube Service called upon to manage gCube Resources by managing the registration/unregistration of their profiles. Its internals are structures as depicted in Figure 1, i.e. it mainly follows a Factory pattern.
+
== Role ==
  
−
[[Image:IS-Registry Architecture.png|frame|center|Figure 1. IS-Registry Architecture]]
+
The IS-Registry is the gateway to entering in a gCube infrastructure for [[Reference Model#Resource Domain|gCube resources]] by means of registering/unregistering their profiles.
  
−
==== Resources and Properties ====
+
The IS-Registry performs three fundamental tasks:
−
This Service creates and manage a WS-Resource for each gCube resource that has to be considered part of the e-Infrastructure the IS-Registry is responsible for. Such WS-Resources (''ProfileResource'') implement the Resource Model described in the [[Reference Model#Resource Domain|Resource Model]], in fact each of them consists of four parts:  
+
  
−
* A ''unique identifier'' identifying the resource univocally;
+
* decide if accept or not a new resource
−
* A ''type'' characterising the class the resource belong to, e.g. Running Instance, gHN;
+
* validate a resource before its registration
−
* A ''scope'' identifying the operational scope of such a resource;
+
* execute post-deletion actions to keep consistent the IS content
−
* A ''profile'' describing the resource by resource-specific attributes.
+
  
−
In addition to such WS-Resources the service publishes a set of properties about its operational status including the number of resources of a certain type currently registered, the last operation performed including operation type, resource ID and time (''RegistryFactoryResource''). Such properties are also registered as Topics managed by the [[IS-Notifier]] thus making possible for interested clients to subscribe on events representing the changes of status of Infrastructure constituents (e.g. the disappearance of a Running Instance).
 
  
−
==== Functions ====
+
== Design ==
−
The main functions supported by the Service Factory (RegistryFactory) are:
+
  
−
* '''createResource()''' – which takes as input parameter a message containing a ''resource profile'' and a set of ''registration directives'' (e.g. VO membership and VRE membership) and returns a string containing the whole profile of the new resource including the automatically assigned ID;
+
The design of the service is distributed across two port-types: the <code>ResourceRegistration</code> and the <code>Factory</code>. Both of them work in a stateless manner, however the Factory creates a stateful resource for notification purposes.
−
* '''updateResource()''' – which takes as input parameter a message containing the new profile that is supposed to replace an existing one. The key to identify the old profile to be replaced is contained in the profile itself, it is the resource ID. By relying on the internal mapping between IDs and EPRs it identifies the WS-Resource it has to interact with in order to implement such update operation;
+
−
* '''removeResource()''' – which takes as input parameter a message mainly containing the resource ID identifying the resource to be removed;
+
−
* '''updateProfileWithVRE()''' – which takes as input parameter a message containing the resource ID and the new VRE scopes designed to enrich the resource scope section and returns the new resource profile;
+
−
* '''removeProfileWithVRE()''' – which takes as input parameter a message containing the resource ID and the set of VRE scopes to be removed from the resource profile and returns the new resource profile;
+
−
* '''updateState()''' – which takes as input parameter a message containing the resource ID and the new state the resource has to be considered in and returns the new resource profile;
+
  
−
The main functions supported by the IS-Registry Service (RegistryService), i.e. the WSRF service managing the WS-Resource instances representing gCube resources, are:
+
[[Image:IS-Registry Architecture2.jpg|frame|center|Figure 1. IS-Registry Architecture]]
  
−
* '''update()''' – which takes as input parameter a message containing the new resource profile and updates its current one;
+
=== ResourceRegistration ===
−
* '''remove()''' – which deletes the resource by destroying the WS-Resource and its serialisation;
+
−
* '''getProfileString()''' – which returns the resource profile represented by its WS-Resource;
+
−
* '''updateStatus()''' – which takes as input parameter a message containing the new status the resource must appear to be and accordingly updates the WS-Resource;
+
−
* '''updateVRE()''' – which takes as input parameter a message containing the new VRE scopes the managed resource has to be considered in and enriches the WS-Resource accordingly;
+
−
* '''removeVRE()''' – which takes as input parameter a message containing the VRE scopes the managed resource has to be removed from and revises the WS-Resource accordingly.
+
  
−
==== Configuration ====
+
[[Image:IS-Registry ResourceRegistration.jpg|frame|center|Figure 2. IS-Registry ResourceRegistration port-type]]
  
−
An instance of the IS-Registry has to be configured as follows
+
The <code>ResourceRegistration</code> port-type manages the registration/update/removal of GCUBE Resources. It is directly contacted only by the [[IS-Publisher]] in order to perform such operations.
  
−
# Since a IS-Registry can act in one and only one scope, its JNDI file (<em>$GLOBUS_LOCATION/etc/org.gcube.informationsystem.registry/jndi-config.xml</em>) must be configure to join only one scope:
+
It exposes three operations:
  
−
Example:
+
* [[IS-Registry#Registering_a_new_GCUBE_Resource|<code>create</code>]] – which takes as input a CreateMessage containing the string serialization of the resource profile to register;
−
<pre lang="xml">
+
* [[IS-Registry#Updating_an_existing_GCUBE_Resource|<code>update</code>]] – which takes as input an UpdateMessage containing the new profile that will replace an existing one;
−
<?xml version="1.0" encoding="UTF-8"?>
+
* [[IS-Registry#Removing_a_GCUBE_resource|<code>remove</code>]] – which takes as input a RemoveMessage containing the unique identifier of the resource to be removed and its type;
−
<jndiConfig xmlns="http://wsrf.globus.org/jndi/config">
+
  
−
<service name="gcube/informationsystem/registry">
+
The first two operations throw an <code>InvalidResourceFault</code> if the profile was not correct/valid and a <code>ResourceNotAcceptedFault</code> if the profile was not accepted because of the instance's configured [[Information_System_Installation#IS_Filters|filters]].
−
          
+
 
−
                <environment
+
=== Factory ===
−
                        name="configDir"  
+
 
−
                        value="etc/org.gcube.informationsystem.registry"  
+
[[Image:IS-Registry Factory.jpg|frame|center|Figure 3. IS-Registry Factory port-type]]
−
                        type="java.lang.String"
+
 
−
                        override="false" />
+
From the functional point of view, the Factory port-type is practically a wrapper around the <code>ResourceRegistration</code> port-type to provide backwards compatibility to previous IS-Publisher and testers implementation. Therefore, it exposes the following operations:
−
               
+
 
−
                <environment
+
* <code>createResource</code>
−
                        name="securityManagerClass"  
+
* <code>updateResource</code>
−
                        value="org.gcube.common.core.security.GCUBESimpleServiceSecurityManager"  
+
* <code>removeResource</code>
−
                        type="java.lang.String"
+
 
−
                        override="false" />
+
that are mapped on the <code>ResourceRegistration</code>'s operations.
−
               
+
Using this port-type is strongly deprecated and it will likely disappear in the next releases of the service.
−
                <!-- Lifetime for temporary resources, after this period temporary resources are destroyed-->
+
 
−
                <environment
+
=== FactoryResource ===
−
                        name="temporaryResourceLifetimeInMs"
+
 
−
                        value="480000"
+
At start up time, the <code>Factory</code> port-type is in charge of creating the singleton <code>FactoryResource</code>. This resource (whose name is derived from previous versions of the service) exposes a set of WS-ResourceProperties registered as Topics in the [[IS-Notifier]], making possible for interested clients to subscribe on events representing the changes of status of Infrastructure constituents (e.g. the disappearance of a Running Instance).
−
                        type="java.lang.Long"
+
 
−
                        override="false" />    
+
[[Image:IS-Registry Resource.jpg|frame|center|Figure 4. IS-Registry FactoryResource]]
−
                               
+
 
−
                                       
+
This is the list of RPs exposed:
−
                       
+
<source lang="xml">
−
                <environment
+
<xsd:element name="RegistryFactoryResourceProperties">
−
                        name="startScopes"  
+
         <xsd:complexType>
−
                        value=" /testing/vo1"
+
              <xsd:sequence>                         
−
                        type="java.lang.String"
+
                      <xsd:element ref="tns:RunningInstance" minOccurs="1" maxOccurs="1"/>
−
                      override="false" />       
+
                      <xsd:element ref="tns:ExternalRunningInstance" minOccurs="1" maxOccurs="1"/>
−
                       
+
                      <xsd:element ref="tns:Service" minOccurs="1" maxOccurs="1"/>
−
</service>
+
                      <xsd:element ref="tns:Collection" minOccurs="1" maxOccurs="1"/>
 +
                      <xsd:element ref="tns:GHN" minOccurs="1" maxOccurs="1"/>
 +
                      <xsd:element ref="tns:MetadataCollection" minOccurs="1" maxOccurs="1"/>
 +
                      <xsd:element ref="tns:GenericResource" minOccurs="1" maxOccurs="1"/>
 +
              </xsd:sequence>
 +
        </xsd:complexType>
 +
</xsd:element>
 +
</source>
 +
 
 +
and each element of the sequence is of type <code>ResourceProperty</code> defined as follows:
 +
 
 +
<source lang="xml">
 +
<xsd:complexType name="RegistryProperty">
 +
<xsd:sequence>
 +
<xsd:element name="uniqueID" type="xsd:string" nillable="true"/>
 +
<xsd:element name="profile" type="xsd:string" nillable="true"/> 
 +
<xsd:element name="operationType" type="xsd:string" nillable="true"/>  
 +
  <xsd:element name="changeTime" type="xsd:dateTime" nillable="true"/>
 +
</xsd:sequence>
 +
</xsd:complexType>
 +
</source>
 +
 
 +
Note that:
 +
* ''uniqueID'' is the identifier of the resource
 +
* ''profile'' is the string serialization of the resource's profile
 +
* ''operationType'' is the type of operation performed on the resource (allowed values are: ''create'', ''update'', ''destroy'')
 +
* ''changeTime'' is the time stamp of the operation
 +
 
 +
== Sample Usage ==
 +
This section provides sample usage of the [[IS-Registry#ResourceRegistration|ResourceRegistration]] port-type. The [[IS-Registry#Factory|Factory]] port-type is obsolete and should not be used anymore.
 +
 
 +
Note that:
 +
* due to the [[IS-Publisher#Bulked_Publications|behavior]] of the [[IS-Publisher]], any request is executed asynchronously (at the next scheduled bulk execution)
 +
* if the operation is performed inside a service, the ServiceContext has to be used as GCUBESecurityManager (instead of the ''ad hoc'' manager created here below).
 +
 
 +
 
 +
=== Registering a new GCUBE Resource ===
 +
The following test method show how to register a new GCUBE Resource:
 +
<source lang="java">
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.CreateMessage;
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.ResourceRegistrationPortType;
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.service.ResourceRegistrationServiceAddressingLocator;
 +
 
 +
//...
 +
 
 +
protected void registerResource(GCUBEResource resource, GCUBEScope scope) throws Exception {
 +
int timeout = 20000;
 +
StringWriter profile = new StringWriter();
 +
resource.store(profile);
 +
GCUBESecurityManagerImpl manager = new GCUBESecurityManagerImpl() {
 +
public boolean isSecurityEnabled() { return false;}
 +
};
 +
ResourceRegistrationServiceAddressingLocator locator = new ResourceRegistrationServiceAddressingLocator();
 +
ResourceRegistrationPortType registration = locator.getResourceRegistrationPortTypePort(epr);
 +
registration = GCUBERemotePortTypeContext.getProxy(registration, scope, timeout, manager);
 +
try {
 +
CreateMessage message = new CreateMessage();
 +
message.setProfile(profile.toString());
 +
message.setType(resource.getType());
 +
registration.create(message);
 +
} catch(Exception e) {
 +
logger.error("Failed to publish the GCUBE Resource ",e);
 +
}
 +
}
 +
</source>
 +
 
 +
 
 +
=== Updating an existing GCUBE Resource ===
 +
The following test method show how to update an existing GCUBE Resource:
 +
<source lang="java">
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.UpdateMessage;
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.ResourceRegistrationPortType;
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.service.ResourceRegistrationServiceAddressingLocator;
 +
 
 +
//...
 +
 
 +
protected void updateResource(GCUBEResource resource, GCUBEScope scope) throws Exception {
 +
int timeout = 20000;
 +
StringWriter profile = new StringWriter();
 +
resource.store(profile);
 +
GCUBESecurityManagerImpl manager = new GCUBESecurityManagerImpl() {
 +
public boolean isSecurityEnabled() { return false;}
 +
};
 +
ResourceRegistrationServiceAddressingLocator locator = new ResourceRegistrationServiceAddressingLocator();
 +
ResourceRegistrationPortType registration = locator.getResourceRegistrationPortTypePort(epr);
 +
registration = GCUBERemotePortTypeContext.getProxy(registration, scope, timeout, manager);
 +
try {
 +
UpdateMessage message = new UpdateMessage();
 +
message.setUniqueID(profile.getID());
 +
message.setXmlProfile(profile.toString());
 +
message.setType(resource.getType());
 +
registration.update(message);
 +
} catch(Exception e) {
 +
logger.error("Failed to update the GCUBE Resource ",e);
 +
}
 +
}
 +
</source>
 +
 
 +
=== Removing a GCUBE resource ===
 +
The following test method show how to remove a GCUBE Resource:
 +
<source lang="java">
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.RemoveMessage;
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.ResourceRegistrationPortType;
 +
import org.gcube.informationsystem.registry.stubs.resourceregistration.service.ResourceRegistrationServiceAddressingLocator;
 +
 
 +
//...
 +
 
 +
protected void unregisterResource(GCUBEResource resource, GCUBEScope scope) throws Exception {
 +
int timeout = 20000;
 +
GCUBESecurityManagerImpl manager = new GCUBESecurityManagerImpl() {
 +
public boolean isSecurityEnabled() { return false;}
 +
};
 +
ResourceRegistrationServiceAddressingLocator locator = new ResourceRegistrationServiceAddressingLocator();
 +
ResourceRegistrationPortType registration = locator.getResourceRegistrationPortTypePort(epr);
 +
registration = GCUBERemotePortTypeContext.getProxy(registration, scope, timeout, manager);
 +
try {
 +
RemoveMessage message = new RemoveMessage();
 +
message.setUniqueID(resource.getID());
 +
message.setType(resource.getType());
 +
registration.remove(message);
 +
} catch(Exception e) {
 +
logger.error("Failed to remove the GCUBE Resource ",e);
 +
}
 +
}
 +
</source>
  
−
</pre>
 
−
#
 
  
 
[[Category:Information System]]
 
[[Category:Information System]]

Latest revision as of 13:51, 9 April 2011

Role

The IS-Registry is the gateway to entering in a gCube infrastructure for gCube resources by means of registering/unregistering their profiles.

The IS-Registry performs three fundamental tasks:

  • decide if accept or not a new resource
  • validate a resource before its registration
  • execute post-deletion actions to keep consistent the IS content


Design

The design of the service is distributed across two port-types: the ResourceRegistration and the Factory. Both of them work in a stateless manner, however the Factory creates a stateful resource for notification purposes.

Figure 1. IS-Registry Architecture

ResourceRegistration

Figure 2. IS-Registry ResourceRegistration port-type

The ResourceRegistration port-type manages the registration/update/removal of GCUBE Resources. It is directly contacted only by the IS-Publisher in order to perform such operations.

It exposes three operations:

  • create – which takes as input a CreateMessage containing the string serialization of the resource profile to register;
  • update – which takes as input an UpdateMessage containing the new profile that will replace an existing one;
  • remove – which takes as input a RemoveMessage containing the unique identifier of the resource to be removed and its type;

The first two operations throw an InvalidResourceFault if the profile was not correct/valid and a ResourceNotAcceptedFault if the profile was not accepted because of the instance's configured filters.

Factory

Figure 3. IS-Registry Factory port-type

From the functional point of view, the Factory port-type is practically a wrapper around the ResourceRegistration port-type to provide backwards compatibility to previous IS-Publisher and testers implementation. Therefore, it exposes the following operations:

  • createResource
  • updateResource
  • removeResource

that are mapped on the ResourceRegistration's operations. Using this port-type is strongly deprecated and it will likely disappear in the next releases of the service.

FactoryResource

At start up time, the Factory port-type is in charge of creating the singleton FactoryResource. This resource (whose name is derived from previous versions of the service) exposes a set of WS-ResourceProperties registered as Topics in the IS-Notifier, making possible for interested clients to subscribe on events representing the changes of status of Infrastructure constituents (e.g. the disappearance of a Running Instance).

Figure 4. IS-Registry FactoryResource

This is the list of RPs exposed: 

<xsd:element name="RegistryFactoryResourceProperties">
        <xsd:complexType>
               <xsd:sequence>                          
                      <xsd:element ref="tns:RunningInstance" minOccurs="1" maxOccurs="1"/>
                      <xsd:element ref="tns:ExternalRunningInstance" minOccurs="1" maxOccurs="1"/>
                      <xsd:element ref="tns:Service" minOccurs="1" maxOccurs="1"/>
                      <xsd:element ref="tns:Collection" minOccurs="1" maxOccurs="1"/>
                      <xsd:element ref="tns:GHN" minOccurs="1" maxOccurs="1"/>
                      <xsd:element ref="tns:MetadataCollection" minOccurs="1" maxOccurs="1"/>
                      <xsd:element ref="tns:GenericResource" minOccurs="1" maxOccurs="1"/>
              </xsd:sequence>
        </xsd:complexType>
</xsd:element>

and each element of the sequence is of type ResourceProperty defined as follows: 

<xsd:complexType name="RegistryProperty">	
	<xsd:sequence>
		<xsd:element name="uniqueID" type="xsd:string" nillable="true"/>
		<xsd:element name="profile" type="xsd:string" nillable="true"/>  
		<xsd:element name="operationType" type="xsd:string" nillable="true"/> 
	  	<xsd:element name="changeTime" type="xsd:dateTime" nillable="true"/> 
	</xsd:sequence>
</xsd:complexType>

Note that:

  • uniqueID is the identifier of the resource
  • profile is the string serialization of the resource's profile
  • operationType is the type of operation performed on the resource (allowed values are: create, update, destroy)
  • changeTime is the time stamp of the operation

Sample Usage

This section provides sample usage of the ResourceRegistration port-type. The Factory port-type is obsolete and should not be used anymore.

Note that:

  • due to the behavior of the IS-Publisher, any request is executed asynchronously (at the next scheduled bulk execution)
  • if the operation is performed inside a service, the ServiceContext has to be used as GCUBESecurityManager (instead of the ad hoc manager created here below).


Registering a new GCUBE Resource

The following test method show how to register a new GCUBE Resource: 

import org.gcube.informationsystem.registry.stubs.resourceregistration.CreateMessage;
import org.gcube.informationsystem.registry.stubs.resourceregistration.ResourceRegistrationPortType;
import org.gcube.informationsystem.registry.stubs.resourceregistration.service.ResourceRegistrationServiceAddressingLocator;
 
//...
 
protected void registerResource(GCUBEResource resource, GCUBEScope scope) throws Exception {
	int timeout = 20000;
	StringWriter profile = new StringWriter();
	resource.store(profile);
	GCUBESecurityManagerImpl manager = new GCUBESecurityManagerImpl() {
		public boolean isSecurityEnabled() { return false;}
	};
	ResourceRegistrationServiceAddressingLocator locator = new ResourceRegistrationServiceAddressingLocator(); 			
	ResourceRegistrationPortType registration = locator.getResourceRegistrationPortTypePort(epr);
	registration = GCUBERemotePortTypeContext.getProxy(registration, scope, timeout, manager);
	try {
		CreateMessage message = new CreateMessage();
		message.setProfile(profile.toString());
		message.setType(resource.getType());
		registration.create(message);
	} catch(Exception e) { 				
		logger.error("Failed to publish the GCUBE Resource ",e);										
	}
}


Updating an existing GCUBE Resource

The following test method show how to update an existing GCUBE Resource: 

import org.gcube.informationsystem.registry.stubs.resourceregistration.UpdateMessage;
import org.gcube.informationsystem.registry.stubs.resourceregistration.ResourceRegistrationPortType;
import org.gcube.informationsystem.registry.stubs.resourceregistration.service.ResourceRegistrationServiceAddressingLocator;
 
//...
 
protected void updateResource(GCUBEResource resource, GCUBEScope scope) throws Exception {
	int timeout = 20000;
	StringWriter profile = new StringWriter();
	resource.store(profile);
	GCUBESecurityManagerImpl manager = new GCUBESecurityManagerImpl() {
		public boolean isSecurityEnabled() { return false;}
	};
	ResourceRegistrationServiceAddressingLocator locator = new ResourceRegistrationServiceAddressingLocator(); 			
	ResourceRegistrationPortType registration = locator.getResourceRegistrationPortTypePort(epr);
	registration = GCUBERemotePortTypeContext.getProxy(registration, scope, timeout, manager);
	try {
		UpdateMessage message = new UpdateMessage();
		message.setUniqueID(profile.getID());
		message.setXmlProfile(profile.toString());
		message.setType(resource.getType());
		registration.update(message);
	} catch(Exception e) { 				
		logger.error("Failed to update the GCUBE Resource ",e);										
	}
}

Removing a GCUBE resource

The following test method show how to remove a GCUBE Resource: 

import org.gcube.informationsystem.registry.stubs.resourceregistration.RemoveMessage;
import org.gcube.informationsystem.registry.stubs.resourceregistration.ResourceRegistrationPortType;
import org.gcube.informationsystem.registry.stubs.resourceregistration.service.ResourceRegistrationServiceAddressingLocator;
 
//...
 
protected void unregisterResource(GCUBEResource resource, GCUBEScope scope) throws Exception {
	int timeout = 20000;
	GCUBESecurityManagerImpl manager = new GCUBESecurityManagerImpl() {
		public boolean isSecurityEnabled() { return false;}
	};
	ResourceRegistrationServiceAddressingLocator locator = new ResourceRegistrationServiceAddressingLocator(); 			
	ResourceRegistrationPortType registration = locator.getResourceRegistrationPortTypePort(epr);
	registration = GCUBERemotePortTypeContext.getProxy(registration, scope, timeout, manager);
	try {
		RemoveMessage message = new RemoveMessage();
		message.setUniqueID(resource.getID());
		message.setType(resource.getType());
		registration.remove(message);
	} catch(Exception e) { 				
		logger.error("Failed to remove the GCUBE Resource ",e);										
	}
}
Retrieved from "https://wiki.gcube-system.org/index.php?title=IS-Registry&oldid=11837"