Class ArtifactTypeMapper

Method Details

• onResourceTypeChange

  public static void onResourceTypeChange(Consumer<ResourceTypeChange> action)

  Registers an action to get executed when a resource type mapping changes.

  Changes that occurred before the registration are not notified, registrations should be done at application startup. All actions will be executed on a dedicated thread and no exceptions must be thrown but handled internally.

  Actions are all automatically unregistered when the application is disposed.

  Parameters:

  action - the action to execute.

  Since:

  3.9.0

• offResourceTypeChange

  public static void offResourceTypeChange(Consumer<ResourceTypeChange> action)

  Removes an action from being notified when a resource type mapping changes.

  Actions are all automatically unregistered when the application is disposed.

  Parameters:

  action - the action to execute.

  Since:

  3.9.0

• getArtifactTypeMapping

  public static ArtifactTypeMapping getArtifactTypeMapping(String containerId, String artifactType) throws ArtifactTypeMappingStoreException, LinkingTypesStoreException

  Resolves the artifact type mapping for a given container and artifact type.

  This method must be used, instead of using directly the store, to get the saved custom mapping, if any, merged with the application default's.

  Parameters:

  containerId - the container id.

  artifactType - the artifact type id.

  Returns:

  the corresponding mapping.

  Throws:

  ArtifactTypeMappingStoreException - if mapping cannot be resolved.

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  3.13.0

• getContainersMappings

  public static Map<String,Collection<ArtifactTypeMapping>> getContainersMappings(Set<String> containerIds) throws ArtifactTypeMappingStoreException, LinkingTypesStoreException

  Resolves the artifact type mappings for a possibly set of containers.

  This method must be used, instead of using directly the store, to get any saved custom mapping merged with the application default's.

  Parameters:

  containerIds - the container id set (defaults to all containers if empty).

  Returns:

  the artifact type mappings per requested container.

  Throws:

  ArtifactTypeMappingStoreException - if custom mappings cannot be resolved.

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  4.2.0

• getContainerMappings

  public static Collection<ArtifactTypeMapping> getContainerMappings(String containerId) throws ArtifactTypeMappingStoreException, LinkingTypesStoreException

  Returns the merged (default + custom) artifact type mappings for a single container.

  An empty collection is returned when the container id is not found or has no artifact types defined. These two cases are indistinguishable from this method's return value alone.

  Parameters:

  containerId - the container id to retrieve mappings for.

  Returns:

  the artifact type mappings for the given container, or an empty collection if none are found.

  Throws:

  ArtifactTypeMappingStoreException - if custom mappings cannot be resolved.

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  4.2.0

• removeCustomArtifactTypeMapping

  public static void removeCustomArtifactTypeMapping(String containerId, String artifactTypeId) throws ArtifactTypeMappingStoreException

  Deletes customization for an artifact type mapping and notify if there is a resource type change.

  Parameters:

  containerId - the container id.

  artifactTypeId - the artifactTypeId

  Throws:

  ArtifactTypeMappingStoreException - if the custom mapping cannot be resolved.

  Since:

  3.12.0

• removeCustomArtifactTypeMappings

  public static void removeCustomArtifactTypeMappings(String containerId) throws ArtifactTypeMappingStoreException

  * Deletes customization for all artifact type mappings in a container and notify if there are resource type changes.

  Parameters:

  containerId - the container id.

  Throws:

  ArtifactTypeMappingStoreException - if custom mappings cannot be resolved.

  Since:

  3.12.0

• setArtifactTypeMapping

  public static void setArtifactTypeMapping(String containerId, ArtifactTypeMapping mapping) throws ArtifactTypeMappingStoreException

  Sets or updates a custom artifact type mapping.

  This method must be used, instead of using directly the store, to avoid storing custom mappings when they are equal to the default's. This method also removes a previously saved custom mapping, if the mapping to store is equal to the default's.

  Parameters:

  containerId - the container id.

  mapping - the custom mapping.

  Throws:

  ArtifactTypeMappingStoreException - if the storage fails.

  Since:

  3.12.0

• previewImportingArtifactTypeMappings

  public static ArtifactTypeMappings previewImportingArtifactTypeMappings(String sourceContainerId, String targetContainerId, String targetContainerTitle) throws ArtifactTypeMappingStoreException, LinkingTypesStoreException

  Takes a source containerId, a target containerId and gets the corresponding artifact type mappings, then compares each artifact type mapping to create a new result of the source imported in the target. Identical or missing artifact type mappings are ignored. This method returns the artifact type mappings result, with feedbacks detailing the import, but nothing is stored.

  Parameters:

  sourceContainerId - the source containerId

  targetContainerId - target containerId

  targetContainerTitle - target container title, to display in feedbacks.

  Returns:

  the resulting artifact type mappings from the (previewed) import.

  Throws:

  ArtifactTypeMappingStoreException - if custom mappings cannot be resolved

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  3.13.0

• getSupportedResourceTypes

  public static Set<Link> getSupportedResourceTypes() throws LinkingTypesStoreException

  Gets the application-supported set of resource types. This method excludes ResourceType.DELIVERABLE from the result set, if present, as it is not a legitimate mapping resource type for an artifact type.

  Returns:

  the application-supported resource types.

  Throws:

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  3.13.0

• getMappedResourceTypes

  public static Set<Link> getMappedResourceTypes(String containerId) throws ArtifactTypeMappingStoreException, LinkingTypesStoreException

  Gets the mapped resource types of a given container.

  Parameters:

  containerId - the given container id.

  Returns:

  the mapped resource types of a given container.

  Throws:

  ArtifactTypeMappingStoreException - if the storage fails.

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  3.13.0

• getResourceTypeMappings

  public static Map<String,ResourceTypeMapping> getResourceTypeMappings(URI resourceType, Set<String> containerIds) throws ArtifactTypeMappingStoreException, LinkingTypesStoreException

  Convenient method to resolve the ArtifactType instances mapped (and non-mapped) to a ResourceType on a given container.

  Containers where no artifact type is mapped to the requested resource type are excluded from the result; non-mapped data is only meaningful when there is at least one mapped artifact type.

  Parameters:

  resourceType - the resource type.

  containerIds - the container ids to resolve (defaults to all containers if empty).

  Returns:

  the resource type mappings per container id, excluding containers with no mapped artifact types.

  Throws:

  ArtifactTypeMappingStoreException - if an error prevents the mappings or containers from being retrieved.

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  4.2.0

• getResourceTypeMapping

  public static Optional<ResourceTypeMapping> getResourceTypeMapping(URI resourceType, String containerId) throws ArtifactTypeMappingStoreException, LinkingTypesStoreException

  Resolves the resource type mapping for a single container.

  An empty optional is returned when no artifact type is mapped to the requested resource type in the given container.

  Parameters:

  resourceType - the resource type.

  containerId - the container id to resolve.

  Returns:

  the resource type mapping for the given container, or an empty optional if no artifact types are mapped to the resource type.

  Throws:

  ArtifactTypeMappingStoreException - if an error prevents the mappings or containers from being retrieved.

  LinkingTypesStoreException - if an error prevents resource types from being retrieved.

  Since:

  4.2.0