org.apache.jackrabbit.oak.spi.mount

Interface MountInfoProvider

@ProviderType
public interface MountInfoProvider

Holds information related to the Mounts configured in a ContentRepository.

The configuration may either be trivial - only a default mount is configured, or defining at least one non-default mount.

Method Summary

Modifier and Type	Method and Description
@NotNull Mount	getDefaultMount() Returns the default mount
@Nullable Mount	getMountByName(String name) Returns the mount instance for given mount name
@NotNull Mount	getMountByPath(String path) Maps a given path to logical store name.
@NotNull Collection<Mount>	getMountsPlacedDirectlyUnder(String path) Returns all mounts placed directly under the specified path
@NotNull Collection<Mount>	getMountsPlacedUnder(String path) Returns all mounts placed under the specified path
@NotNull Collection<Mount>	getNonDefaultMounts() Set of non default mount points configured for the setup
boolean	hasNonDefaultMounts() Return true if there are explicit mounts configured

Method Detail

getMountByPath

@NotNull
@NotNull Mount getMountByPath(String path)

Maps a given path to logical store name.

Parameters:

path - node path for which backing store location is to be determined

Returns:

mountInfo for the given path. If no explicit mount configured then default mount would be returned

getNonDefaultMounts

@NotNull
@NotNull Collection<Mount> getNonDefaultMounts()

Set of non default mount points configured for the setup

Returns:

a collection of mounts, possibly empty

getMountByName

@Nullable
@Nullable Mount getMountByName(String name)

Returns the mount instance for given mount name

Parameters:

name - name of the mount

Returns:

mount instance for given mount name. If no mount exists for given name null would be returned

hasNonDefaultMounts

boolean hasNonDefaultMounts()

Return true if there are explicit mounts configured

Returns:

true if at least one non-default mount is configured, false otherwise

getMountsPlacedUnder

@NotNull
@NotNull Collection<Mount> getMountsPlacedUnder(String path)

Returns all mounts placed under the specified path

Parameters:

path - the path under which mounts are to be found

Returns:

a collection of mounts, possibly empty

See Also:

Mount.isUnder(String)

getMountsPlacedDirectlyUnder

@NotNull
@NotNull Collection<Mount> getMountsPlacedDirectlyUnder(String path)

Returns all mounts placed directly under the specified path

Parameters:

path - the path under which mounts are to be foud

Returns:

a collection of mounts, possibly empty

See Also:

Mount.isDirectlyUnder(String)

getDefaultMount

@NotNull
@NotNull Mount getDefaultMount()

Returns the default mount

Returns:

the default mount