Module Hierarchy

• g4ds: Import the package.
  • algorithmcontroller: Manages the implementations for the different algorithms.
  • algorithms: Package for implementations for algorithms
    • algorithminterface: Provides the interface, each algorithm implementation must implement to work with G4DS.
    • config: Configuration file for algorithms for G4DS
    • elgamalalgorithm: ElGamal algorithm implementation for G4DS.
    • rsaalgorithm: RSA algorithm implementation for G4DS.
  • authorisationcontroller: Deals with all ussues concerning authorisation / permissions.
  • communicationmanager: All stuff involving communication for G4DS.
  • communicationmanager_db: The database backend functions for the communication module.
  • communitymanager: Management of trusting communities and Members
  • communitymanager_db: Database backend access for community manager
  • config: Main Configuration file for G4DS
  • descriptionprocessor: Parses description files and is able to assemble new ones by using the local knowledge.
  • dynamicrouting: Takes care of frequent updates of the routing table
  • errorhandling: Error handling
  • g4ds: Main module for G4DS
  • g4dsconfigurationcontroller: All configurations are applied in here.
  • g4dslistener: Server for G4DS - several services can connect this way.
  • g4dslogging: Provides Logging facilities.
  • g4dsservice: Client - several services can connect this way.
  • install: Installation routines
  • maintain: User interface to g4ds for maintainence.
  • maintainlib: Functions to g4ds for maintainence.
  • messagehandler: Handles both, incoming at outgoing messages in the first place.
  • messagewrapper: Manages all issues wrapping / unwrapping (XML) messages.
  • protocolcontroller: Manages the implementations for the different protocols.
  • protocols: Package for implementations for protocols
    • config: Configuration file for protocols for G4DS
    • protocolinterface: Provides the interface, each protocol implementation must implement to work with G4DS.
    • soapprotocol: SOAP communication implementation for G4DS.
    • tcpsocketprotocol: SOAP communication implementation for G4DS.
  • routingcontroller: All issues concerning routing are implemented in here.
  • routingtablemanager: All issues concerning the routing table itself are implemented here.
  • routingtablemanagerdb: Database backend for routing table manager.
  • runtimecontroller: Runtime controlling - job recovering and resuming.
  • securitycontroller: Manages all issues for secure communications (en/de-cryption, message validation, ...)
  • securitymanager: All stuff involving securing the communication for G4DS.
  • securitymanager_db: The database backend functions for the security module.
  • serviceintegrator: Connection to services.
  • servicerepository: Management of knowledge services
  • servicerepository_db: Database backend connector for knowledge services repository
  • setup: Setup module for G4DS
  • testg4ds: Test module for G4DS
  • thirdparty: Package for third party modules.
    • output
  • tools: Commonly used functions for G4DS
  • xmlconfig: Configuration file for XML names for G4DS

Class Hierarchy

• exceptions.Exception: Common base class for all exceptions.
  • g4ds.errorhandling.G4dsException: Super class for all G4ds exceptions.
    • g4ds.errorhandling.G4dsCommunicationException: Exception for errors occuring during transport of data.
    • g4ds.errorhandling.G4dsDependencyException: Exception for unresolved dependencies.
    • g4ds.errorhandling.G4dsDescriptionException: Exception for errors occuring during processing or generating of (xml) descriptions.
    • g4ds.errorhandling.G4dsRuntimeException: Exception for errors occuring during processing of functions.
• g4ds.algorithmcontroller.AlgorithmController: Maintains a dictionary with all available protocols.
• g4ds.algorithms.algorithminterface.AlgorithmInterface: Provides a common interface for all implementations for algorithms.
  • g4ds.algorithms.elgamalalgorithm.AlgorithmImplementation: Algorithm implementation for G4DS for the ElGamal algorithm.
  • g4ds.algorithms.rsaalgorithm.AlgorithmImplementation: Algorithm implementation for G4DS for the RSA algorithm.
• g4ds.authorisationcontroller.AuthorisationController: Handles all stuff about permissions.
• g4ds.communicationmanager.Endpoint: Address information about node.
• g4ds.communicationmanager.EndpointManager: Maintains the list of endpoints.
• g4ds.communicationmanager.Protocol: Maintains the relation between protocol names and their ids.
• g4ds.communicationmanager.ProtocolManager: Maintains a list of protocols.
• g4ds.communicationmanager_db.CommDB: Handles all requests form the communication module for backend connectivity with database.
• g4ds.communitymanager.Community: All information about one community
• g4ds.communitymanager.CommunityGateway: Maintains information about a Trusting Commuity Gateway.
• g4ds.communitymanager.CommunityManager: Responsible for maintaining information about Communities this node is member of
• g4ds.communitymanager.Member: Keeps data for one member.
• g4ds.communitymanager.MemberManager: Managing information about members of communities
• g4ds.communitymanager_db.CM_DB: Maintains the connection to the PostgreSQL database.
• g4ds.descriptionprocessor.DescriptionProcessor: Super class for all processor to provide some common functionality.
  • g4ds.descriptionprocessor.CommunityDescriptionProcessor: Parses community descriptions (TCDL) and applies knowledge to the managers.
  • g4ds.descriptionprocessor.MemberDescriptionProcessor: Parses member description (MDL) as well as it may create new MDLs from local knowledge.
  • g4ds.descriptionprocessor.ServiceDescriptionProcessor: Parses service descriptions (KSDL) and applies knowledge to the managers.
• g4ds.dynamicrouting.RoutingTableUpdater: Keeps the routing table up to date by frequent polls from neighbour communities.
• g4ds.g4ds.G4DS: Primary interface for services to communicate with G4DS.
• g4ds.g4dsconfigurationcontroller.CommunityController: Handles controlling of communities.
• g4ds.g4dsconfigurationcontroller.ControlMessageDispatcher: Handles incoming G4DS control messages.
• g4ds.g4dsconfigurationcontroller.MemberController: Handles controlling of members.
• g4ds.g4dsconfigurationcontroller.OutgoingControlMessagesHandler: Handles outgoing G4DS control messages.
• g4ds.g4dsconfigurationcontroller.RoutingController: Handles controlling of routing.
• g4ds.g4dsconfigurationcontroller.ServiceController: Handles controlling of services.
• g4ds.g4dslistener.DummyOut
• g4ds.g4dslistener.G4dsListener: Listens to requests from connected services through the G4dsService interface.
• g4ds.g4dslistener.ServiceHandler: Responsible to deal with one service.
• g4ds.g4dslogging.FileLogger: All messages are equipped with a timestamp and line wise written to a log file.
• g4ds.g4dsservice.G4dsService: That's the one to use from your program
• g4ds.messagehandler.GlobalDispatcher: First instance for dispatching messages.
• g4ds.messagehandler.GlobalOutoingMessageHandler: Handler for outgoing messages.
• g4ds.messagehandler.MessageContextController: Stores all information about incoming messages.
• g4ds.messagewrapper.GenericWrapper: Wrapper for generic functionality.
  • g4ds.messagewrapper.ControlMessageWrapper: Does exactly the same job as MessageWrapper; just for structuring purposes and extracted class for messages sent as control messages.
  • g4ds.messagewrapper.MessageWrapper: Integrates all functions for wrapping and unwrapping data with XML elements.
  • g4ds.messagewrapper.PolicyFileWrapper: Parses permission policy files.
  • g4ds.messagewrapper.RoutingTableWrapper: Encodes / decodes routing table into xml.
• g4ds.protocolcontroller.Dispatcher: Dispatcher so be registered with the protocols.
• g4ds.protocolcontroller.ProtocolController: Maintains a dictionary with all available protocols.
• g4ds.protocols.protocolinterface.ProtocolInterface: Provides a common interface for all implementations for protocols.
  • g4ds.protocols.soapprotocol.ProtocolImplementation: Protocol implementation for G4DS for the SOAP protocol.
  • g4ds.protocols.tcpsocketprotocol.ProtocolImplementation: Protocol implementation for G4DS for simple TCP socket connections.
• g4ds.routingcontroller.RoutingController: The decisioin maker for routing.
• g4ds.routingcontroller.RoutingEngine: Handles all outgoing messages.
• g4ds.routingcontroller.RoutingMessageDispatcher: Dispatcher for incoming Routing messages (special kind of control messages).
• g4ds.routingtablemanager.RoutingTableEntry: Hold the information for one entry in the routing table.
• g4ds.routingtablemanager.RoutingTableManager: Holds the routing table in the memory.
• g4ds.routingtablemanagerdb.RoutingTableManagerDB: Database backend for routingtablemanager.RoutingTableManager
• g4ds.runtimecontroller.JobDispatcher: Handles a list of jobs and locks as well as resumes there processing.
• g4ds.runtimecontroller.JobLocker: Responsible for halting one particular job.
• g4ds.runtimecontroller.JobStatus
• g4ds.securitycontroller.SecurityController: Handles requests related to security and passes them to the appropriate implementation for the requested algorithm.
• g4ds.securitymanager.Algorithm: Maintains the relation between algorithm names and their ids.
• g4ds.securitymanager.AlgorithmManager: Maintains a list of algorithm suitable for credentials.
• g4ds.securitymanager.Credential: All information needed for one bundle of information chunks for a credential.
• g4ds.securitymanager.CredentialManager: Maintains a list of credentials.
• g4ds.securitymanager.PersonalCredential: Maintains all information for one personal credential.
• g4ds.securitymanager.PersonalCredentialManager: Maintains the list of personal confidentials for this node.
• g4ds.securitymanager_db.SecDB: Handles all requests form the security module for backend connectivity with database.
• g4ds.serviceintegrator.ServiceIntegrator: All issues for communication to connected services.
• g4ds.servicerepository.Service: Keeps data for one service.
• g4ds.servicerepository.ServiceManager: Responsible for maintaining information about Services and relations with them
• g4ds.servicerepository_db.ServDB: Handles all requests form the services repository module for backend connectivity with database.