Difference between revisions of "Profile Specification"
Manuelesimi (Talk | contribs) (→= PackageName) |
Manuelesimi (Talk | contribs) (→= PackageType) |
||
| Line 187: | Line 187: | ||
An arbritrary string that uniquely identifies the package within this service. | An arbritrary string that uniquely identifies the package within this service. | ||
| − | ====== PackageType ===== | + | ====== PackageType ====== |
It identifies the type of the package. Allowed values are: | It identifies the type of the package. Allowed values are: | ||
* WSRFService | * WSRFService | ||
Revision as of 19:38, 12 February 2007
How to write the profile specification for this component depending on its type.
Contents
- 1 Preliminary definitions
- 2 How to write the profile specification
- 2.1 Example
- 2.2 Common element
- 2.3 Component-specific sections
Preliminary definitions
DILIGENT Resources and profiles
A DILIGENT Resource is anything whose related information can be gathered, stored, monitored, and disseminated in order to provide the valuable amount of knowledge needed during the creation and management of a VDL as well as to operate the entire DILIGENT infrastructure. In the project, the following resources have been identified:
- VDL
- Collection
- Metadata Collection
- Transformation Rule
- Service
- Running Instance
- External Running Instance
- DHN
- CS
- CSInstance
- gLite resource
Such resources can be combined or created at VDL creation time in order to set up a new Virtual Digital Library. In order to be appropriately managed and discovered, a DILIGENT Resource has to be described by creating a profile document compliant with its XML schema. A Schema per each resource type has been defined and all of them are available in the CNR's SVN Repository In the following, we will focus about how to compile service profile
The Service resource
Usually, a Service is defined as a software system that delivers functionalities. In DILIGENT, a Service is a not-empty set of related Packages (connected through dependencies) forming an unique logical entity. A Package is the smallest installable unit of software that can be deployed on a DHN (e.g. a JAR o a GAR archive). Packages are the way in which the software needed to set up a DL has to prepared in order to be used and stored in the system. Once the service components have been developed, they must be described by compiling the service profile.
Package types
Concretely, a Package is a “piece of software” that can be deployed on a DHN. A Package can be:
- a WSRFService, representing a package that once deployed produces a WSRF Service (a service able to manage stateful resources following the WS-Resource patterns);
- a Portlet, representing a package that once deployed produces a portlet (Web components, managed by a portlet container, that process requests and generate dynamic GUI content) that can be hosted in a DILIGENT Portal;
- a GridJob, representing a package containing the code and the related information needed to run a certain job on the grid infrastructure (see Section 4.1.3);
- a Library, representing a software library that can be hosted on a DHN and is needed by other packages to support their tasks. There are two types of libraries:
- Shared Library, software library offering functionality of common utility, e.g. an XML parser library or a mathematical support library;
- Stub Library, software library offering functionality for interacting with WSRF Services.
Composition
The set of Packages forming a Service is composed by:
- one and only one Package of WSRFService or Portlet type (the main package or the entry point)
- an arbitrary number of other Packages of different type logically related (even if not used) by it.
How to write the profile specification
Example
<DILIGENTResource xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<UniqueID/>
<ResourceType>Service</ResourceType>
<AuthorizationPolicies>
[...]
</AuthorizationPolicies>
<Profile>
<Class>MetadataManagement</Class>
<Name>MetadataCatalog</Name>
<DescriptiveParameters>
<DescParameter/>
</DescriptiveParameters>
<QoS/>
<DeploymentInfo>
<Deployable value="true"/>
</DeploymentInfo>
<DLDependencies>
<DLComponent>
<Class>MetadataManagement</Class>
<Name>XMLIndexer</Name>
<DescriptiveParametersValue/>
</DLComponent>
<DLComponent>
<Class>ContentManagement</Class>
<Name>StorageManagementService</Name>
<DescriptiveParametersValue/>
</DLComponent>
<DLComponent>
<Class>ContentManagement</Class>
<Name>CollectionManagementService</Name>
<DescriptiveParametersValue/>
</DLComponent>
</DLDependencies>
<SpecificData/>
<PackagesList>
[...]
</PackagesList>
</Profile>
</DILIGENTResource>
Common element
Class
The class of a service is it's functional area. The following values are accepted as service classes:
- InformationSystem
- Keeper
- VDLGenerator
- BMM
- DVOS
- Search
- Index
- DataFusion
- CSD
- CSS
- ProcessManagement
- Annotation
- FeatureExtraction
- Personalisation
- ContentSecurity
- ContentManagement
- MetadataManagement
- Portal
Name
The Name is an arbitrary string that uniquely identifies the service within a service class.
DescriptiveParameters
QoS
DeploymentInfo
DLDependencies: DL Logical Dependencies
A DILIGENT service is part of a complex system and it makes use of other services. At VDL definition time, firstly, it is compiled the list of services that satisfy the VDL definition criteria and, then, such a list is completed with the other services that allow the first ones to work properly. Therefore it is needed that a service declares which other services it will need to be available in order to do its work once it is deployed. Specify a DL dependency here means that if this service is deployed in a DL, also the service identified by the Service Class and Name has to be deployed in the DL. (The DescriptiveParametersValue sintax still needs to be defined)
PackageList section
Common elements
Example
<Package> <PackageName>MetadataCatalogService</PackageName> <PackageType>WSRFService</PackageType> <Version>1.0</Version> <DLMandatory value="true"/> <DHNMandatory value="false"/> <VOMandatory value="false"/> <DLSharable value="true"/> <DisposeInterfaceSupport value="false"/> <MultiVersionSupport value="false"/> <VOSharingSupport value="false"/> <ManifestFile/> <InstallScripts/> <UninstallScripts/> <RebootScripts/> <Dependencies> <Dependency> <Service> <Class>ContentManagement</Class> <Name>ContentManagementService</Name> </Service> <PackageName>ContentManagementLayer_lib</PackageName> <Version>0.1</Version> <SameDHN value="true"/> <Priority>3</Priority> </Dependency> <Dependency> <Service> <Class>MetadataManagement</Class> <Name>XMLIndexer</Name> </Service> <PackageName>XMLIndexerService_stubs</PackageName> <Version>1.0</Version> <SameDHN value="true"/> <Priority>3</Priority> </Dependency> </Dependencies> <DHNRequirements> <Req category="RunTimeEnv" operator="eq" requirement="Variable" value="java1.5"/> <Req category="OperatingSystem" operator="eq" requirement="Name" value="Linux"/> </DHNRequirements> <ConfigurationFiles> <File>....</File> </ConfigurationFiles> [package specific tag] <OtherFiles/> <OtherProperties/> </Package>
PackageName
An arbritrary string that uniquely identifies the package within this service.
PackageType
It identifies the type of the package. Allowed values are:
- WSRFService
- Library
- GridJob
- Portlet
= Version
The version of the package. It has to be in the form of X.Y.
DLMandatory
DHNMandatory
VOMandatory
DLSharable
It states if the package can be shared across multiple DLs (true) or if it is DL-Specific.
= DisposeInterfaceSupport
= MultiVersionSupport
VOSharingSupport
It states if the package can be shared across multiple VOs (true) or if it is VO-Specific.
ManifestFile
InstallScripts
UninstallScripts
RebootScripts
Dependencies =
DHNRequirements
ConfigurationFiles
OtherFiles
List here the files that are in the service archive belonging the package and that are not already included in other elements (like installscripts, GARArchive, etc.)
OtherProperties
This is a free section where you can insert anything that cannot be included in the other elements of the profile. For instance, you can insert here any information you suppose helps to discriminate the service among others. Let's suppose you have two different Search services, S1 and S2, implementing two different kinds of search. Ok, you specify a different name, but you can also add here information that helps to differentiate S1 from S2.
Component-specific sections
WSRFService sections
Example
<WSRFService> <GARArchive>org_diligentproject_X.gar</GARArchive> <BuildFile/> <DeploymentOptions/> <ArchitecturalPattern>Factory</ArchitecturalPattern> <ServiceEquivalenceFunctions/> <WSRFEntry> <EntryName>String</EntryName> <Factory value="true"/> <Parameters/> <Security/> <WSDL> <wsdl:definitions targetNamespace="http://...." name="...."> [...] </wsdl:definitions> </WSDL> </WSRFEntry> </WSRFService>
GARArchive
BuildFile
DeploymentOptions
ArchitecturalPattern
This element declares the architectural pattern adopted by the WSRF service.
ServiceEquivalenceFunctions element: Fix the service equivalence
This element allows to define functions to use at runtime to understand when two Running Instances of the service are equivalents from a specific function point of view. They can be considered are a sort of criteria to find service's replicas. Each function defined here must have a corrispondent section in the Running Instance profile that gives the values to the formal parameter defined in the function. So far, the following fuction are used in the infrastructure:
- match, used by the Active Planner service to discriminate among two Running Instances of the same service
WSRFEntry
Example
<Library> <Type>shared</Type> <Parameters/> <LibraryFile>ip/org_diligentproject_informationservice_disip.jar</LibraryFile> </Library>
Type
Fixed: "shared"
Parameters
LibraryFile
The path and the name of the library's file in the service archive.
Stub Library
Example
<Library> <Type>stub</Type> <IsStubOf> <PackageName>DIS-IC_Service</PackageName> <Service> <Class>InformationSystem</Class> <Name>DIS-IC</Name> </Service> </IsStubOf> <Parameters/> <LibraryFile>bin/org_diligentproject_informationservice_disic_stubs.jar</LibraryFile> </Library>
Type
Fixed: "stub"
IsStubOf
This element declares of which WSRFService package the library is stub of.
Parameters
LibraryFile
The path and the name of the library's file in the service archive.
-- Manuele Simi
