@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/server/ArticleUtil/index.d.ts

@@ -1,34 +1,27 @@
-/** Name of the property specifying the creator of an article. */
-export const PROPERTY_CREATED_BY: string;
-/** Name of the property specifying the creation date of an article. */
-export const PROPERTY_CREATION_DATE: string;
-/** Name of the property specifying the last modifier of an article. */
-export const PROPERTY_LAST_MODIFIED_BY: string;
-/** Name of the property specifying the last modified date of an article. */
-export const PROPERTY_LAST_MODIFIED_DATE: string;
-/** Name of the property specifying the last published date of an article. */
-export const PROPERTY_LAST_PUBLISH_DATE: string;
-/** Name of the property specifying the last publisher of an article. */
-export const PROPERTY_LAST_PUBLISHED_BY: string;
-/** Name of the property specifying the locale used by an article. */
-export const PROPERTY_LOCALE: string;
-/** Name of the property specifying the published date of an article. */
-export const PROPERTY_PUBLISH_DATE: string;
-/** Name of the property specifying the publisher of an article. */
-export const PROPERTY_PUBLISHED_BY: string;
-/** Name of the property specifying if an article is indexable. */
-export const PROPERTY_ROBOTS_INDEX: string;
-/** Name of the property specifying the short id of an article. */
-export const PROPERTY_SHORTID: string;
-/** Name of the property specifying if an article is visible in menus. */
-export const PROPERTY_VISIBLE_IN_MENUS: string;
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
- * Creates an article as sub node to a specified parent.
- * @returns {Node} a sv:article node corresponding to the newly created article. Will never return null
- * @param {Node} aParent - the parent node of the article. May not be null
- * @param {Node} aTemplate - the template used for the article. May not be null
- * @param {string} aName - the name of the sv:article. May not be null
+ * <p>Creates an article as sub node to a specified parent. The parent must be a node with primary
+ * node type sv:archive. If other parent is specified a <code>ConstraintViolationException</code> is thrown.</p>
+ *
+ * <p>Any name can be given a article, it should however not contain the character '/'.</p>
+ *
+ * <p>If no parent, no template or no name is specified a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to create pages, layouts and to do write operations on the parent node. A
+ * <code>ConstraintViolationException</code> will be thrown if not.</p>
+ *
+ * <p>Note that a new article inherits metadata and permissions from its parent.</p>
+ *
+ * <p>Use {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil#updateContent(javax.jcr.Node, java.util.Map)}
+ * to add content to the new article.</p>
+ * @param aParent the parent node of the article. May not be <code>null</code>
+ * @param aTemplate the template used for the article. May not be <code>null</code>
+ * @param aName the name of the sv:article. May not be <code>null</code>
+ * @return a sv:article node corresponding to the newly created article. Will never return <code>null</code>
+ * @throws javax.jcr.nodetype.ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create the article
+ * @throws RepositoryException if something else goes wrong
+ * @see #createArticle(javax.jcr.Node, javax.jcr.Node, String, java.util.Map, java.util.Map)
  */
 export function createArticle(
   aParent: Node,
@@ -37,58 +30,377 @@ export function createArticle(
 ): Node;
 
 /**
- * Creates an article with properties and web content.
- * @returns {Node} a sv:article node corresponding to the newly created article. Will never return null
- * @param {Node} aParent - the parent node of the article. May not be null
- * @param {Node} aTemplate - the sv:template node to be used for the article. May not be null
- * @param {string} aName - the name of the sv:article. May not be null
- * @param {Map<string, any>} properties - the article properties. May be null
- * @param {Map<string, string>} content - a map containing the HTML content. The keys must correspond to layout names on the node. May be null
+ * <p>Creates an article with properties and web content. The parent must be a node with primary node type sv:archive.
+ * If other parent is specified a <code>ConstraintViolationException</code> is thrown. It is possible to provide the web content for the article
+ * as well as article properties.</p>
+ *
+ * <p>Properties:</p>
+ * <ul>
+ * <li>
+ *    {@link #PROPERTY_VISIBLE_IN_MENUS}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_SHORTID} - If the short id is already used by an other Sitevision node an <code>IllegalArgumentException</code> is thrown
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LOCALE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_ROBOTS_INDEX}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATION_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISHED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISHED_BY}
+ * </li>
+ * </ul>
+ * <p>
+ *    If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown
+ * </p>
+ *
+ * <p>
+ *    Default values:
+ * </p>
+ * <ul>
+ * <li>{@link #PROPERTY_VISIBLE_IN_MENUS} - true</li>
+ * <li>{@link #PROPERTY_SHORTID} - "" (a short id will be generated by Sitevision)</li>
+ * <li>{@link #PROPERTY_LOCALE} - parent locale</li>
+ * <li>{@link #PROPERTY_ROBOTS_INDEX} - true</li>
+ * <li>{@link #PROPERTY_CREATION_DATE} - current time stamp</li>
+ * <li>{@link #PROPERTY_CREATED_BY} - current user</li>
+ * <li>{@link #PROPERTY_LAST_MODIFIED_DATE} - current time stamp</li>
+ * <li>{@link #PROPERTY_LAST_MODIFIED_BY} - current user</li>
+ * <li>{@link #PROPERTY_LAST_PUBLISH_DATE} - null (will not have a value)</li>
+ * <li>{@link #PROPERTY_LAST_PUBLISHED_BY} - null (will not have a value)</li>
+ * <li>{@link #PROPERTY_PUBLISH_DATE} - null (will not have a value)</li>
+ * <li>{@link #PROPERTY_PUBLISHED_BY} - null (will not have a value)</li>
+ * </ul>
+ *
+ * <p>The article content is specified using the
+ * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the articel and values containing the
+ * HTML used to generate a portlet structure in the layout. The provided content is converted to
+ * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
+ * layout should be created. For more information about the HTML to portlet mapping can be found in the
+ * {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil} javadoc.
+ *
+ * <p>If no parent, no template or no name is specified a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to create pages, layouts and to do write operations on the parent node or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ *
+ * <p>Note that a new page inherits metadata and permissions from its parent.</p>
+ * @param aParent the parent node of the article. May not be <code>null</code>
+ * @param aTemplate the sv:template node to be used for the article. May not be <code>null</code>
+ * @param aName the name of the sv:article. May not be <code>null</code>
+ * @param properties the article properties. May be <code>null</code>
+ * @param content a map containing the HTML content. The keys must correspond to layout names on the node. May be <code>null</code>
+ * @return a sv:article node corresponding to the newly created article. Will never return <code>null</code>
+ * @throws javax.jcr.nodetype.ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create the article
+ * @throws RepositoryException if something else goes wrong
+ * @see #createArticle(javax.jcr.Node, javax.jcr.Node, String)
  */
 export function createArticle(
   aParent: Node,
   aTemplate: Node,
   aName: string,
-  properties: Map<string, any>,
-  content: Map<string, string>
+  properties: Record<unknown, unknown>,
+  content: Record<unknown, unknown>
 ): Node;
 
 /**
- * Alters the name of an article.
- * @param {Node} anArticle - the article that should be renamed. May not be null
- * @param {string} aName - the new name of the article. May not be null
- */
-export function renameArticle(anArticle: Node, aName: string): void;
-
-/**
- * Updates the properties of an article.
- * @param {Node} anArticle - the sv:article that will be altered. May not be null
- * @param {Map<string, any>} properties - the article properties. May not be null
+ * <p>Updates the properties of an article. If no article is specified a <code>NullPointerException</code>
+ * is thrown. If the node is not a sv:article an <code>IllegalArgumentException</code> is thrown.</p>
+ *
+ * <p>
+ *    Properties:
+ * </p>
+ * <ul>
+ * <li>
+ *    {@link #PROPERTY_VISIBLE_IN_MENUS}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_SHORTID} - If the short id is already used by an other Sitevision node an <code>IllegalArgumentException</code> is thrown
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LOCALE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_ROBOTS_INDEX}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATION_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISHED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISHED_BY}
+ * </li>
+ * </ul>
+ * <p>
+ *    If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>The current user must be authorized to do write operations on the article or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ *
+ * <p>If no properties map is specified a <code>NullPointerException</code> is thrown.</p>
+ * @param anArticle the sv:article that will be altered. May not be <code>null</code>
+ * @param properties the article properties. May not be <code>null</code>
+ * @throws javax.jcr.nodetype.ConstraintViolationException if the current user is not authorized to alter the article
+ * @throws RepositoryException if something else goes wrong
  */
 export function updateArticle(
   anArticle: Node,
-  properties: Map<string, any>
+  properties: Record<unknown, unknown>
 ): void;
 
-declare namespace articleUtil {
-  export {
-    PROPERTY_CREATED_BY,
-    PROPERTY_CREATION_DATE,
-    PROPERTY_LAST_MODIFIED_BY,
-    PROPERTY_LAST_MODIFIED_DATE,
-    PROPERTY_LAST_PUBLISH_DATE,
-    PROPERTY_LAST_PUBLISHED_BY,
-    PROPERTY_LOCALE,
-    PROPERTY_PUBLISH_DATE,
-    PROPERTY_PUBLISHED_BY,
-    PROPERTY_ROBOTS_INDEX,
-    PROPERTY_SHORTID,
-    PROPERTY_VISIBLE_IN_MENUS,
-    createArticle,
-    createArticle,
-    renameArticle,
-    updateArticle,
-  };
+/**
+ * <p>Alters the name of an article. If no article is specified a <code>NullPointerException</code>
+ * is thrown. If the node is not an sv:article an <code>IllegalArgumentException</code> is thrown.</p>
+ *
+ * <p>Any name can be given an article, it should however not contain the character '/'. If null is
+ * provided a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to do write operations on the article or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ * @param anArticle the article that should be renamed. May not be <code>null</code>
+ * @param aName the new name of the article. May not be <code>null</code>
+ * @throws javax.jcr.nodetype.ConstraintViolationException if the current user is not authorized to alter the name of the article
+ * @throws RepositoryException if something else goes wrong
+ */
+export function renameArticle(anArticle: Node, aName: string): void;
+
+/**
+ * Article utility interface that handles nodes with primary node type <code>sv:article</code>.
+ *
+ * <p>
+ *    <em>Note!</em> This interface is used to <em>create</em> and <em>update</em> articles. You would typically use
+ *    {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> an article
+ *    and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> an article.
+ *    {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil} can be used to update the <em>content</em>
+ *    of an article.
+ * </p>
+ *
+ * <p>
+ *    <strong>Important note!</strong> Methods in this interface operates in the
+ *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
+ *    Hence, if you create an article, updates the name of a article or such, the article must be published
+ *    (see {@link senselogic.sitevision.api.versioning.PublishingUtil})
+ *    to have any effect in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getArticleUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p><p>Creates an article as sub node to a specified parent. The parent must be a node with primary
+ * node type sv:archive. If other parent is specified a <code>ConstraintViolationException</code> is thrown.</p>
+ *
+ * <p>Any name can be given a article, it should however not contain the character '/'.</p>
+ *
+ * <p>If no parent, no template or no name is specified a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to create pages, layouts and to do write operations on the parent node. A
+ * <code>ConstraintViolationException</code> will be thrown if not.</p>
+ *
+ * <p>Note that a new article inherits metadata and permissions from its parent.</p>
+ *
+ * <p>Use {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil#updateContent(javax.jcr.Node, java.util.Map)}
+ * to add content to the new article.</p><p>Creates an article with properties and web content. The parent must be a node with primary node type sv:archive.
+ * If other parent is specified a <code>ConstraintViolationException</code> is thrown. It is possible to provide the web content for the article
+ * as well as article properties.</p>
+ *
+ * <p>Properties:</p>
+ * <ul>
+ * <li>
+ *    {@link #PROPERTY_VISIBLE_IN_MENUS}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_SHORTID} - If the short id is already used by an other Sitevision node an <code>IllegalArgumentException</code> is thrown
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LOCALE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_ROBOTS_INDEX}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATION_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISHED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISHED_BY}
+ * </li>
+ * </ul>
+ * <p>
+ *    If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown
+ * </p>
+ *
+ * <p>
+ *    Default values:
+ * </p>
+ * <ul>
+ * <li>{@link #PROPERTY_VISIBLE_IN_MENUS} - true</li>
+ * <li>{@link #PROPERTY_SHORTID} - "" (a short id will be generated by Sitevision)</li>
+ * <li>{@link #PROPERTY_LOCALE} - parent locale</li>
+ * <li>{@link #PROPERTY_ROBOTS_INDEX} - true</li>
+ * <li>{@link #PROPERTY_CREATION_DATE} - current time stamp</li>
+ * <li>{@link #PROPERTY_CREATED_BY} - current user</li>
+ * <li>{@link #PROPERTY_LAST_MODIFIED_DATE} - current time stamp</li>
+ * <li>{@link #PROPERTY_LAST_MODIFIED_BY} - current user</li>
+ * <li>{@link #PROPERTY_LAST_PUBLISH_DATE} - null (will not have a value)</li>
+ * <li>{@link #PROPERTY_LAST_PUBLISHED_BY} - null (will not have a value)</li>
+ * <li>{@link #PROPERTY_PUBLISH_DATE} - null (will not have a value)</li>
+ * <li>{@link #PROPERTY_PUBLISHED_BY} - null (will not have a value)</li>
+ * </ul>
+ *
+ * <p>The article content is specified using the
+ * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the articel and values containing the
+ * HTML used to generate a portlet structure in the layout. The provided content is converted to
+ * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
+ * layout should be created. For more information about the HTML to portlet mapping can be found in the
+ * {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil} javadoc.
+ *
+ * <p>If no parent, no template or no name is specified a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to create pages, layouts and to do write operations on the parent node or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ *
+ * <p>Note that a new page inherits metadata and permissions from its parent.</p><p>Updates the properties of an article. If no article is specified a <code>NullPointerException</code>
+ * is thrown. If the node is not a sv:article an <code>IllegalArgumentException</code> is thrown.</p>
+ *
+ * <p>
+ *    Properties:
+ * </p>
+ * <ul>
+ * <li>
+ *    {@link #PROPERTY_VISIBLE_IN_MENUS}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_SHORTID} - If the short id is already used by an other Sitevision node an <code>IllegalArgumentException</code> is thrown
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LOCALE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_ROBOTS_INDEX}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATION_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_CREATED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_MODIFIED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_LAST_PUBLISHED_BY}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISH_DATE}
+ * </li>
+ * <li>
+ *    {@link #PROPERTY_PUBLISHED_BY}
+ * </li>
+ * </ul>
+ * <p>
+ *    If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>The current user must be authorized to do write operations on the article or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ *
+ * <p>If no properties map is specified a <code>NullPointerException</code> is thrown.</p><p>Alters the name of an article. If no article is specified a <code>NullPointerException</code>
+ * is thrown. If the node is not an sv:article an <code>IllegalArgumentException</code> is thrown.</p>
+ *
+ * <p>Any name can be given an article, it should however not contain the character '/'. If null is
+ * provided a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to do write operations on the article or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>Name of the property specifying if an article is visible in menus. It corresponds to the sv:article property <code>visibleInMenus</code>.
+ * <p>The property value must be of type <code>Boolean</code>.</p>Name of the property specifying the short id of an article. It corresponds to the sv:article property <code>shortId</code>.
+ * <p>The property value must be of type <code>String</code>.</p>Name of the property specifying the locale used by an article. It corresponds to the sv:article property <code>locale</code>.
+ * <p>
+ * The property value must be of type <code>Locale</code> or a <code>String</code> that can be resolved to a non-null Locale
+ * via {@link senselogic.sitevision.api.i18n.LocaleUtil#getLocaleByString(String)}.
+ * </p>Name of the property specifying if an article is indexable. It corresponds to the sv:article property <code>robotsIndex</code>.
+ * <p>The property value must be of type <code>Boolean</code>.</p>Name of the property specifying the creation date of an article. It corresponds to the sv:article property <code>creationDate</code>.
+ * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss where
+ * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the creator of an article. It corresponds to the sv:article property <code>createdBy</code>.
+ * <p>The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.</p>Name of the property specifying the last modified date of an article. It corresponds to the sv:article property <code>lastModifiedDate</code>.
+ * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss, where
+ * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the last modifier of an article. It corresponds to the sv:article property <code>lastModifiedBy</code>.
+ * <p>The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.</p>Name of the property specifying the last published date of an article. It corresponds to the sv:article property <code>lastPublishDate</code>.
+ * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss, where
+ * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the last publisher of an article. It corresponds to the sv:article property <code>lastPublishedBy</code>.
+ * <p>The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.</p>Name of the property specifying the published date of an article. It corresponds to the sv:article property <code>publishDate</code>.
+ * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss, where
+ * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the publisher of an article. It corresponds to the sv:article property <code>publishedBy</code>.
+ * <p>The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.</p>
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.2
+ */
+declare namespace ArticleUtil {
+  export { createArticle, updateArticle, renameArticle };
 }
 
-export default articleUtil;
+export default ArticleUtil;

package/server/AuthenticationUtil/index.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Logout current user based on a HttpServletRequest.
+ * @param aServletRequest the current servlet request
+ * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
+ */
+export function logout(
+  aServletRequest: unknown,
+  invalidateHttpSession: boolean
+): void;
+
+/**
+ * Logout current user based on a PortletRequest.
+ * @param aPortletRequest the current portlet request
+ * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
+ */
+export function logout(
+  aPortletRequest: unknown,
+  invalidateHttpSession: boolean
+): void;
+
+/**
+ * Authenticates a user based on a shared state map.
+ * @param aServletRequest the current servlet request
+ * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
+ * @throws LoginException if login fails
+ * @since Sitevision 2.6.2_06
+ */
+export function login(
+  aServletRequest: unknown,
+  sharedState: Record<unknown, unknown>
+): void;
+
+/**
+ * Authenticates a user based on username and password.
+ * @param aServletRequest the current servlet request
+ * @param name a username
+ * @param password a password
+ * @throws LoginException if login fails
+ * @since Sitevision 2.6.2_06
+ */
+export function login(
+  aServletRequest: unknown,
+  name: string,
+  password: string
+): void;
+
+/**
+ * Re-authenticates a user based on a Subject already in the session.
+ * @param aServletRequest the current servlet request
+ * @throws LoginException if login fails
+ * @since Sitevision 2.6.2_06
+ */
+export function reLogin(aServletRequest: unknown): void;
+
+/**
+ * Authenticates a user based on a shared state map.
+ * @param aPortletRequest the current portlet request
+ * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
+ * @throws LoginException if login fails
+ * @since Sitevision 2.6.2_06
+ */
+export function login(
+  aPortletRequest: unknown,
+  sharedState: Record<unknown, unknown>
+): void;
+
+/**
+ * Authenticates a user based on username and password.
+ * @param aPortletRequest the current portlet request
+ * @param name a username
+ * @param password a password
+ * @throws LoginException if login fails
+ * @since Sitevision 2.6.2_06
+ */
+export function login(
+  aPortletRequest: unknown,
+  name: string,
+  password: string
+): void;
+
+/**
+ * Re-authenticates a user based on a Subject already in the session.
+ * @param aPortletRequest the current portlet request
+ * @throws LoginException if login fails
+ * @since Sitevision 2.6.2_06
+ */
+export function reLogin(aPortletRequest: unknown): void;
+
+/**
+ * <p>
+ *    Authentication utility interface.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getAuthenticationUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Logout current user based on a HttpServletRequest.Logout current user based on a PortletRequest.Authenticates a user based on a shared state map.Authenticates a user based on username and password.Re-authenticates a user based on a Subject already in the session.Authenticates a user based on a shared state map.Authenticates a user based on username and password.Re-authenticates a user based on a Subject already in the session.
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.1_03, Sitevision 2.7_01
+ */
+declare namespace AuthenticationUtil {
+  export { logout, login, reLogin };
+}
+
+export default AuthenticationUtil;