import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH;
import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH_PART;
+import com.google.common.collect.ImmutableList;
import java.net.URI;
import java.time.Clock;
import java.time.LocalDateTime;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import javax.ws.rs.Path;
-import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.UriInfo;
-import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.mdsal.dom.api.DOMActionResult;
-import org.opendaylight.mdsal.dom.api.DOMDataBroker;
import org.opendaylight.mdsal.dom.api.DOMMountPoint;
-import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
import org.opendaylight.restconf.common.context.NormalizedNodeContext;
import org.opendaylight.restconf.common.context.WriterParameters;
import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
-import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
+import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfTransaction;
import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
+import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert;
import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfInvokeOperationsUtil;
import org.opendaylight.restconf.nb.rfc8040.streams.Configuration;
import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter;
import org.opendaylight.restconf.nb.rfc8040.utils.mapping.RestconfMappingNodeUtil;
-import org.opendaylight.restconf.nb.rfc8040.utils.parser.IdentifierCodec;
import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.yang.common.Revision;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
*/
@Path("/")
public class RestconfDataServiceImpl implements RestconfDataService {
+ // FIXME: we should be able to interpret 'point' and refactor this class into a behavior
private static final class QueryParams implements Immutable {
final @Nullable String point;
- final @Nullable String insert;
+ final @Nullable Insert insert;
- QueryParams(final @Nullable String insert, final @Nullable String point) {
+ QueryParams(final @Nullable Insert insert, final @Nullable String point) {
this.insert = insert;
this.point = point;
}
final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
- final RestconfStrategy strategy = getRestconfStrategy(instanceIdentifier, mountPoint);
- final NormalizedNode<?, ?> node = readData(identifier, parameters.getContent(),
- strategy, parameters.getWithDefault(), schemaContextRef, uriInfo);
+ final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
+ final NormalizedNode<?, ?> node;
+ if (parameters.getFieldPaths() != null && !parameters.getFieldPaths().isEmpty()) {
+ node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
+ strategy, parameters.getWithDefault(), schemaContextRef, parameters.getFieldPaths());
+ } else {
+ node = readData(identifier, parameters.getContent(), instanceIdentifier.getInstanceIdentifier(), strategy,
+ parameters.getWithDefault(), schemaContextRef, uriInfo);
+ }
if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
&& identifier.contains(STREAM_LOCATION_PATH_PART)) {
final String value = (String) node.getValue();
if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
|| parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
final QName type = node.getNodeType();
- return Response.status(200)
+ return Response.status(Status.OK)
.entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
.header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
+ "-" + type.getLocalName() + '"')
.build();
}
- return Response.status(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build();
+ return Response.status(Status.OK)
+ .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
+ .build();
}
/**
* @return {@link NormalizedNode}
*/
private NormalizedNode<?, ?> readData(final String identifier, final String content,
- final RestconfStrategy strategy, final String withDefa, final EffectiveModelContext schemaContext,
- final UriInfo uriInfo) {
+ final YangInstanceIdentifier path, final RestconfStrategy strategy, final String withDefa,
+ final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
if (identifier != null && identifier.contains(STREAMS_PATH) && !identifier.contains(STREAM_PATH_PART)) {
createAllYangNotificationStreams(strategy, schemaContext, uriInfo);
}
- return ReadDataTransactionUtil.readData(content, strategy, withDefa, schemaContext);
+ return ReadDataTransactionUtil.readData(content, path, strategy, withDefa, schemaContext);
}
private void createAllYangNotificationStreams(final RestconfStrategy strategy,
final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
- strategy.prepareReadWriteExecution();
- final boolean exist = checkExist(schemaContext, strategy);
+ final RestconfTransaction transaction = strategy.prepareWriteExecution();
for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
final NotificationListenerAdapter notifiStreamXML =
final NotificationListenerAdapter notifiStreamJSON =
CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
NotificationOutputType.JSON);
- writeNotificationStreamToDatastore(schemaContext, uriInfo, strategy, exist, notifiStreamXML);
- writeNotificationStreamToDatastore(schemaContext, uriInfo, strategy, exist, notifiStreamJSON);
+ writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, notifiStreamXML);
+ writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, notifiStreamJSON);
}
try {
- strategy.commit().get();
+ transaction.commit().get();
} catch (final InterruptedException | ExecutionException e) {
throw new RestconfDocumentedException("Problem while putting data to DS.", e);
}
}
private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
- final UriInfo uriInfo, final RestconfStrategy strategy, final boolean exist,
- final NotificationListenerAdapter listener) {
+ final UriInfo uriInfo, final RestconfTransaction transaction, final NotificationListenerAdapter listener) {
final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
- final NormalizedNode<?, ?> mapToStreams =
- RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
- listener.getSchemaPath().getLastComponent(), schemaContext.getNotifications(), null,
- listener.getOutputType(), uri, SubscribeToStreamUtil.getMonitoringModule(schemaContext), exist);
- writeDataToDS(schemaContext,
- listener.getSchemaPath().getLastComponent().getLocalName(), strategy, exist, mapToStreams);
- }
+ final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
+ listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
+ listener.getOutputType(), uri);
- private static boolean checkExist(final EffectiveModelContext schemaContext, final RestconfStrategy strategy) {
- try {
- return strategy.exists(LogicalDatastoreType.OPERATIONAL,
- IdentifierCodec.deserialize(Rfc8040.MonitoringModule.PATH_TO_STREAMS, schemaContext)).get();
- } catch (final InterruptedException | ExecutionException exception) {
- throw new RestconfDocumentedException("Problem while checking data if exists", exception);
- }
- }
-
- private static void writeDataToDS(final EffectiveModelContext schemaContext, final String name,
- final RestconfStrategy strategy, final boolean exist,
- final NormalizedNode<?, ?> mapToStreams) {
- final String pathId;
- if (exist) {
- pathId = Rfc8040.MonitoringModule.PATH_TO_STREAM_WITHOUT_KEY + name;
- } else {
- pathId = Rfc8040.MonitoringModule.PATH_TO_STREAMS;
- }
- strategy.merge(LogicalDatastoreType.OPERATIONAL, IdentifierCodec.deserialize(pathId, schemaContext),
- mapToStreams);
+ transaction.merge(LogicalDatastoreType.OPERATIONAL,
+ Rfc8040.MonitoringModule.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
}
@Override
final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
final EffectiveModelContext ref = mountPoint == null
- ? this.schemaContextHandler.get()
- : mountPoint.getEffectiveModelContext();
+ ? this.schemaContextHandler.get() : modelContext(mountPoint);
- final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(), mountPoint);
+ final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
}
private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
boolean insertUsed = false;
boolean pointUsed = false;
- String insert = null;
+ Insert insert = null;
String point = null;
for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
switch (entry.getKey()) {
case INSERT:
- if (!insertUsed) {
- insertUsed = true;
- insert = entry.getValue().get(0);
- } else {
+ if (insertUsed) {
throw new RestconfDocumentedException("Insert parameter can be used only once.",
- RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
+ RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
+ }
+
+ insertUsed = true;
+ final String str = entry.getValue().get(0);
+ insert = Insert.forValue(str);
+ if (insert == null) {
+ throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
+ RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
}
break;
case POINT:
- if (!pointUsed) {
- pointUsed = true;
- point = entry.getValue().get(0);
- } else {
+ if (pointUsed) {
throw new RestconfDocumentedException("Point parameter can be used only once.",
- RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
+ RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
}
+
+ pointUsed = true;
+ point = entry.getValue().get(0);
break;
default:
throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
return new QueryParams(insert, point);
}
- private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final String insert) {
- if (pointUsed && !insertUsed) {
- throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
+ private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) {
+ if (pointUsed) {
+ if (!insertUsed) {
+ throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
- }
- if (pointUsed && (insert.equals("first") || insert.equals("last"))) {
- throw new RestconfDocumentedException(
+ }
+
+ if (insert != Insert.BEFORE && insert != Insert.AFTER) {
+ throw new RestconfDocumentedException(
"Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
+ }
}
}
final QueryParams checkedParms = checkQueryParameters(uriInfo);
final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
- final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(),
- payload.getInstanceIdentifierContext().getMountPoint());
+ final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
}
identifier, this.schemaContextHandler.get(), Optional.of(this.mountPointServiceHandler.get()));
final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
- final RestconfStrategy strategy = getRestconfStrategy(instanceIdentifier, mountPoint);
- return DeleteDataTransactionUtil.deleteData(strategy);
+ final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
+ return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
}
@Override
@Override
public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
- final DOMMountPoint mountPoint = requireNonNull(context).getInstanceIdentifierContext().getMountPoint();
- final RestconfStrategy strategy = getRestconfStrategy(context.getInstanceIdentifierContext(), mountPoint);
+ final DOMMountPoint mountPoint = RestconfDocumentedException.throwIfNull(context,
+ ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, "No patch documented provided")
+ .getInstanceIdentifierContext().getMountPoint();
+ final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
}
public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
requireNonNull(payload);
- final InstanceIdentifierContext<? extends SchemaNode> iid = payload
- .getInstanceIdentifierContext();
-
+ final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
final EffectiveModelContext ref = mountPoint == null
- ? this.schemaContextHandler.get()
- : mountPoint.getEffectiveModelContext();
- final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(), mountPoint);
+ ? this.schemaContextHandler.get() : modelContext(mountPoint);
+ final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
}
private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
- return mountPoint == null ? schemaContextHandler.get() : mountPoint.getEffectiveModelContext();
- }
-
- public synchronized RestconfStrategy getRestconfStrategy(final InstanceIdentifierContext<?> instanceIdentifier,
- final DOMMountPoint mountPoint) {
- if (mountPoint != null) {
- final Optional<NetconfDataTreeService> service = mountPoint.getService(NetconfDataTreeService.class);
- if (service.isPresent()) {
- return new NetconfRestconfStrategy(service.get(), instanceIdentifier);
- }
- }
- final TransactionChainHandler transactionChain = mountPoint == null
- ? transactionChainHandler : transactionChainOfMountPoint(mountPoint);
- return new MdsalRestconfStrategy(instanceIdentifier, transactionChain);
+ return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
}
- /**
- * Prepare transaction chain to access data of mount point.
- *
- * @param mountPoint mount point reference
- * @return {@link TransactionChainHandler}
- */
- private static TransactionChainHandler transactionChainOfMountPoint(final @NonNull DOMMountPoint mountPoint) {
- final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
- if (domDataBrokerService.isPresent()) {
- return new TransactionChainHandler(domDataBrokerService.get());
+ // FIXME: why is this synchronized?
+ public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
+ if (mountPoint == null) {
+ return new MdsalRestconfStrategy(transactionChainHandler);
}
- final String errMsg = "DOM data broker service isn't available for mount point " + mountPoint.getIdentifier();
- LOG.warn(errMsg);
- throw new RestconfDocumentedException(errMsg);
+ return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
+ LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
+ return new RestconfDocumentedException("Could not find a supported access interface in mount point "
+ + mountPoint.getIdentifier());
+ });
}
/**
public Response invokeAction(final NormalizedNodeContext payload) {
final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
final DOMMountPoint mountPoint = context.getMountPoint();
- final SchemaPath schemaPath = context.getSchemaNode().getPath();
+ final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
+ .getPathFromRoot()));
final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
final NormalizedNode<?, ?> data = payload.getData();
if (mountPoint != null) {
response = RestconfInvokeOperationsUtil.invokeActionViaMountPoint(mountPoint, (ContainerNode) data,
schemaPath, yangIIdContext);
- schemaContextRef = mountPoint.getEffectiveModelContext();
+ schemaContextRef = modelContext(mountPoint);
} else {
response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath,
this.actionServiceHandler, yangIIdContext);
}
if (resultData != null && resultData.getValue().isEmpty()) {
- throw new WebApplicationException(Response.Status.NO_CONTENT);
+ return Response.status(Status.NO_CONTENT).build();
}
- return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,
- resultNodeSchema, mountPoint, schemaContextRef), resultData)).build();
+ return Response.status(Status.OK)
+ .entity(new NormalizedNodeContext(
+ new InstanceIdentifierContext<>(yangIIdContext, resultNodeSchema, mountPoint, schemaContextRef),
+ resultData))
+ .build();
+ }
+
+ private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
+ return mountPoint.getService(DOMSchemaService.class)
+ .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
+ .orElse(null);
}
}
Code Review / netconf.git / blobdiff