Added classes description for future reference

This commit is contained in:
Luca Frosini 2024-10-23 13:31:51 +02:00
parent e1ef53f2ef
commit 334a8aff37
8 changed files with 23 additions and 0 deletions

View File

@ -13,6 +13,8 @@ import com.orientechnologies.orient.core.metadata.security.OSecurity;
/**
* @author Luca Frosini (ISTI - CNR)
* This SystemEnvironment is used in all the case the
* operation must be done by an administrator
*/
public class AdminEnvironment extends SystemEnvironment {

View File

@ -11,6 +11,9 @@ import com.orientechnologies.orient.core.metadata.security.ORule;
/**
* @author Luca Frosini (ISTI - CNR)
* This SystemEnvironment is used to pesists
* Contexts information and their relations among
* others, e.g. a Context is parent of another.
*/
public class ContextEnvironment extends SystemEnvironment {

View File

@ -35,6 +35,10 @@ import com.orientechnologies.orient.core.record.impl.ODocument;
/**
* @author Luca Frosini (ISTI - CNR)
* Base class for all environments which have an hierarchy.
* An example is InstanceEnviroment where the instances
* belonging to a context must be visible from parent
* context if the requesting client has enough privileges
*/
public abstract class HierarchicalSystemEnvironment extends SystemEnvironment {

View File

@ -6,6 +6,7 @@ import org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegis
/**
* @author Luca Frosini (ISTI - CNR)
* Contains all the instances belonging to a context.
*/
public class InstanceEnvironment extends HierarchicalSystemEnvironment {

View File

@ -11,6 +11,7 @@ import com.orientechnologies.orient.core.metadata.security.ORule;
/**
* @author Luca Frosini (ISTI - CNR)
* Contains all the query templates
*/
public class QueryTemplateEnvironment extends SystemEnvironment {

View File

@ -12,6 +12,11 @@ import com.orientechnologies.orient.core.metadata.security.ORule;
/**
* @author Luca Frosini (ISTI - CNR)
* Added for feature #19428
* It is used as a sort of cemetery for deleted Contexts.
* e.g the information regarding a deleted context are not
* really deleted instead are moved in this partition to
* ah historical information and to provide a minimal support for
* Context reborn.
*/
public class ShadowContextEnvironment extends SystemEnvironment {

View File

@ -35,6 +35,10 @@ import com.orientechnologies.orient.core.record.impl.ODocument;
/**
* @author Luca Frosini (ISTI - CNR)
* Base class for any system environment.
* In the current implementation it represent a
* partion of a graph which in OrientDB is implemented
* via security.
*/
public abstract class SystemEnvironment {

View File

@ -11,6 +11,9 @@ import com.orientechnologies.orient.core.metadata.security.ORule;
/**
* @author Luca Frosini (ISTI - CNR)
* Contains all the information-system-model types
* plus all the types defined on top of the
* information-system-model (e.g the gcube-model)
*/
public class TypeEnvironment extends SystemEnvironment {