javax.jcr.NamespaceRegistry Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* Copyright 2009 Day Management AG, Switzerland. All rights reserved.
*/
package javax.jcr;
/**
* Each repository has a single, persistent namespace registry represented by
* the NamespaceRegistry object, accessed via {@link
* Workspace#getNamespaceRegistry}. The namespace registry contains the default
* prefixes of the registered namespaces. The namespace registry may contain
* namespaces that are not used in repository content, and there may be
* repository content with namespaces that are not included in the registry.
*
* @see Workspace#getNamespaceRegistry
*/
public interface NamespaceRegistry {
/**
* A constant for the predefined namespace prefix "jcr".
*/
public static final String PREFIX_JCR = "jcr";
/**
* A constant for the predefined namespace prefix "nt".
*/
public static final String PREFIX_NT = "nt";
/**
* A constant for the predefined namespace prefix "mix".
*/
public static final String PREFIX_MIX = "mix";
/**
* A constant for the predefined namespace prefix "xml".
*/
public static final String PREFIX_XML = "xml";
/**
* A constant for the predefined namespace prefix "" (the empty prefix).
*/
public static final String PREFIX_EMPTY = "";
/**
* A constant for the predefined namespace mapped by default to the prefix
* "jcr".
*/
public static final String NAMESPACE_JCR = "http://www.jcp.org/jcr/1.0";
/**
* A constant for the predefined namespace mapped by default to the prefix
* "nt".
*/
public static final String NAMESPACE_NT = "http://www.jcp.org/jcr/nt/1.0";
/**
* A constant for the predefined namespace mapped by default to the prefix
* "mix".
*/
public static final String NAMESPACE_MIX = "http://www.jcp.org/jcr/mix/1.0";
/**
* A constant for the predefined namespace mapped by default to the prefix
* "xml".
*/
public static final String NAMESPACE_XML = "http://www.w3.org/XML/1998/namespace";
/**
* A constant for the predefined namespace mapped by default to the prefix
* "" (the empty prefix).
*/
public static final String NAMESPACE_EMPTY = "";
/**
* Sets a one-to-one mapping between prefix and
* uri in the global namespace registry of this repository.
*
* Assigning a new prefix to a URI that already exists in the namespace
* registry erases the old prefix. In general this can almost always be
* done, though an implementation is free to prevent particular remappings
* by throwing a NamespaceException.
*
* On the other hand, taking a prefix that is already assigned to a URI and
* re-assigning it to a new URI in effect unregisters that URI. Therefore,
* the same restrictions apply to this operation as to
* NamespaceRegistry.unregisterNamespace.
*
* @param prefix The prefix to be mapped.
* @param uri The URI to be mapped.
* @throws NamespaceException If an attempt is made to re-assign a built-in
* prefix to a new URI or, to register a namespace with a prefix that begins
* with the characters "xml" (in any combination of case) or,
* An attempt is made to perform a prefix re-assignment that is forbidden
* for implementation-specific reasons.
* @throws UnsupportedRepositoryOperationException
* if this repository does
* not support namespace registry changes.
* @throws AccessDeniedException if the current session does not have
* sufficent access to register the namespace.
* @throws RepositoryException if another error occurs.
*/
public void registerNamespace(String prefix, String uri) throws NamespaceException, UnsupportedRepositoryOperationException, AccessDeniedException, RepositoryException;
/**
* Removes a namespace mapping from the registry.
*
* @param prefix The prefix of the mapping to be removed.
* @throws NamespaceException if an attempt is made to unregister a built-in
* namespace or a namespace that is not currently registered or a namespace
* whose unregsitration is forbidden for implementation-specific reasons.
* @throws UnsupportedRepositoryOperationException
* if this repository does
* not support namespace registry changes.
* @throws AccessDeniedException if the current session does not have
* sufficent access to unregister the namespace.
* @throws RepositoryException if another error occurs.
*/
public void unregisterNamespace(String prefix) throws NamespaceException, UnsupportedRepositoryOperationException, AccessDeniedException, RepositoryException;
/**
* Returns an array holding all currently registered prefixes.
*
* @return a string array.
* @throws RepositoryException if an error occurs.
*/
public String[] getPrefixes() throws RepositoryException;
/**
* Returns an array holding all currently registered URIs.
*
* @return a string array.
* @throws RepositoryException if an error occurs.
*/
public String[] getURIs() throws RepositoryException;
/**
* Returns the URI to which the given prefix is mapped.
*
* @param prefix a string.
* @return a string.
* @throws NamespaceException if a mapping with the specified
* prefix does not exist.
* @throws RepositoryException if another error occurs.
*/
public String getURI(String prefix) throws NamespaceException, RepositoryException;
/**
* Returns the prefix which is mapped to the given uri.
*
* @param uri a string.
* @return a string.
* @throws NamespaceException if a mapping with the specified
* uri does not exist.
* @throws RepositoryException if another error occurs.
*/
public String getPrefix(String uri) throws NamespaceException, RepositoryException;
}