Examples with DocumentBasedCsarEntry org.eclipse.winery.repository.export.entries.DocumentBasedCsarEntry used on opensource projects

Example 1 with DocumentBasedCsarEntry

use of org.eclipse.winery.repository.export.entries.DocumentBasedCsarEntry in project winery by eclipse.

the class YamlExporter method addManifest.

private String addManifest(IRepository repository, DefinitionsChildId id, Map<CsarContentProperties, CsarEntry> refMap, ZipOutputStream out, Map<String, Object> exportConfiguration) throws IOException {
    String entryDefinitionsReference = getDefinitionsPathInsideCSAR(repository, id);
    out.putNextEntry(new ZipEntry("TOSCA-Metadata/TOSCA.meta"));
    StringBuilder stringBuilder = new StringBuilder();
    // Setting Versions
    stringBuilder.append(TOSCA_META_FILE_VERSION).append(": ").append(TOSCA_META_FILE_VERSION_VALUE).append("\n");
    stringBuilder.append(CSAR_VERSION).append(": ").append(CSAR_VERSION_VALUE_FOR_YAML).append("\n");
    stringBuilder.append(CREATED_BY).append(": Winery ").append(Environments.getInstance().getVersion()).append("\n");
    // Winery currently is unaware of tDefinitions, therefore, we use the
    // name of the service template
    stringBuilder.append(ENTRY_DEFINITIONS).append(": ").append(entryDefinitionsReference).append("\n");
    stringBuilder.append("\n");
    assert (refMap.keySet().stream().anyMatch(fileProperties -> fileProperties.getPathInsideCsar().equals(entryDefinitionsReference)));
    // Setting other files, mainly files belonging to artifacts
    for (Map.Entry<CsarContentProperties, CsarEntry> item : refMap.entrySet()) {
        final CsarEntry csarEntry = item.getValue();
        final CsarContentProperties fileProperties = item.getKey();
        stringBuilder.append(NAME).append(": ").append(fileProperties.getPathInsideCsar()).append("\n");
        String mimeType;
        if (csarEntry instanceof DocumentBasedCsarEntry) {
            mimeType = MimeTypes.MIMETYPE_XSD;
        } else if (csarEntry instanceof XMLDefinitionsBasedCsarEntry || csarEntry instanceof YAMLDefinitionsBasedCsarEntry || csarEntry instanceof DefinitionsBasedCsarEntry) {
            mimeType = MimeTypes.MIMETYPE_TOSCA_DEFINITIONS;
        } else if (csarEntry instanceof RemoteRefBasedCsarEntry) {
            mimeType = repository.getMimeType((RemoteRefBasedCsarEntry) csarEntry);
        } else {
            mimeType = repository.getMimeType(((RepositoryRefBasedCsarEntry) csarEntry).getReference());
        }
        stringBuilder.append(CONTENT_TYPE).append(": ").append(mimeType).append("\n");
        stringBuilder.append("\n");
    }
    String manifestString = stringBuilder.toString();
    out.write(manifestString.getBytes());
    out.closeEntry();
    return manifestString;
}

Example 2 with DocumentBasedCsarEntry

use of org.eclipse.winery.repository.export.entries.DocumentBasedCsarEntry in project winery by eclipse.

the class CsarExporter method addManifest.

private String addManifest(DefinitionsChildId id, Map<CsarContentProperties, CsarEntry> refMap, ZipOutputStream out, Map<String, Object> exportConfiguration) throws IOException {
    String entryDefinitionsReference = CsarExporter.getDefinitionsPathInsideCSAR(repository, id);
    out.putNextEntry(new ZipEntry("TOSCA-Metadata/TOSCA.meta"));
    StringBuilder stringBuilder = new StringBuilder();
    // Setting Versions
    stringBuilder.append(TOSCA_META_VERSION).append(": 1.0").append("\n");
    stringBuilder.append(CSAR_VERSION).append(": 1.0").append("\n");
    stringBuilder.append(CREATED_BY).append(": Winery ").append(Environments.getInstance().getVersion()).append("\n");
    // Winery currently is unaware of tDefinitions, therefore, we use the
    // name of the service template
    stringBuilder.append(ENTRY_DEFINITIONS).append(": ").append(entryDefinitionsReference).append("\n");
    stringBuilder.append("\n");
    assert (refMap.keySet().stream().anyMatch(fileProperties -> fileProperties.getPathInsideCsar().equals(entryDefinitionsReference)));
    // Setting other files, mainly files belonging to artifacts
    for (Map.Entry<CsarContentProperties, CsarEntry> item : refMap.entrySet()) {
        final CsarEntry csarEntry = item.getValue();
        final CsarContentProperties fileProperties = item.getKey();
        stringBuilder.append(NAME).append(": ").append(fileProperties.getPathInsideCsar()).append("\n");
        String mimeType;
        if (csarEntry instanceof DocumentBasedCsarEntry) {
            mimeType = MimeTypes.MIMETYPE_XSD;
        } else if (csarEntry instanceof XMLDefinitionsBasedCsarEntry || csarEntry instanceof DefinitionsBasedCsarEntry) {
            mimeType = MimeTypes.MIMETYPE_TOSCA_DEFINITIONS;
        } else {
            mimeType = repository.getMimeType(((RepositoryRefBasedCsarEntry) csarEntry).getReference());
        }
        stringBuilder.append(CONTENT_TYPE).append(": ").append(mimeType).append("\n");
        if (exportConfiguration.containsKey(CsarExportConfiguration.INCLUDE_HASHES.name()) && Objects.nonNull(fileProperties.getFileHash())) {
            stringBuilder.append(HASH).append(": ").append(fileProperties.getFileHash()).append("\n");
        }
        if (exportConfiguration.containsKey(CsarExportConfiguration.STORE_IMMUTABLY.name()) && Objects.nonNull(fileProperties.getImmutableAddress())) {
            stringBuilder.append(IMMUTABLE_ADDRESS).append(": ").append(fileProperties.getImmutableAddress()).append("\n");
        }
        stringBuilder.append("\n");
    }
    String manifestString = stringBuilder.toString();
    out.write(manifestString.getBytes());
    out.closeEntry();
    return manifestString;
}

Example 3 with DocumentBasedCsarEntry

use of org.eclipse.winery.repository.export.entries.DocumentBasedCsarEntry in project winery by eclipse.

the class ToscaExportUtil method exportEntityType.

protected void exportEntityType(TDefinitions entryDefinitions, URI uri, DefinitionsChildId tcId) {
    TEntityType entityType = (TEntityType) entryDefinitions.getElement();
    // we have an entity type with a possible properties definition
    WinerysPropertiesDefinition wpd = entityType.getWinerysPropertiesDefinition();
    if (wpd != null) {
        if (wpd.getIsDerivedFromXSD() == null) {
            // Write WPD only to file if it exists and is NOT derived from an XSD (which may happen during import)
            String wrapperElementNamespace = wpd.getNamespace();
            String wrapperElementLocalName = wpd.getElementName();
            // BEGIN: add import and put into CSAR
            TImport imp = new TImport();
            entryDefinitions.getImport().add(imp);
            // fill known import values
            imp.setImportType(XMLConstants.W3C_XML_SCHEMA_NS_URI);
            imp.setNamespace(wrapperElementNamespace);
            // add "winerysPropertiesDefinition" flag to import tag to support
            Map<QName, String> otherAttributes = imp.getOtherAttributes();
            otherAttributes.put(QNames.QNAME_WINERYS_PROPERTIES_DEFINITION_ATTRIBUTE, "true");
            // Determine location
            String loc = BackendUtils.getImportLocationForWinerysPropertiesDefinitionXSD((EntityTypeId) tcId, uri, wrapperElementLocalName);
            if (uri == null) {
                ToscaExportUtil.LOGGER.trace("CSAR Export mode. Putting XSD into CSAR");
                // CSAR Export mode
                // XSD has to be put into the CSAR
                Document document = ModelUtilities.getWinerysPropertiesDefinitionXsdAsDocument(wpd);
                // loc in import is URL encoded, loc on filesystem isn't
                String locInCSAR = EncodingUtil.URLdecode(loc);
                // furthermore, the path has to start from the root of the CSAR; currently, it starts from Definitions/
                locInCSAR = locInCSAR.substring(3);
                ToscaExportUtil.LOGGER.trace("Location in CSAR: {}", locInCSAR);
                CsarContentProperties csarContentProperties = new CsarContentProperties(locInCSAR);
                this.referencesToPathInCSARMap.put(csarContentProperties, new DocumentBasedCsarEntry(document));
            }
            imp.setLocation(loc);
            // END: add import and put into CSAR
            // BEGIN: generate TOSCA conforming PropertiesDefinition
            // Winerys properties definitions are serialized as an XSD.
            // As such their TOSCA representation is a type reference, so we generate that here.
            // Of course that breaks when we export as YAML, but this exporter basically targets XML in the first place
            // TODO: future work — deal with WPD when exporting to YAML
            // (a map[string, string] can be represented as a TDataType)
            TEntityType.XmlTypeDefinition propertiesDefinition = new TEntityType.XmlTypeDefinition();
            propertiesDefinition.setType(new QName(wrapperElementNamespace, wrapperElementLocalName));
            entityType.setProperties(propertiesDefinition);
        // END: generate TOSCA conforming PropertiesDefinition
        } else {
        // otherwise WPD exists, but is derived from XSD
        // we DO NOT have to remove the winery properties definition from the output to allow "debugging" of the CSAR
        }
    }
}