| /* |
| * Copyright 2011 Marc Grue. |
| * |
| * Licensed 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.zest.sample.dcicargo.sample_a.bootstrap.assembly; |
| |
| import org.apache.zest.api.structure.Application; |
| import org.apache.zest.api.structure.Module; |
| import org.apache.zest.api.value.ValueSerialization; |
| import org.apache.zest.bootstrap.ApplicationAssembler; |
| import org.apache.zest.bootstrap.ApplicationAssembly; |
| import org.apache.zest.bootstrap.ApplicationAssemblyFactory; |
| import org.apache.zest.bootstrap.AssemblyException; |
| import org.apache.zest.bootstrap.LayerAssembly; |
| import org.apache.zest.bootstrap.ModuleAssembly; |
| import org.apache.zest.entitystore.memory.MemoryEntityStoreService; |
| import org.apache.zest.functional.Function; |
| import org.apache.zest.index.rdf.RdfIndexingEngineService; |
| import org.apache.zest.library.rdf.entity.EntityStateSerializer; |
| import org.apache.zest.library.rdf.entity.EntityTypeSerializer; |
| import org.apache.zest.library.rdf.repository.MemoryRepositoryService; |
| import org.apache.zest.sample.dcicargo.pathfinder_a.api.GraphTraversalService; |
| import org.apache.zest.sample.dcicargo.pathfinder_a.internal.GraphDAO; |
| import org.apache.zest.sample.dcicargo.pathfinder_a.internal.GraphTraversalServiceImpl; |
| import org.apache.zest.sample.dcicargo.sample_a.bootstrap.DCISampleApplication_a; |
| import org.apache.zest.sample.dcicargo.sample_a.bootstrap.sampledata.BaseDataService; |
| import org.apache.zest.sample.dcicargo.sample_a.bootstrap.sampledata.SampleDataService; |
| import org.apache.zest.sample.dcicargo.sample_a.communication.query.BookingQueries; |
| import org.apache.zest.sample.dcicargo.sample_a.communication.query.dto.CargoDTO; |
| import org.apache.zest.sample.dcicargo.sample_a.communication.query.dto.HandlingEventDTO; |
| import org.apache.zest.sample.dcicargo.sample_a.communication.query.dto.LocationDTO; |
| import org.apache.zest.sample.dcicargo.sample_a.communication.query.dto.VoyageDTO; |
| import org.apache.zest.sample.dcicargo.sample_a.context.rolemap.CargoRoleMap; |
| import org.apache.zest.sample.dcicargo.sample_a.context.rolemap.CargosRoleMap; |
| import org.apache.zest.sample.dcicargo.sample_a.context.rolemap.HandlingEventRoleMap; |
| import org.apache.zest.sample.dcicargo.sample_a.context.rolemap.HandlingEventsRoleMap; |
| import org.apache.zest.sample.dcicargo.sample_a.context.rolemap.ItineraryRoleMap; |
| import org.apache.zest.sample.dcicargo.sample_a.context.rolemap.RouteSpecificationRoleMap; |
| import org.apache.zest.sample.dcicargo.sample_a.context.support.ApplicationEvents; |
| import org.apache.zest.sample.dcicargo.sample_a.context.support.RegisterHandlingEventAttemptDTO; |
| import org.apache.zest.sample.dcicargo.sample_a.context.support.RoutingService; |
| import org.apache.zest.sample.dcicargo.sample_a.data.entity.LocationEntity; |
| import org.apache.zest.sample.dcicargo.sample_a.data.entity.VoyageEntity; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.cargo.TrackingId; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.delivery.Delivery; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.delivery.ExpectedHandlingEvent; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.itinerary.Leg; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.location.UnLocode; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.voyage.CarrierMovement; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.voyage.Schedule; |
| import org.apache.zest.sample.dcicargo.sample_a.data.shipping.voyage.VoyageNumber; |
| import org.apache.zest.sample.dcicargo.sample_a.infrastructure.conversion.EntityToDTOService; |
| import org.apache.zest.spi.uuid.UuidIdentityGeneratorService; |
| import org.apache.zest.valueserialization.orgjson.OrgJsonValueSerializationService; |
| |
| import static org.apache.zest.api.common.Visibility.application; |
| import static org.apache.zest.api.structure.Application.Mode.development; |
| |
| /** |
| * Zest assembly of the DCI Sample application (version A) |
| * |
| * A Zest application structure is declared by an assembly that defines which layers and modules |
| * the application has and how they are allowed to depend on each other. Each layer could have it's |
| * own assembly file in larger applications (read more at http://qi4j.org/latest/core-bootstrap-assembly.html). |
| * |
| * The Zest assembly doesn't follow a strict 1-1 correlation between the directory hierarchy and |
| * the assembly structures. An example is the Entities: |
| * |
| * Entities can be promoted to Role Players when they are needed to play a Role in a Context. |
| * One Role Map is created for each Entity and it lists Roles in different Contexts that the Entity |
| * can play. It hence has knowledge about the Context layer. If an Entity is in a Role Map it doesn't |
| * get assembled as an Entity down in the Data layer but rather up in the CONTEXT-EntityRole module. |
| * The Entities left behind without Roles could still have been assembled in a DATA-Entity module but |
| * to avoid swapping Entities up and down between the Data and Context layers we have them all in the |
| * Context layer. Note that there are still no "physical" upward dependencies from the Entities to |
| * layers above. |
| * |
| * So dependency structure layers (ie. as shown by Structure101) are not the same as Zest layers. |
| * See more at http://qi4j.org/latest/core-bootstrap-assembly.html |
| * |
| * TRY THIS: Run VisualizeApplicationStructure to see a cool visualization of the assembly below! |
| */ |
| @SuppressWarnings( "unchecked" ) |
| public class Assembler |
| implements ApplicationAssembler |
| { |
| public ApplicationAssembly assemble( ApplicationAssemblyFactory applicationFactory ) |
| throws AssemblyException |
| { |
| // Application assembly |
| ApplicationAssembly assembly = applicationFactory.newApplicationAssembly(); |
| assembly.setName( "DCI Sample (version A)" ); |
| assembly.setVersion( "A.1.0" ); |
| assembly.setMode( development ); |
| |
| // Layers (adding bottom-up - will be assembled in this order) |
| LayerAssembly infrastructureLayer = assembly.layer( "INFRASTRUCTURE" ); |
| LayerAssembly dataLayer = assembly.layer( "DATA" ); |
| LayerAssembly contextLayer = assembly.layer( "CONTEXT" ); |
| LayerAssembly communicationLayer = assembly.layer( "COMMUNICATION" ); |
| LayerAssembly bootstrapLayer = assembly.layer( "BOOTSTRAP" ); |
| |
| // Layer dependencies |
| bootstrapLayer.uses( |
| communicationLayer, |
| contextLayer, |
| dataLayer, |
| infrastructureLayer ); |
| |
| communicationLayer.uses( |
| contextLayer, |
| dataLayer, |
| infrastructureLayer ); |
| |
| contextLayer.uses( |
| dataLayer, |
| infrastructureLayer ); |
| |
| dataLayer.uses( |
| infrastructureLayer |
| ); |
| |
| // Assemble |
| assembleBootstrapLayer( bootstrapLayer ); |
| assembleCommunicationLayer( communicationLayer ); |
| assembleContextLayer( contextLayer ); |
| assembleDataLayer( dataLayer ); |
| assembleInfrastructureLayer( infrastructureLayer ); |
| |
| return assembly; |
| } |
| |
| private void assembleBootstrapLayer( LayerAssembly bootstrapLayer ) |
| throws AssemblyException |
| { |
| ModuleAssembly bootstrapModule = bootstrapLayer.module( "BOOTSTRAP-Bootstrap" ); |
| bootstrapModule |
| .objects( |
| DCISampleApplication_a.class ); |
| |
| // Load sample data on startup |
| bootstrapModule |
| .addServices( |
| BaseDataService.class ) |
| .instantiateOnStartup(); |
| bootstrapModule |
| .addServices( |
| SampleDataService.class ) |
| .instantiateOnStartup(); |
| } |
| |
| private void assembleCommunicationLayer( LayerAssembly communicationLayer ) |
| throws AssemblyException |
| { |
| ModuleAssembly queryModule = communicationLayer.module( "COMMUNICATION-Query" ); |
| queryModule |
| .transients( |
| BookingQueries.class ) |
| .visibleIn( application ); |
| |
| queryModule |
| .values( |
| CargoDTO.class, |
| LocationDTO.class, |
| HandlingEventDTO.class, |
| VoyageDTO.class ); |
| |
| queryModule |
| .addServices( |
| EntityToDTOService.class, |
| OrgJsonValueSerializationService.class ) |
| .visibleIn( application ); |
| } |
| |
| private void assembleContextLayer( LayerAssembly contextLayer ) |
| throws AssemblyException |
| { |
| // Role-playing entities |
| ModuleAssembly entityRoleModule = contextLayer.module( "CONTEXT-EntityRole" ); |
| entityRoleModule |
| .entities( |
| CargoRoleMap.class, |
| CargosRoleMap.class, |
| HandlingEventRoleMap.class, |
| HandlingEventsRoleMap.class ) |
| .visibleIn( application ); |
| |
| // Non-role-playing entities |
| ModuleAssembly entityNonRoleModule = contextLayer.module( "CONTEXT-EntityNonRole" ); |
| entityNonRoleModule |
| .entities( |
| LocationEntity.class, |
| VoyageEntity.class ) |
| .visibleIn( application ); |
| |
| // Role-playing values |
| ModuleAssembly valueRoleModule = contextLayer.module( "CONTEXT-ValueRole" ); |
| valueRoleModule |
| .values( |
| ItineraryRoleMap.class, |
| RouteSpecificationRoleMap.class ) |
| .visibleIn( application ); |
| |
| ModuleAssembly contextSupportModule = contextLayer.module( "CONTEXT-ContextSupport" ); |
| contextSupportModule |
| .addServices( |
| RoutingService.class, |
| ApplicationEvents.class ) |
| .visibleIn( application ); |
| |
| contextSupportModule |
| .values( |
| RegisterHandlingEventAttemptDTO.class ) |
| .visibleIn( application ); |
| } |
| |
| private void assembleDataLayer( LayerAssembly dataLayer ) |
| throws AssemblyException |
| { |
| // Non-role-playing values |
| ModuleAssembly dataModule = dataLayer.module( "DATA-Data" ); |
| dataModule |
| .values( |
| TrackingId.class, |
| Delivery.class, |
| ExpectedHandlingEvent.class, |
| UnLocode.class, |
| Leg.class, |
| CarrierMovement.class, |
| Schedule.class, |
| VoyageNumber.class ) |
| .visibleIn( application ); |
| } |
| |
| private void assembleInfrastructureLayer( LayerAssembly infrastructureLayer ) |
| throws AssemblyException |
| { |
| ModuleAssembly serializationModule = infrastructureLayer.module( "INFRASTRUCTURE-Serialization" ); |
| serializationModule |
| .services( OrgJsonValueSerializationService.class ) |
| .taggedWith( ValueSerialization.Formats.JSON ) |
| .setMetaInfo( new Function<Application, Module>() |
| { |
| @Override |
| public Module map( Application application ) |
| { |
| return application.findModule( "CONTEXT", "CONTEXT-ContextSupport" ); |
| } |
| } ) |
| .visibleIn( application ); |
| |
| ModuleAssembly indexingModule = infrastructureLayer.module( "INFRASTRUCTURE-Indexing" ); |
| indexingModule |
| .objects( |
| EntityStateSerializer.class, |
| EntityTypeSerializer.class ); |
| |
| indexingModule |
| .addServices( |
| MemoryRepositoryService.class, |
| RdfIndexingEngineService.class ) |
| .instantiateOnStartup() |
| .visibleIn( application ); |
| |
| ModuleAssembly entityStoreModule = infrastructureLayer.module( "INFRASTRUCTURE-EntityStore" ); |
| entityStoreModule |
| .addServices( |
| MemoryEntityStoreService.class, |
| UuidIdentityGeneratorService.class ) |
| .instantiateOnStartup() |
| .visibleIn( application ); |
| |
| ModuleAssembly externalServiceModule = infrastructureLayer.module( "INFRASTRUCTURE-ExternalService" ); |
| externalServiceModule |
| .importedServices( |
| GraphTraversalService.class ) |
| .setMetaInfo( new GraphTraversalServiceImpl( new GraphDAO() ) ) |
| .visibleIn( application ); |
| } |
| } |
