/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.isis.viewer.restfulobjects.rendering.service.conneg;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.List;
import java.util.Map;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.ResponseBuilder;
import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.NatureOfService;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.adapter.version.Version;
import org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation;
import org.apache.isis.viewer.restfulobjects.applib.RepresentationType;
import org.apache.isis.viewer.restfulobjects.applib.client.RestfulResponse;
import org.apache.isis.viewer.restfulobjects.rendering.Caching;
import org.apache.isis.viewer.restfulobjects.rendering.Responses;
import org.apache.isis.viewer.restfulobjects.rendering.RestfulObjectsApplicationException;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ActionResultReprRenderer;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.DomainObjectReprRenderer;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectActionReprRenderer;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectAndAction;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectAndActionInvocation;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectAndCollection;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectAndCollection2;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectAndProperty;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectAndProperty2;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectCollectionReprRenderer;
import org.apache.isis.viewer.restfulobjects.rendering.domainobjects.ObjectPropertyReprRenderer;
import org.apache.isis.viewer.restfulobjects.rendering.service.RepresentationService;
@DomainService(
nature = NatureOfService.DOMAIN,
menuOrder = "" + Integer.MAX_VALUE
)
public class ContentNegotiationServiceForRestfulObjectsV1_0 implements ContentNegotiationService {
private static final DateFormat ETAG_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
private boolean strictAcceptChecking;
@PostConstruct
public void init(final Map<String, String> properties) {
final String strictAcceptCheckingStr = properties.get("isis.viewer.restfulobjects.strictAcceptChecking");
this.strictAcceptChecking = "true".equalsIgnoreCase(strictAcceptCheckingStr);
}
@PreDestroy
public void shutdown() {
}
@Override
public ResponseBuilder buildResponse(
final RepresentationService.Context2 rendererContext,
final ObjectAdapter objectAdapter) {
final List<MediaType> list = rendererContext.getAcceptableMediaTypes();
ensureCompatibleAcceptHeader(RepresentationType.DOMAIN_OBJECT, list);
final ResponseBuilder responseBuilder = buildResponseTo(
rendererContext, objectAdapter, JsonRepresentation.newMap(), null);
return responseBuilder(responseBuilder);
}
/**
* Not API
*/
ResponseBuilder buildResponseTo(
final RepresentationService.Context2 rendererContext,
final ObjectAdapter objectAdapter,
final JsonRepresentation representationIfAnyRequired,
final JsonRepresentation rootRepresentation) {
final DomainObjectReprRenderer renderer =
new DomainObjectReprRenderer(rendererContext, null, representationIfAnyRequired);
renderer.with(objectAdapter).includesSelf();
final ResponseBuilder responseBuilder = Responses.ofOk(renderer, Caching.NONE, rootRepresentation);
if(rendererContext instanceof RepresentationService.Context6) {
final RepresentationService.Context6 context6 = (RepresentationService.Context6) rendererContext;
final RepresentationService.Intent intent = context6.getIntent();
if(intent == RepresentationService.Intent.JUST_CREATED) {
responseBuilder.status(Response.Status.CREATED);
}
}
final Version version = objectAdapter.getVersion();
if (version != null && version.getTime() != null) {
responseBuilder.tag(ETAG_FORMAT.format(version.getTime()));
}
return responseBuilder;
}
@Override
public ResponseBuilder buildResponse(
final RepresentationService.Context2 rendererContext,
final ObjectAndProperty objectAndProperty) {
final List<MediaType> list = rendererContext.getAcceptableMediaTypes();
ensureCompatibleAcceptHeader(RepresentationType.OBJECT_PROPERTY, list);
final ObjectPropertyReprRenderer renderer = new ObjectPropertyReprRenderer(rendererContext);
renderer.with(objectAndProperty)
.usingLinkTo(rendererContext.getAdapterLinkTo());
if(objectAndProperty instanceof ObjectAndProperty2) {
final ObjectAndProperty2 objectAndProperty2 = (ObjectAndProperty2) objectAndProperty;
renderer
.withMemberMode(objectAndProperty2.getMemberReprMode());
}
final ResponseBuilder responseBuilder = Responses.ofOk(renderer, Caching.NONE);
return responseBuilder;
}
@Override
public ResponseBuilder buildResponse(
final RepresentationService.Context2 rendererContext,
final ObjectAndCollection objectAndCollection) {
final List<MediaType> list = rendererContext.getAcceptableMediaTypes();
ensureCompatibleAcceptHeader(RepresentationType.OBJECT_COLLECTION, list);
final ResponseBuilder responseBuilder =
buildResponseTo(rendererContext, objectAndCollection, JsonRepresentation.newMap(), null);
return responseBuilder(responseBuilder);
}
/**
* Not API
*/
ResponseBuilder buildResponseTo(
final RepresentationService.Context2 rendererContext,
final ObjectAndCollection objectAndCollection,
final JsonRepresentation representation,
final JsonRepresentation rootRepresentation) {
final ObjectCollectionReprRenderer renderer =
new ObjectCollectionReprRenderer(rendererContext, null, null, representation);
renderer.with(objectAndCollection)
.usingLinkTo(rendererContext.getAdapterLinkTo());
if(objectAndCollection instanceof ObjectAndCollection2) {
final ObjectAndCollection2 objectAndCollection2 = (ObjectAndCollection2) objectAndCollection;
renderer.withMemberMode(objectAndCollection2.getMemberReprMode());
}
return Responses.ofOk(renderer, Caching.NONE, rootRepresentation);
}
@Override
public ResponseBuilder buildResponse(
final RepresentationService.Context2 rendererContext,
final ObjectAndAction objectAndAction) {
final List<MediaType> list = rendererContext.getAcceptableMediaTypes();
ensureCompatibleAcceptHeader(RepresentationType.OBJECT_ACTION, list);
final ObjectActionReprRenderer renderer = new ObjectActionReprRenderer(rendererContext);
renderer.with(objectAndAction)
.usingLinkTo(rendererContext.getAdapterLinkTo())
.asStandalone();
final ResponseBuilder responseBuilder = Responses.ofOk(renderer, Caching.NONE);
return responseBuilder(responseBuilder);
}
@Override
public ResponseBuilder buildResponse(
final RepresentationService.Context2 rendererContext,
final ObjectAndActionInvocation objectAndActionInvocation) {
final List<MediaType> list = rendererContext.getAcceptableMediaTypes();
ensureCompatibleAcceptHeader(RepresentationType.ACTION_RESULT, list);
final ResponseBuilder responseBuilder =
buildResponseTo(rendererContext, objectAndActionInvocation, JsonRepresentation.newMap(), null);
return responseBuilder(responseBuilder);
}
/**
* Not API
*/
ResponseBuilder buildResponseTo(
final RepresentationService.Context2 rendererContext,
final ObjectAndActionInvocation objectAndActionInvocation,
final JsonRepresentation representation,
final JsonRepresentation rootRepresentation) {
final ActionResultReprRenderer renderer =
new ActionResultReprRenderer(rendererContext, null, objectAndActionInvocation.getSelfLink(), representation);
renderer.with(objectAndActionInvocation)
.using(rendererContext.getAdapterLinkTo());
final ResponseBuilder responseBuilder = Responses.ofOk(renderer, Caching.NONE, rootRepresentation);
Responses.addLastModifiedAndETagIfAvailable(responseBuilder, objectAndActionInvocation.getObjectAdapter().getVersion());
return responseBuilder;
}
/**
* For easy subclassing to further customize, eg additional headers
*/
protected ResponseBuilder responseBuilder(final ResponseBuilder responseBuilder) {
return responseBuilder;
}
private void ensureCompatibleAcceptHeader(
final RepresentationType representationType,
final List<MediaType> acceptableMediaTypes) {
if(!strictAcceptChecking) {
return;
}
if (representationType == null) {
return;
}
// RestEasy will check the basic media types...
// ... so we just need to check the profile paramter
final String producedProfile = representationType.getMediaTypeProfile();
if(producedProfile != null) {
for (MediaType mediaType : acceptableMediaTypes ) {
String acceptedProfileValue = mediaType.getParameters().get("profile");
if(acceptedProfileValue == null) {
continue;
}
if(!producedProfile.equals(acceptedProfileValue)) {
throw RestfulObjectsApplicationException.create(RestfulResponse.HttpStatusCode.NOT_ACCEPTABLE);
}
}
}
}
}