/**
* 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.server.resources;
import java.util.List;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.consent.Consent;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.metamodel.spec.feature.Contributed;
import org.apache.isis.core.metamodel.spec.feature.ObjectAssociation;
import org.apache.isis.core.metamodel.spec.feature.OneToOneAssociation;
import org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation;
import org.apache.isis.viewer.restfulobjects.server.ResourceContext;
/**
* Utility class that encapsulates the logic for updating an
* {@link org.apache.isis.core.metamodel.adapter.ObjectAdapter object}'s with the
* values of a {@link org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation}.
*
* <p>
* Used in persist or multi-property update
* </p>
*/
public class ObjectAdapterUpdateHelper {
private final ObjectAdapter objectAdapter;
private final ResourceContext resourceContext;
public ObjectAdapterUpdateHelper(ResourceContext resourceContext, ObjectAdapter objectAdapter) {
this.objectAdapter = objectAdapter;
this.resourceContext = resourceContext;
}
public boolean copyOverProperties(
final JsonRepresentation propertiesList) {
final ObjectSpecification objectSpec = objectAdapter.getSpecification();
final List<ObjectAssociation> properties = objectSpec.getAssociations(Contributed.EXCLUDED, ObjectAssociation.Filters.PROPERTIES);
boolean allOk = true;
for (final ObjectAssociation association : properties) {
final OneToOneAssociation property = (OneToOneAssociation) association;
final ObjectSpecification propertySpec = property.getSpecification();
final String id = property.getId();
final JsonRepresentation propertyRepr = propertiesList.getRepresentation(id);
final Consent visibility = property.isVisible(resourceContext.getAuthenticationSession() , objectAdapter, resourceContext.getWhere());
final Consent usability = property.isUsable(resourceContext.getAuthenticationSession() , objectAdapter, resourceContext.getWhere());
final boolean invisible = visibility.isVetoed();
final boolean disabled = usability.isVetoed();
final boolean valueProvided = propertyRepr != null;
if(!valueProvided) {
// no value provided
if(invisible || disabled) {
// that's ok, indeed expected
continue;
}
if (!property.isMandatory()) {
// optional, so also not a problem
continue;
}
// otherwise, is an error.
final String invalidReason = propertiesList.getString("x-ro-invalidReason");
if(invalidReason != null) {
propertiesList.mapPut("x-ro-invalidReason", invalidReason + "; " + property.getName());
} else {
propertiesList.mapPut("x-ro-invalidReason", "Mandatory field(s) missing: " + property.getName());
}
allOk = false;
continue;
} else {
// value has been provided
if (invisible) {
// silently ignore; don't want to acknowledge the existence of this property to the caller
continue;
}
if (disabled) {
// not allowed to update
propertyRepr.mapPut("invalidReason", usability.getReason());
allOk = false;
continue;
}
// ok, we have a value, and the property is not invisible, and is not disabled
final ObjectAdapter valueAdapter;
try {
valueAdapter = new JsonParserHelper(resourceContext, propertySpec).objectAdapterFor(propertyRepr);
} catch(IllegalArgumentException ex) {
propertyRepr.mapPut("invalidReason", ex.getMessage());
allOk = false;
continue;
}
// check if the proposed value is valid
final Consent validity = property.isAssociationValid(objectAdapter, valueAdapter);
if (validity.isAllowed()) {
try {
property.set(objectAdapter, valueAdapter);
} catch (final IllegalArgumentException ex) {
propertyRepr.mapPut("invalidReason", ex.getMessage());
allOk = false;
}
} else {
propertyRepr.mapPut("invalidReason", validity.getReason());
allOk = false;
}
}
}
return allOk;
}
}