001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019package org.apache.isis.viewer.restfulobjects.server.resources;
020
021import java.net.URL;
022import java.nio.charset.Charset;
023import java.util.Properties;
024
025import org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation;
026import org.apache.isis.viewer.restfulobjects.applib.Rel;
027import org.apache.isis.viewer.restfulobjects.applib.RepresentationType;
028import org.apache.isis.viewer.restfulobjects.rendering.LinkBuilder;
029import org.apache.isis.viewer.restfulobjects.rendering.LinkFollowSpecs;
030import org.apache.isis.viewer.restfulobjects.rendering.RendererContext;
031import org.apache.isis.viewer.restfulobjects.rendering.ReprRendererAbstract;
032import org.apache.isis.viewer.restfulobjects.server.RestfulObjectsApplication;
033
034import com.google.common.io.Resources;
035
036public class VersionReprRenderer extends ReprRendererAbstract<VersionReprRenderer, Void> {
037
038    private static final String META_INF_POM_PROPERTIES = "/META-INF/maven/org.apache.isis.viewer/isis-viewer-restfulobjects-server/pom.properties";
039
040    VersionReprRenderer(final RendererContext resourceContext, final LinkFollowSpecs linkFollower, final JsonRepresentation representation) {
041        super(resourceContext, linkFollower, RepresentationType.VERSION, representation);
042    }
043
044    @Override
045    public VersionReprRenderer with(final Void t) {
046        return this;
047    }
048
049    @Override
050    public JsonRepresentation render() {
051
052        if (includesSelf) {
053            addLinkToSelf();
054            addLinkToUp();
055        }
056
057        representation.mapPut("specVersion", RestfulObjectsApplication.SPEC_VERSION);
058        representation.mapPut("implVersion", versionFromManifest());
059
060        putOptionalCapabilities();
061        putExtensions();
062
063        return representation;
064    }
065
066    private void addLinkToSelf() {
067        final JsonRepresentation link = LinkBuilder.newBuilder(getRendererContext(), Rel.SELF.getName(), RepresentationType.VERSION, "version").build();
068
069        final LinkFollowSpecs linkFollower = getLinkFollowSpecs().follow("links");
070        if (linkFollower.matches(link)) {
071            final VersionReprRenderer renderer = new VersionReprRenderer(getRendererContext(), linkFollower, JsonRepresentation.newMap());
072            link.mapPut("value", renderer.render());
073        }
074
075        getLinks().arrayAdd(link);
076    }
077
078    private void addLinkToUp() {
079        final JsonRepresentation link = LinkBuilder.newBuilder(rendererContext, Rel.UP.getName(), RepresentationType.HOME_PAGE, "").build();
080
081        final LinkFollowSpecs linkFollower = getLinkFollowSpecs().follow("links");
082        if (linkFollower.matches(link)) {
083            final HomePageReprRenderer renderer = new HomePageReprRenderer(getRendererContext(), linkFollower, JsonRepresentation.newMap());
084            link.mapPut("value", renderer.render());
085        }
086        getLinks().arrayAdd(link);
087    }
088
089    private static String versionFromManifest() {
090        try {
091            URL resource = Resources.getResource(META_INF_POM_PROPERTIES);
092            Properties p = new Properties();
093            p.load(Resources.newReaderSupplier(resource, Charset.defaultCharset()).getInput());
094            return p.getProperty("version");
095        } catch (final Exception ex) {
096            return "UNKNOWN";
097        }
098    }
099
100    private void putOptionalCapabilities() {
101        final JsonRepresentation optionalCapabilities = JsonRepresentation.newMap();
102
103        optionalCapabilities.mapPut("blobsClobs", "yes");
104        optionalCapabilities.mapPut("deleteObjects", "yes");
105        optionalCapabilities.mapPut("domainModel", "formal");
106        optionalCapabilities.mapPut("validateOnly", "yes");
107        optionalCapabilities.mapPut("protoPersistentObjects", "yes");
108
109        representation.mapPut("optionalCapabilities", optionalCapabilities);
110    }
111
112    private void putExtensions() {
113        representation.mapPut("extensions", JsonRepresentation.newMap());
114    }
115
116}