/**
* 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.json.viewer.resources.domainobjects;
import java.util.Collection;
import java.util.Map;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.facets.collections.modify.CollectionFacet;
import org.apache.isis.core.metamodel.facets.object.encodeable.EncodableFacet;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
import org.apache.isis.viewer.json.applib.JsonRepresentation;
import org.apache.isis.viewer.json.applib.RepresentationType;
import org.apache.isis.viewer.json.applib.domainobjects.ActionResultRepresentation.ResultType;
import org.apache.isis.viewer.json.applib.links.Rel;
import org.apache.isis.viewer.json.viewer.ResourceContext;
import org.apache.isis.viewer.json.viewer.representations.LinkBuilder;
import org.apache.isis.viewer.json.viewer.representations.LinkFollower;
import org.apache.isis.viewer.json.viewer.representations.RendererFactory;
import org.apache.isis.viewer.json.viewer.representations.RendererFactoryRegistry;
import org.apache.isis.viewer.json.viewer.representations.ReprRenderer;
import org.apache.isis.viewer.json.viewer.representations.ReprRendererAbstract;
import org.apache.isis.viewer.json.viewer.representations.ReprRendererFactoryAbstract;
public class ActionResultReprRenderer extends ReprRendererAbstract<ActionResultReprRenderer, ObjectAndActionInvocation> {
private ObjectAdapterLinkTo adapterLinkTo = new DomainObjectLinkTo();
private ObjectAdapter objectAdapter;
private ObjectAction action;
private JsonRepresentation arguments;
private ObjectAdapter returnedAdapter;
public static class Factory extends ReprRendererFactoryAbstract {
public Factory() {
super(RepresentationType.ACTION_RESULT);
}
@Override
public ReprRenderer<?, ?> newRenderer(final ResourceContext resourceContext, final LinkFollower linkFollower, final JsonRepresentation representation) {
return new ActionResultReprRenderer(resourceContext, linkFollower, getRepresentationType(), representation);
}
}
private ActionResultReprRenderer(final ResourceContext resourceContext, final LinkFollower linkFollower, final RepresentationType representationType, final JsonRepresentation representation) {
super(resourceContext, linkFollower, representationType, representation);
}
@Override
public ActionResultReprRenderer with(final ObjectAndActionInvocation objectAndActionInvocation) {
objectAdapter = objectAndActionInvocation.getObjectAdapter();
action = objectAndActionInvocation.getAction();
arguments = objectAndActionInvocation.getArguments();
returnedAdapter = objectAndActionInvocation.getReturnedAdapter();
adapterLinkTo.with(returnedAdapter);
return this;
}
public void using(final ObjectAdapterLinkTo adapterLinkTo) {
this.adapterLinkTo = adapterLinkTo.with(objectAdapter);
}
@Override
public JsonRepresentation render() {
representationWithSelfFor(action, arguments);
addResult(representation);
addExtensionsIsisProprietaryChangedObjects();
return representation;
}
private void addResult(final JsonRepresentation representation) {
final JsonRepresentation result = JsonRepresentation.newMap();
final ResultType resultType = addResultTo(result);
if (!resultType.isVoid()) {
putResultType(representation, resultType);
representation.mapPut("result", result);
}
}
private ResultType addResultTo(final JsonRepresentation result) {
final ObjectSpecification returnType = this.action.getReturnType();
if (returnType.getCorrespondingClass() == void.class) {
// void
return ResultType.VOID;
}
final CollectionFacet collectionFacet = returnType.getFacet(CollectionFacet.class);
if (collectionFacet != null) {
// collection
final Collection<ObjectAdapter> collectionAdapters = collectionFacet.collection(returnedAdapter);
final RendererFactory factory = getRendererFactoryRegistry().find(RepresentationType.LIST);
final ListReprRenderer renderer = (ListReprRenderer) factory.newRenderer(resourceContext, null, result);
renderer.with(collectionAdapters).withReturnType(action.getReturnType()).withElementType(returnedAdapter.getElementSpecification());
renderer.render();
return ResultType.LIST;
}
final EncodableFacet encodableFacet = returnType.getFacet(EncodableFacet.class);
if (encodableFacet != null) {
// scalar
final RendererFactory factory = getRendererFactoryRegistry().find(RepresentationType.SCALAR_VALUE);
final ScalarValueReprRenderer renderer = (ScalarValueReprRenderer) factory.newRenderer(resourceContext, null, result);
renderer.with(returnedAdapter).withReturnType(action.getReturnType());
renderer.render();
return ResultType.SCALAR_VALUE;
}
{
// object
final RendererFactory factory = getRendererFactoryRegistry().find(RepresentationType.DOMAIN_OBJECT);
final DomainObjectReprRenderer renderer = (DomainObjectReprRenderer) factory.newRenderer(resourceContext, null, result);
renderer.with(returnedAdapter).includesSelf();
renderer.render();
return ResultType.DOMAIN_OBJECT;
}
}
private void putResultType(final JsonRepresentation representation, final ResultType resultType) {
representation.mapPut("resulttype", resultType.getValue());
}
private JsonRepresentation representationWithSelfFor(final ObjectAction action, final JsonRepresentation bodyArgs) {
final JsonRepresentation links = JsonRepresentation.newArray();
representation.mapPut("links", links);
final LinkBuilder selfLinkBuilder = adapterLinkTo.memberBuilder(Rel.SELF, MemberType.ACTION, action, RepresentationType.ACTION_RESULT, "invoke");
// TODO: remove duplication with AbstractObjectMember#addLinkTo
final MemberType memberType = MemberType.of(action);
final Map<String, MutatorSpec> mutators = memberType.getMutators();
final ActionSemantics semantics = ActionSemantics.determine(getResourceContext(), action);
final String mutator = semantics.getInvokeKey();
final MutatorSpec mutatorSpec = mutators.get(mutator);
selfLinkBuilder.withHttpMethod(mutatorSpec.httpMethod);
final JsonRepresentation selfLink = selfLinkBuilder.build();
links.arrayAdd(selfLink);
selfLink.mapPut("args", bodyArgs);
return representation;
}
protected RendererFactoryRegistry getRendererFactoryRegistry() {
// TODO: yuck
return RendererFactoryRegistry.instance;
}
}