org.apache.jackrabbit.oak.namepath

Interface NameMapper

All Known Subinterfaces:

NamePathMapper

All Known Implementing Classes:

GlobalNameMapper, LocalNameMapper, NamePathMapper.Default, NamePathMapperImpl

@ProviderType
public interface NameMapper

TODO document

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getJcrName(@NotNull java.lang.String oakName) Returns the JCR name for the given Oak name.
@NotNull java.lang.String	getOakName(@NotNull java.lang.String jcrName) Returns the Oak name for the specified JCR name.
@Nullable java.lang.String	getOakNameOrNull(@NotNull java.lang.String jcrName) Returns the Oak name for the given JCR name, or null if no such mapping exists because the given JCR name contains an unknown namespace URI or prefix, or is otherwise invalid.
@NotNull java.util.Map<java.lang.String,java.lang.String>	getSessionLocalMappings() Returns the local namespace prefix mappings, or an empty map if there aren't any local mappings.

Method Detail

getOakNameOrNull

@Nullable
@Nullable java.lang.String getOakNameOrNull(@NotNull
                                                      @NotNull java.lang.String jcrName)

Returns the Oak name for the given JCR name, or null if no such mapping exists because the given JCR name contains an unknown namespace URI or prefix, or is otherwise invalid.

Parameters:

jcrName - JCR name

Returns:

Oak name, or null

getOakName

@NotNull
@NotNull java.lang.String getOakName(@NotNull
                                              @NotNull java.lang.String jcrName)
                                       throws RepositoryException

Returns the Oak name for the specified JCR name. In contrast to getOakNameOrNull(String) this method will throw a RepositoryException if the JCR name is invalid and cannot be resolved.

Parameters:

jcrName - The JCR name to be converted.

Returns:

A valid Oak name.

Throws:

RepositoryException - If the JCR name cannot be resolved.

getSessionLocalMappings

@NotNull
@NotNull java.util.Map<java.lang.String,java.lang.String> getSessionLocalMappings()

Returns the local namespace prefix mappings, or an empty map if there aren't any local mappings.

Returns:

local namespace prefix to URI mappings

getJcrName

@NotNull
@NotNull java.lang.String getJcrName(@NotNull
                                              @NotNull java.lang.String oakName)

Returns the JCR name for the given Oak name. The given name is expected to have come from a valid Oak repository that contains only valid names with proper namespace mappings. If that's not the case, either a programming error or a repository corruption has occurred and an appropriate unchecked exception gets thrown.

Parameters:

oakName - Oak name

Returns:

JCR name