@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/hidden/javax/jcr/PropertyIterator/index.d.ts

@@ -0,0 +1,17 @@
+import Property from "../Property";
+
+/**
+ * Allows easy iteration through a list of <code>Property</code>s with
+ * <code>nextProperty</code> as well as a <code>skip</code> method.Returns the next <code>Property</code> in the iteration.
+  
+    */
+interface PropertyIterator {
+  /**
+   * Returns the next <code>Property</code> in the iteration.
+   * @return the next <code>Property</code> in the iteration.
+   * @throws java.util.NoSuchElementException if iteration has no more <code>Property</code>s.
+   */
+  nextProperty(): Property;
+}
+
+export default PropertyIterator;

package/hidden/javax/jcr/RangeIterator/index.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Extends <code>Iterator</code> with the <code>skip</code>,
+ * <code>getSize</code> and <code>getPosition</code> methods. The base interface
+ * of all type-specific iterators in the <code>javax.jcr</code> and its sub
+ * packages.Skip a number of elements in the iterator.
+ *
+ * <p>
+ *    <strong>Sitevision note:</strong> Unsupported operation
+ * </p>Returns the total number of of items available through this iterator. For
+ * example, for some node <code>N</code>, <code>N.getNodes().getSize()</code>
+ * returns the number of child nodes of <code>N</code> visible through the
+ * current <code>Session</code>. In some implementations precise information
+ * about the number of elements may not be available. In such cases this
+ * method must return -1.
+ *
+ * <p>
+ *    <strong>Sitevision note:</strong> Returns -1 as of Sitevision 3.6. Denoted as 'Unsupported operation'
+ *    in prior releases (i.e. throws UnsupportedOperationException).
+ * </p>Returns the current position within the iterator. The number returned is
+ * the 0-based index of the next element in the iterator, i.e. the one that
+ * will be returned on the subsequent <code>next</code> call.
+ * <p>
+ * Note that this method does not check if there is a next element, i.e. an
+ * empty iterator will always return 0.
+ *
+ * <p>
+ *    <strong>Sitevision note:</strong> Unsupported operation
+ * </p>
+  
+    */
+interface RangeIterator {
+  /**
+   * Skip a number of elements in the iterator.
+   *
+   * <p>
+   *    <strong>Sitevision note:</strong> Unsupported operation
+   * </p>
+   * @param skipNum the non-negative number of elements to skip
+   * @throws java.util.NoSuchElementException if skipped past the last element in the iterator.
+   */
+  skip(skipNum: number): void;
+
+  /**
+   * Returns the total number of of items available through this iterator. For
+   * example, for some node <code>N</code>, <code>N.getNodes().getSize()</code>
+   * returns the number of child nodes of <code>N</code> visible through the
+   * current <code>Session</code>. In some implementations precise information
+   * about the number of elements may not be available. In such cases this
+   * method must return -1.
+   *
+   * <p>
+   *    <strong>Sitevision note:</strong> Returns -1 as of Sitevision 3.6. Denoted as 'Unsupported operation'
+   *    in prior releases (i.e. throws UnsupportedOperationException).
+   * </p>
+   * @return a long
+   */
+  getSize(): number;
+
+  /**
+   * Returns the current position within the iterator. The number returned is
+   * the 0-based index of the next element in the iterator, i.e. the one that
+   * will be returned on the subsequent <code>next</code> call.
+   * <p>
+   * Note that this method does not check if there is a next element, i.e. an
+   * empty iterator will always return 0.
+   *
+   * <p>
+   *    <strong>Sitevision note:</strong> Unsupported operation
+   * </p>
+   * @return a long
+   */
+  getPosition(): number;
+}
+
+export default RangeIterator;

package/hidden/javax/jcr/Repository/index.d.ts

@@ -0,0 +1,318 @@
+import Value from "../Value";
+import Credentials from "../Credentials";
+import Session from "../../../../server/Session";
+
+/**
+ * The entry point into the content repository. The <code>Repository</code>
+ * object is usually acquired through the {@link RepositoryFactory}.Returns a string array holding all descriptor keys available for this
+ * implementation, both the standard descriptors defined by the string
+ * constants in this interface and any implementation-specific descriptors.
+ * Used in conjunction with {@link #getDescriptorValue(String key)} and
+ * {@link #getDescriptorValues(String key)} to query information about this
+ * repository implementation.Returns <code>true</code> if <code>key</code> is a standard descriptor
+ * defined by the string constants in this interface and <code>false</code>
+ * if it is either a valid implementation-specific key or not a valid key.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns <code>true</code> if <code>key</code> is a valid single-value
+ * descriptor; otherwise returns <code>false</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>The value of a single-value descriptor is found by passing the key for
+ * that descriptor to this method. If <code>key</code> is the key of a
+ * multi-value descriptor or not a valid key this method returns
+ * <code>null</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>The value array of a multi-value descriptor is found by passing the key
+ * for that descriptor to this method. If <code>key</code> is the key of a
+ * single-value descriptor then this method returns that value as an array
+ * of size one. If <code>key</code> is not a valid key this method returns
+ * <code>null</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p><p> A convenience method. The call  <p> <code>String s =
+ * repository.getDescriptor(key);</code>  <p> is equivalent to
+ * <p>
+ * <code>Value v = repository.getDescriptorValue(key);<br>String s = (v ==
+ * null) ? null : v.getString();</code>Authenticates the user using the supplied <code>credentials</code>. If
+ * <code>workspaceName</code> is recognized as the name of an existing
+ * workspace in the repository and authorization to access that workspace is
+ * granted, then a new <code>Session</code> object is returned. The format
+ * of the string <code>workspaceName</code> depends upon the
+ * implementation.
+ * <p>
+ * If <code>credentials</code> is <code>null</code>, it is assumed that
+ * authentication is handled by a mechanism external to the repository
+ * itself (for example, through the JAAS framework) and that the repository
+ * implementation exists within a context (for example, an application
+ * server) that allows it to handle authorization of the request for access
+ * to the specified workspace.
+ * <p>
+ * If <code>workspaceName</code> is <code>null</code>, a default workspace
+ * is automatically selected by the repository implementation. This may, for
+ * example, be the "home workspace" of the user whose credentials were
+ * passed, though this is entirely up to the configuration and
+ * implementation of the repository. Alternatively, it may be a "null
+ * workspace" that serves only to provide the method {@link
+ * Workspace#getAccessibleWorkspaceNames}, allowing the client to select
+ * from among available "real" workspaces.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Equivalent to <code>login(credentials, null)</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Equivalent to <code>login(null, workspaceName)</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Equivalent to <code>login(null, null)</code>.The descriptor key for the version of the specification that this
+ * repository implements. For JCR 2.0 the value of this descriptor is the
+ * <code>String</code> "2.0".The descriptor key for the name of the specification that this repository
+ * implements. For JCR 2.0 the value of this descriptor is the
+ * <code>String</code> "Content Repository for Java Technology API".The descriptor key for the name of the repository vendor. The descriptor
+ * returned for this key is a <code>String</code>.The descriptor key for the URL of the repository vendor. The descriptor
+ * returned for this key is a <code>String</code>.The descriptor key for the name of this repository implementation. The
+ * descriptor returned for this key is a <code>String</code>.The descriptor key for the version of this repository implementation. The
+ * descriptor returned for this key is a <code>String</code>.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if repository content can be updated through the JCR API (as
+ * opposed to having read-only access).Key to a <code>String</code> descriptor. Returns one of the following
+ * <code>javax.jcr.Repository</code> constants indicating the stability of
+ * identifiers:
+ * <dl>
+ * <dt>IDENTIFIER_STABILITY_METHOD_DURATION</dt>
+ * <dd>Identifiers may change between method calls.</dd>
+ * <dt>IDENTIFIER_STABILITY_SAVE_DURATION</dt>
+ * <dd>Identifiers are guaranteed stable within a single save/refresh cycle.</dd>
+ * <dt>IDENTIFIER_STABILITY_SESSION_DURATION</dt>
+ * <dd>Identifiers are guaranteed stable within a single session.</dd>
+ * <dt>IDENTIFIER_STABILITY_INDEFINITE_DURATION</dt>
+ * <dd>Identifiers are guaranteed to be stable forever.</dd>
+ * </dl>One of four possible values for the descriptor <code>IDENTIFIER_STABILITY</code>.
+ * Indicates that identifiers may change between method calls.One of four possible values for the descriptor <code>IDENTIFIER_STABILITY</code>.
+ * Indicates that identifiers are guaranteed stable within a single
+ * save/refresh cycle.One of four possible values for the descriptor <code>IDENTIFIER_STABILITY</code>.
+ * Indicates that identifiers are guaranteed stable within a single
+ * session.One of four possible values for the descriptor <code>IDENTIFIER_STABILITY</code>.
+ * Indicates that identifiers are guaranteed to be stable forever.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if XML export is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if XML import is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if unfiled content is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if full versioning is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if activities are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if configurations and baselines are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if access control is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if locking is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if asynchronous observation is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if journaled observation is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if retention and hold are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if lifecycles are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if transactions are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if workspace management is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if the primary node type of an existing node can be updated.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if the mixin node types of an existing node can be added and
+ * removed.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if the creation of shareable nodes is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if node type management is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if node and property with same name is supported.Key to <code>String</code> descriptor. Returns one of the following
+ * <code>javax.jcr.Repository</code> constants indicating the level of
+ * support for node type inheritance: <dl> <dt>NODE_TYPE_MANAGEMENT_INHERITANCE_MINIMAL</dt>
+ * <dd> Registration of primary node types is limited to those which have
+ * only nt:base as supertype. Registration of mixin node types is limited to
+ * those without any supertypes. </dd> <dt>NODE_TYPE_MANAGEMENT_INHERITANCE_SINGLE</dt>
+ * <dd> Registration of primary node types is limited to those with exactly
+ * one supertype. Registration of mixin node types is limited to those with
+ * at most one supertype. </dd> <dt>NODE_TYPE_MANAGEMENT_INHERITANCE_MULTIPLE</dt>
+ * <dd> Primary node types can be registered with one or more supertypes.
+ * Mixin node types can be registered with zero or more supertypes. </dd>
+ * </dl>One of three possible values for the descriptor <code>NODE_TYPE_MANAGEMENT_INHERITANCE</code>.
+ * Indicates that registration of primary node types is limited to those
+ * which have only nt:base as supertype. Registration of mixin node types is
+ * limited to those without any supertypes.One of three possible values for the descriptor <code>NODE_TYPE_MANAGEMENT_INHERITANCE</code>.
+ * Indicates that registration of primary node types is limited to those
+ * with exactly one supertype. Registration of mixin node types is limited
+ * to those with at most one supertype.One of three possible values for the descriptor <code>NODE_TYPE_MANAGEMENT_INHERITANCE</code>.
+ * Indicates that primary node types can be registered with one or more
+ * supertypes. Mixin node types can be registered with zero or more
+ * supertypes.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if override of inherited property or child node definitions is
+ * supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if primary items are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if preservation of child node ordering is supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if residual property and child node definitions are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if autocreated properties and child nodes are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if same-name sibling child nodes are supported.Key to a <code>long[]</code> descriptor. Returns an array holding the
+ * <code>javax.jcr.PropertyType</code> constants for the property types
+ * (including <code>UNDEFINED</code>, if supported) that a registered node
+ * type can specify, or a zero-length array if registered node types cannot
+ * specify property definitions.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if multivalue properties are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if registration of a node types with more than one
+ * <code>BINARY</code> property is permitted.Key to a <code>boolean</code> descriptor. Returns true if and only
+ * value-constraints are supported.Key to a <code>boolean</code> descriptor. Returns true if and only the
+ * update of node types is supported for node types currently in use as the
+ * type of an existing node in the repository.Key to a <code>String[]</code> descriptor. Returns an array holding the
+ * constants representing the supported query languages, or a zero-length if
+ * query is not supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if stored queries are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if full-text search is supported.Key to <code>String</code> descriptor. Returns one of the following
+ * <code>javax.jcr.Repository</code> constants indicating the level of
+ * support for joins in queries: <dl> <dt>QUERY_JOINS_NONE</dt> <dd>Joins
+ * are not supported. Queries are limited to a single selector.</dd>
+ * <dt>QUERY_JOINS_INNER</dt> <dd> Inner joins are supported.</dd>
+ * <dt>QUERY_JOINS_INNER_OUTER</dt> <dd>Inner and outer joins are
+ * supported.</dd> </dl>One of three possible values for the descriptor <code>QUERY_JOINS
+ * </code>. Indicates that joins are not supported. Queries are limited to a
+ * single selector.One of three possible values for the descriptor <code>QUERY_JOINS
+ * </code>. Indicates that inner joins are supported.One of three possible values for the descriptor <code>QUERY_JOINS
+ * </code>. Indicates that inner and outer joins are supported.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if <ul> <li><code>OPTION_XML_EXPORT_SUPPORTED = true</code>
+ * and</li> <li><code>QUERY_LANGUAGES</code> is of non-zero length.</li>
+ * </ul> These semantics are identical to those in JCR 1.0. This constant is
+ * deprecated.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if <ul> <li><code>LEVEL_1_SUPPORTED = true</code>,</li>
+ * <li><code>WRITE_SUPPORTED = true</code> and</li> <li><code>OPTION_XML_IMPORT_SUPPORTED
+ * = true</code>.</li> </ul> These semantics are identical to those in JCR
+ * 1.0. This constant is deprecated.Key to a <code>boolean</code> descriptor. Returns <code>true</code> if
+ * and only if the (deprecated) JCR 1.0 XPath query language is supported.
+ * This constant is deprecated.Key to a <code>boolean</code> descriptor. Returns false unless the
+ * (deprecated) JCR 1.0 XPath query language is supported. If JCR 1.0 XPath
+ * is supported then this descriptor has the same semantics as in JCR 1.0.
+ * This constant is deprecated.Key to a <code>boolean</code> descriptor. Returns false unless the
+ * (deprecated) JCR 1.0 XPath query language is supported. If JCR 1.0 XPath
+ * is supported then this descriptor has the same semantics as in JCR 1.0.
+ * This constant is deprecated.
+  
+    */
+interface Repository {
+  /**
+   * Returns a string array holding all descriptor keys available for this
+   * implementation, both the standard descriptors defined by the string
+   * constants in this interface and any implementation-specific descriptors.
+   * Used in conjunction with {@link #getDescriptorValue(String key)} and
+   * {@link #getDescriptorValues(String key)} to query information about this
+   * repository implementation.
+   * @return a string array holding all descriptor keys.
+   */
+  getDescriptorKeys(): string;
+
+  /**
+   * Returns <code>true</code> if <code>key</code> is a standard descriptor
+   * defined by the string constants in this interface and <code>false</code>
+   * if it is either a valid implementation-specific key or not a valid key.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param key a descriptor key.
+   * @return whether <code>key</code> is a standard descriptor.
+   * @since JCR 2.0
+   */
+  isStandardDescriptor(key: string): boolean;
+
+  /**
+   * Returns <code>true</code> if <code>key</code> is a valid single-value
+   * descriptor; otherwise returns <code>false</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param key a descriptor key.
+   * @return whether the specified desdfriptor is multi-valued.
+   * @since JCR 2.0
+   */
+  isSingleValueDescriptor(key: string): boolean;
+
+  /**
+   * The value of a single-value descriptor is found by passing the key for
+   * that descriptor to this method. If <code>key</code> is the key of a
+   * multi-value descriptor or not a valid key this method returns
+   * <code>null</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param key a descriptor key.
+   * @return The value of the indicated descriptor
+   * @since JCR 2.0
+   */
+  getDescriptorValue(key: string): Value;
+
+  /**
+   * The value array of a multi-value descriptor is found by passing the key
+   * for that descriptor to this method. If <code>key</code> is the key of a
+   * single-value descriptor then this method returns that value as an array
+   * of size one. If <code>key</code> is not a valid key this method returns
+   * <code>null</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param key a descriptor key.
+   * @return the value array for the indicated descriptor
+   * @since JCR 2.0
+   */
+  getDescriptorValues(key: string): Value;
+
+  /**
+   * <p> A convenience method. The call  <p> <code>String s =
+   * repository.getDescriptor(key);</code>  <p> is equivalent to
+   * <p>
+   * <code>Value v = repository.getDescriptorValue(key);<br>String s = (v ==
+   * null) ? null : v.getString();</code>
+   * @param key a descriptor key.
+   * @return a descriptor value in string form.
+   */
+  getDescriptor(key: string): string;
+
+  /**
+   * Authenticates the user using the supplied <code>credentials</code>. If
+   * <code>workspaceName</code> is recognized as the name of an existing
+   * workspace in the repository and authorization to access that workspace is
+   * granted, then a new <code>Session</code> object is returned. The format
+   * of the string <code>workspaceName</code> depends upon the
+   * implementation.
+   * <p>
+   * If <code>credentials</code> is <code>null</code>, it is assumed that
+   * authentication is handled by a mechanism external to the repository
+   * itself (for example, through the JAAS framework) and that the repository
+   * implementation exists within a context (for example, an application
+   * server) that allows it to handle authorization of the request for access
+   * to the specified workspace.
+   * <p>
+   * If <code>workspaceName</code> is <code>null</code>, a default workspace
+   * is automatically selected by the repository implementation. This may, for
+   * example, be the "home workspace" of the user whose credentials were
+   * passed, though this is entirely up to the configuration and
+   * implementation of the repository. Alternatively, it may be a "null
+   * workspace" that serves only to provide the method {@link
+   * Workspace#getAccessibleWorkspaceNames}, allowing the client to select
+   * from among available "real" workspaces.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param credentials The credentials of the user
+   * @param workspaceName the name of a workspace.
+   * @return a valid session for the user to access the repository.
+   * @throws LoginException if authentication or authorization for the specified workspace fails.
+   * @throws NoSuchWorkspaceException if the specified <code>workspaceName</code> is not recognized.
+   * @throws RepositoryException if another error occurs.
+   */
+  login(credentials: Credentials, workspaceName: string): Session;
+
+  /**
+   * Equivalent to <code>login(credentials, null)</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param credentials The credentials of the user
+   * @return a valid session for the user to access the repository.
+   * @throws LoginException if authentication or authorization fails.
+   * @throws RepositoryException if another error occurs.
+   */
+  login(credentials: Credentials): Session;
+
+  /**
+   * Equivalent to <code>login(null, workspaceName)</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param workspaceName the name of a workspace.
+   * @return a valid session for the user to access the repository.
+   * @throws LoginException if authentication or authorization for the specified workspace fails.
+   * @throws NoSuchWorkspaceException if the specified <code>workspaceName</code> is not recognized.
+   * @throws RepositoryException if another error occurs.
+   */
+  login(workspaceName: string): Session;
+
+  /**
+   * Equivalent to <code>login(null, null)</code>.
+   * @return a valid session for the user to access the repository.
+   * @throws LoginException if authentication or authorization fails.
+   * @throws RepositoryException if another error occurs.
+   */
+  login(): Session;
+}
+
+export default Repository;

package/hidden/javax/jcr/RepositoryFactory/index.d.ts

@@ -0,0 +1,90 @@
+import Repository from "../Repository";
+
+/**
+ * <code>RepositoryFactory</code> is a factory for <code>Repository</code>
+ * objects.
+ * <p>
+ * An implementation of this interface must have a zero-argument public
+ * constructor. Repository factories may be installed in an instance of the Java
+ * platform as extensions, that is, jar files placed into any of the usual
+ * extension directories. Factories may also be made available by adding them to
+ * the applet or application class path or by some other platform-specific
+ * means.
+ * </p><p>
+ * A repository factory implementation should support the Java Standard Edition
+ * Service Provider mechanism, that is, an implementation should include the
+ * file <code>META-INF/services/javax.jcr.RepositoryFactory</code>. This file
+ * contains the fully qualified name of the class that implements
+ * <code>RepositoryFactory</code>.
+ * </p><p>
+ * <b>Examples how to obtain repository instances</b>
+ * </p><p>
+ * Explicitly specifying the repository factory implementation:
+ * </p>
+ * <pre><code>
+ *   Map parameters = new HashMap();
+ *   parameters.put("com.vendor.address", "vendor://localhost:9999/repo");
+ *   RepositoryFactory factory = (RepositoryFactory) Class.forName("com.vendor.RepositoryFactoryImpl");
+ *   Repository repo = factory.getRepository(parameters);
+ * </code></pre>
+ * <p>
+ * Using ServiceLoader from Java SE 6:
+ * </p>
+ * <pre><code>
+ *   Map parameters = new HashMap();
+ *   parameters.put("com.vendor.address", "vendor://localhost:9999/repo");
+ *   Repository repo = null;
+ *   for (RepositoryFactory factory : ServiceLoader.load(RepositoryFactory.class))
+ * {
+ *     repo = factory.getRepository(parameters);
+ *     if (repo != null) {
+ *       // factory accepted parameters
+ *       break;
+ *     }
+ *   }
+ * </code></pre>
+ * <p>
+ * <strong>Note:</strong> on Java SE prior to version 6, one may use the class
+ * <code>javax.imageio.spi.ServiceRegistry</code> to look up the available
+ * <code>RepositoryFactory</code> implementations.
+ * </p>
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Attempts to establish a connection to a repository using the given
+ * <code>parameters</code>. <p> Parameters are passed in a <code>Map</code>
+ * of <code>String</code> key/value pairs. The keys are not specified by JCR
+ * and are implementation specific. However, vendors should use keys that
+ * are namespace qualified in the Java package style to distinguish their
+ * key names. For example an address parameter might be
+ * <code>com.vendor.address</code>.  <p> The implementation must return
+ * <code>null</code> if it does not understand the given parameters. The
+ * implementation may also return <code>null</code> if a default repository
+ * instance is requested (indicated by <code>null</code>
+ * <code>parameters</code>) and this factory is not able to identify a
+ * default repository.  <p> An implementation of this method must be
+ * thread-safe.
+ * @since Sitevision 3.5
+ * @since JCR 2.0
+ */
+interface RepositoryFactory {
+  /**
+   * Attempts to establish a connection to a repository using the given
+   * <code>parameters</code>. <p> Parameters are passed in a <code>Map</code>
+   * of <code>String</code> key/value pairs. The keys are not specified by JCR
+   * and are implementation specific. However, vendors should use keys that
+   * are namespace qualified in the Java package style to distinguish their
+   * key names. For example an address parameter might be
+   * <code>com.vendor.address</code>.  <p> The implementation must return
+   * <code>null</code> if it does not understand the given parameters. The
+   * implementation may also return <code>null</code> if a default repository
+   * instance is requested (indicated by <code>null</code>
+   * <code>parameters</code>) and this factory is not able to identify a
+   * default repository.  <p> An implementation of this method must be
+   * thread-safe.
+   * @param parameters map of string key/value pairs as repository arguments or <code>null</code> if none are provided and a client wishes to connect to a default repository.
+   * @return a repository instance or <code>null</code> if this implementation does not understand the passed <code>parameters</code>.
+   * @throws RepositoryException if if no suitable repository is found or another error occurs.
+   */
+  getRepository(parameters: Record<unknown, unknown>): Repository;
+}
+
+export default RepositoryFactory;