/// <summary>
/// Creates the <see cref="ODataNavigationLink"/> to be written while writing this entity.
/// </summary>
/// <param name="navigationProperty">The navigation property for which the navigation link is being created.</param>
/// <param name="entityInstanceContext">The context for the entity instance being written.</param>
/// <returns>The navigation link to be written.</returns>
public virtual ODataNavigationLink CreateNavigationLink(IEdmNavigationProperty navigationProperty, EntityInstanceContext entityInstanceContext)
{
if (navigationProperty == null)
{
throw Error.ArgumentNull("navigationProperty");
}
if (entityInstanceContext == null)
{
throw Error.ArgumentNull("entityInstanceContext");
}
ODataSerializerContext writeContext = entityInstanceContext.SerializerContext;
ODataNavigationLink navigationLink = null;
if (writeContext.NavigationSource != null)
{
IEdmTypeReference propertyType = navigationProperty.Type;
IEdmModel model = writeContext.Model;
NavigationSourceLinkBuilderAnnotation linkBuilder = model.GetNavigationSourceLinkBuilder(writeContext.NavigationSource);
Uri navigationUrl = linkBuilder.BuildNavigationLink(entityInstanceContext, navigationProperty, writeContext.MetadataLevel);
navigationLink = new ODataNavigationLink
{
IsCollection = propertyType.IsCollection(),
Name = navigationProperty.Name,
};
if (navigationUrl != null)
{
navigationLink.Url = navigationUrl;
}
}
return(navigationLink);
}
public void NavigationLinksGenerationConvention_GeneratesLinksWithCast_ForDerivedProperties()
{
ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet <Vehicle>("vehicles");
builder.EntitySet <Manufacturer>("manufacturers");
IEdmModel model = builder.GetEdmModel();
IEdmEntitySet vehiclesEdmEntitySet = model.EntityContainer.FindEntitySet("vehicles");
IEdmEntityType carType = model.AssertHasEntityType(typeof(Car));
IEdmNavigationProperty carManufacturerProperty = carType.AssertHasNavigationProperty(model, "Manufacturer", typeof(CarManufacturer), isNullable: true, multiplicity: EdmMultiplicity.ZeroOrOne);
HttpConfiguration configuration = new HttpConfiguration();
string routeName = "Route";
configuration.MapODataServiceRoute(routeName, null, model);
HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, "http://localhost");
request.SetConfiguration(configuration);
request.ODataProperties().RouteName = routeName;
NavigationSourceLinkBuilderAnnotation linkBuilder = model.GetNavigationSourceLinkBuilder(vehiclesEdmEntitySet);
var serializerContext = new ODataSerializerContext {
Model = model, NavigationSource = vehiclesEdmEntitySet, Url = request.GetUrlHelper()
};
var entityContext = new EntityInstanceContext(serializerContext, carType.AsReference(), new Car {
Model = 2009, Name = "Accord"
});
Uri uri = linkBuilder.BuildNavigationLink(entityContext, carManufacturerProperty, ODataMetadataLevel.FullMetadata);
Assert.Equal("http://localhost/vehicles(Model=2009,Name='Accord')/System.Web.OData.Builder.TestModels.Car/Manufacturer", uri.AbsoluteUri);
}
public void NavigationLinksGenerationConvention_GeneratesLinksWithCast_ForDerivedProperties()
{
ODataConventionModelBuilder builder = ODataConventionModelBuilderFactory.Create();
builder.EntitySet <Vehicle>("vehicles");
builder.EntitySet <Manufacturer>("manufacturers");
IEdmModel model = builder.GetEdmModel();
IEdmEntitySet vehiclesEdmEntitySet = model.EntityContainer.FindEntitySet("vehicles");
IEdmEntityType carType = model.AssertHasEntityType(typeof(Car));
IEdmNavigationProperty carManufacturerProperty = carType.AssertHasNavigationProperty(model, "Manufacturer", typeof(CarManufacturer), isNullable: true, multiplicity: EdmMultiplicity.ZeroOrOne);
var configuration = RoutingConfigurationFactory.Create();
string routeName = "Route";
configuration.MapODataServiceRoute(routeName, null, model);
var request = RequestFactory.Create(HttpMethod.Get, "http://localhost", configuration, routeName);
NavigationSourceLinkBuilderAnnotation linkBuilder = model.GetNavigationSourceLinkBuilder(vehiclesEdmEntitySet);
linkBuilder.AddNavigationPropertyLinkBuilder(carManufacturerProperty, new NavigationLinkBuilder((context, property) => context.GenerateNavigationPropertyLink(property, includeCast: true), false));
var serializerContext = ODataSerializerContextFactory.Create(model, vehiclesEdmEntitySet, request);
var entityContext = new ResourceContext(serializerContext, carType.AsReference(), new Car {
Model = 2009, Name = "Accord"
});
Uri uri = linkBuilder.BuildNavigationLink(entityContext, carManufacturerProperty, ODataMetadataLevel.MinimalMetadata);
Assert.Equal("http://localhost/vehicles(Model=2009,Name='Accord')/Microsoft.AspNet.OData.Test.Builder.TestModels.Car/Manufacturer", uri.AbsoluteUri);
}
public void NavigationLinksGenerationConvention_GeneratesLinksWithoutCast_ForBaseProperties()
{
ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet <SportBike>("vehicles");
builder.EntitySet <Manufacturer>("manufacturers");
IEdmModel model = builder.GetEdmModel();
IEdmEntitySet vehiclesEdmEntitySet = model.EntityContainer.FindEntitySet("vehicles");
IEdmEntityType sportbikeType = model.AssertHasEntityType(typeof(SportBike));
IEdmNavigationProperty motorcycleManufacturerProperty = sportbikeType.AssertHasNavigationProperty(model, "Manufacturer", typeof(MotorcycleManufacturer), isNullable: true, multiplicity: EdmMultiplicity.ZeroOrOne);
HttpConfiguration configuration = new HttpConfiguration();
string routeName = "Route";
configuration.MapODataServiceRoute(routeName, null, model);
HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, "http://localhost");
request.SetConfiguration(configuration);
request.ODataProperties().RouteName = routeName;
NavigationSourceLinkBuilderAnnotation linkBuilder = model.GetNavigationSourceLinkBuilder(vehiclesEdmEntitySet);
var serializerContext = new ODataSerializerContext {
Model = model, NavigationSource = vehiclesEdmEntitySet, Url = request.GetUrlHelper()
};
var entityContext = new EntityInstanceContext(serializerContext, sportbikeType.AsReference(), new SportBike {
Model = 2009, Name = "Ninja"
});
Uri uri = linkBuilder.BuildNavigationLink(entityContext, motorcycleManufacturerProperty, ODataMetadataLevel.Default);
Assert.Equal("http://localhost/vehicles(Model=2009,Name='Ninja')/Manufacturer", uri.AbsoluteUri);
}
private static Uri GetNestedNextPageLink(ODataSerializerContext writeContext, int pageSize, object obj)
{
Contract.Assert(writeContext.ExpandedResource != null);
IEdmNavigationSource sourceNavigationSource = writeContext.ExpandedResource.NavigationSource;
NavigationSourceLinkBuilderAnnotation linkBuilder = writeContext.Model.GetNavigationSourceLinkBuilder(sourceNavigationSource);
Uri navigationLink =
linkBuilder.BuildNavigationLink(writeContext.ExpandedResource, writeContext.NavigationProperty);
Uri nestedNextLink = GenerateQueryFromExpandedItem(writeContext, navigationLink);
SkipTokenHandler nextLinkGenerator = null;
if (writeContext.QueryContext != null)
{
nextLinkGenerator = writeContext.QueryContext.GetSkipTokenHandler();
}
if (nestedNextLink != null)
{
if (nextLinkGenerator != null)
{
return(nextLinkGenerator.GenerateNextPageLink(nestedNextLink, pageSize, obj, writeContext));
}
return(GetNextPageHelper.GetNextPageLink(nestedNextLink, pageSize));
}
return(null);
}
public void BuildNavigationLink_ThrowsArgumentNull_NavigationProperty()
{
// Arrange
NavigationSourceLinkBuilderAnnotation linkBuilder = new NavigationSourceLinkBuilderAnnotation(_customers, _model);
// Act & Assert
ExceptionAssert.ThrowsArgumentNull(() => linkBuilder.BuildNavigationLink(new ResourceContext(), null, ODataMetadataLevel.Full), "navigationProperty");
}
private static Uri GetNestedNextPageLink(ODataSerializerContext writeContext, int pageSize)
{
Contract.Assert(writeContext.ExpandedEntity != null);
IEdmNavigationSource sourceNavigationSource = writeContext.ExpandedEntity.NavigationSource;
NavigationSourceLinkBuilderAnnotation linkBuilder = writeContext.Model.GetNavigationSourceLinkBuilder(sourceNavigationSource);
Uri navigationLink =
linkBuilder.BuildNavigationLink(writeContext.ExpandedEntity, writeContext.NavigationProperty);
if (navigationLink != null)
{
return(HttpRequestMessageExtensions.GetNextPageLink(navigationLink, pageSize));
}
return(null);
}
private static Uri GetNestedNextPageLink(ODataSerializerContext writeContext, int pageSize)
{
Contract.Assert(writeContext.ExpandedResource != null);
IEdmNavigationSource sourceNavigationSource = writeContext.ExpandedResource.NavigationSource;
NavigationSourceLinkBuilderAnnotation linkBuilder = writeContext.Model.GetNavigationSourceLinkBuilder(sourceNavigationSource);
Uri navigationLink =
linkBuilder.BuildNavigationLink(writeContext.ExpandedResource, writeContext.NavigationProperty);
if (navigationLink != null)
{
return(GetNextPageHelper.GetNextPageLink(navigationLink, pageSize));
}
return(null);
}
private static Uri GetNestedNextPageLink(ODataSerializerContext writeContext, int pageSize)
{
Contract.Assert(writeContext.ExpandedEntity != null);
IEdmNavigationSource sourceNavigationSource = writeContext.ExpandedEntity.NavigationSource;
NavigationSourceLinkBuilderAnnotation linkBuilder = writeContext.Model.GetNavigationSourceLinkBuilder(sourceNavigationSource);
Uri navigationLink =
linkBuilder.BuildNavigationLink(writeContext.ExpandedEntity, writeContext.NavigationProperty);
if (navigationLink != null)
{
// return ODataQueryOptions.GetNextPageLink(navigationLink, pageSize);
throw new NotImplementedException("ODataQueryOptions");
}
return(null);
}
public void HasNavigationPropertyLink_SetsIdLinkBuilder()
{
// Arrange
EdmModel model = new EdmModel();
NavigationLinkBuilder linkBuilder = new NavigationLinkBuilder(
(ResourceContext a, IEdmNavigationProperty b) => new Uri("http://orders"), followsConventions: false);
// Act
model.HasNavigationPropertyLink(Customers, OrdersNavigationProperty, linkBuilder);
// Assert
NavigationSourceLinkBuilderAnnotation annotation = model.GetNavigationSourceLinkBuilder(Customers);
Uri uri = annotation.BuildNavigationLink(new ResourceContext(), OrdersNavigationProperty);
Assert.Equal(uri, new Uri("http://orders"));
}
public void BuildNavigationLink_ReturnsNull(bool followsConventions, ODataMetadataLevel metadataLevel)
{
// Arrange
var navigationProperty = _entitySet.EntityType.AddNavigationProperty(typeof(Customer).GetProperty("Orders"), EdmMultiplicity.Many);
IEdmModel model = _modelBuilder.GetEdmModel();
IEdmNavigationProperty edmNavProperty = model.GetEdmTypeReference(typeof(Customer)).AsEntity().DeclaredNavigationProperties().Single(p => p.Name == "Orders");
NavigationSourceLinkBuilderAnnotation linkBuilder = new NavigationSourceLinkBuilderAnnotation(_entitySet);
linkBuilder.AddNavigationPropertyLinkBuilder(edmNavProperty, new NavigationLinkBuilder((context, property) => new Uri("http://navigationlink"), followsConventions));
// Act
Uri generatedNavigationLink = linkBuilder.BuildNavigationLink(new ResourceContext(), edmNavProperty, (ODataMetadataLevel)metadataLevel);
// Assert
Assert.Null(generatedNavigationLink);
}
private static Uri GetNestedNextPageLink(ODataSerializerContext writeContext, int pageSize, object obj)
{
Contract.Assert(writeContext.ExpandedResource != null);
Uri navigationLink;
IEdmNavigationSource sourceNavigationSource = writeContext.ExpandedResource.NavigationSource;
NavigationSourceLinkBuilderAnnotation linkBuilder = writeContext.Model.GetNavigationSourceLinkBuilder(sourceNavigationSource);
// In Contained Navigation, we don't have navigation property binding,
// Hence we cannot get the NavigationLink from the NavigationLinkBuilder
if (writeContext.NavigationSource.NavigationSourceKind() == EdmNavigationSourceKind.ContainedEntitySet)
{
// Contained navigation.
Uri idlink = linkBuilder.BuildIdLink(writeContext.ExpandedResource);
var link = idlink.ToString() + "/" + writeContext.NavigationProperty.Name;
navigationLink = new Uri(link);
}
else
{
// Non-Contained navigation.
navigationLink =
linkBuilder.BuildNavigationLink(writeContext.ExpandedResource, writeContext.NavigationProperty);
}
Uri nestedNextLink = GenerateQueryFromExpandedItem(writeContext, navigationLink);
SkipTokenHandler nextLinkGenerator = null;
if (writeContext.QueryContext != null)
{
nextLinkGenerator = writeContext.QueryContext.GetSkipTokenHandler();
}
if (nestedNextLink != null)
{
if (nextLinkGenerator != null)
{
return(nextLinkGenerator.GenerateNextPageLink(nestedNextLink, pageSize, obj, writeContext));
}
return(GetNextPageHelper.GetNextPageLink(nestedNextLink, pageSize));
}
return(null);
}
public void Ctor_FollowingConventions_GeneratesNavigationLinkWithCast_ForDerivedNavigationProperty()
{
// Arrange
CustomersModelWithInheritance model = new CustomersModelWithInheritance();
var request = RequestFactory.CreateFromModel(model.Model);
ODataSerializerContext serializerContext = ODataSerializerContextFactory.Create(model.Model, model.Customers, request);
ResourceContext instanceContext = new ResourceContext(serializerContext, model.SpecialCustomer.AsReference(), new { ID = 42 });
IEdmNavigationProperty ordersProperty = model.SpecialCustomer.NavigationProperties().First(p => p.Name == "SpecialOrders");
// Act
NavigationSourceLinkBuilderAnnotation linkBuilder = new NavigationSourceLinkBuilderAnnotation(model.Customers, model.Model);
linkBuilder.AddNavigationPropertyLinkBuilder(ordersProperty, new NavigationLinkBuilder((context, property) => context.GenerateNavigationPropertyLink(property, includeCast: true), false));
Uri result = linkBuilder.BuildNavigationLink(instanceContext, ordersProperty, ODataMetadataLevel.MinimalMetadata);
// Assert
Assert.Equal("http://localhost/Customers(42)/NS.SpecialCustomer/SpecialOrders", result.AbsoluteUri);
}
public void NavigationLinksGenerationConvention_GeneratesLinksWithoutCast_ForBaseProperties()
{
ODataConventionModelBuilder builder = ODataConventionModelBuilderFactory.Create();
builder.EntitySet <SportBike>("vehicles");
builder.EntitySet <Manufacturer>("manufacturers");
IEdmModel model = builder.GetEdmModel();
IEdmEntitySet vehiclesEdmEntitySet = model.EntityContainer.FindEntitySet("vehicles");
IEdmEntityType sportbikeType = model.AssertHasEntityType(typeof(SportBike));
IEdmNavigationProperty motorcycleManufacturerProperty = sportbikeType.AssertHasNavigationProperty(model, "Manufacturer", typeof(MotorcycleManufacturer), isNullable: true, multiplicity: EdmMultiplicity.ZeroOrOne);
var configuration = RoutingConfigurationFactory.Create();
string routeName = "Route";
configuration.MapODataServiceRoute(routeName, null, model);
var request = RequestFactory.Create(HttpMethod.Get, "http://localhost", configuration, routeName);
NavigationSourceLinkBuilderAnnotation linkBuilder = model.GetNavigationSourceLinkBuilder(vehiclesEdmEntitySet);
linkBuilder.AddNavigationPropertyLinkBuilder(motorcycleManufacturerProperty, new NavigationLinkBuilder((context, property) => context.GenerateNavigationPropertyLink(property, includeCast: false), false));
var serializerContext = ODataSerializerContextFactory.Create(model, vehiclesEdmEntitySet, request);
var entityContext = new ResourceContext(serializerContext, sportbikeType.AsReference(), new SportBike {
Model = 2009, Name = "Ninja"
});
// We might get one of these:
// http://localhost/vehicles(Model=2009,Name='Ninja')/Manufacturer
// http://localhost/vehicles(Name='Ninja',Model=2009)/Manufacturer
Uri uri = linkBuilder.BuildNavigationLink(entityContext, motorcycleManufacturerProperty, ODataMetadataLevel.MinimalMetadata);
string aboluteUri = uri.AbsoluteUri;
Assert.Contains("http://localhost/vehicles(", aboluteUri);
Assert.Contains("Model=2009", aboluteUri);
Assert.Contains("Name='Ninja'", aboluteUri);
Assert.Contains(")/Manufacturer", aboluteUri);
}
public void NavigationLinksGenerationConvention_GeneratesLinksWithoutCast_ForDeclaredProperties_OnSingleton()
{
ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
builder.Singleton <Car>("Contoso");
builder.EntitySet <Manufacturer>("manufacturers");
IEdmModel model = builder.GetEdmModel();
IEdmSingleton vehicleEdmSingleton = model.EntityContainer.FindSingleton("Contoso");
IEdmEntityType carType = model.AssertHasEntityType(typeof(Car));
IEdmNavigationProperty carManufacturerProperty = carType.AssertHasNavigationProperty(model, "Manufacturer", typeof(CarManufacturer), isNullable: true, multiplicity: EdmMultiplicity.ZeroOrOne);
HttpConfiguration configuration = new HttpConfiguration();
string routeName = "Route";
configuration.MapODataServiceRoute(routeName, null, model);
HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, "http://localhost");
request.SetConfiguration(configuration);
request.EnableODataDependencyInjectionSupport(routeName);
NavigationSourceLinkBuilderAnnotation linkBuilder = model.GetNavigationSourceLinkBuilder(vehicleEdmSingleton);
linkBuilder.AddNavigationPropertyLinkBuilder(carManufacturerProperty, new NavigationLinkBuilder((context, property) => context.GenerateNavigationPropertyLink(property, includeCast: false), false));
var serializerContext = new ODataSerializerContext {
Model = model, NavigationSource = vehicleEdmSingleton, Url = request.GetUrlHelper()
};
var entityContext = new ResourceContext(serializerContext, carType.AsReference(), new Car {
Model = 2014, Name = "Contoso2014"
});
Uri uri = linkBuilder.BuildNavigationLink(entityContext, carManufacturerProperty, ODataMetadataLevel.MinimalMetadata);
Assert.Equal("http://localhost/Contoso/Manufacturer", uri.AbsoluteUri);
}