@sitevision/api 2023.2.1 → 2023.2.2-beta.1

package/types/senselogic/sitevision/api/security/UserUtil/index.d.ts

@@ -17,7 +17,7 @@ export type UserUtil = {
   /**
    * Checks if a user node is anonymous (not authenticated).
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is anonymous (i.e. not authenticated), <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is anonymous (i.e. not authenticated), <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isAnonymous(javax.jcr.Node)} instead
    */
   isAnonymous(aUserNode: Node): boolean;
@@ -32,7 +32,7 @@ export type UserUtil = {
   /**
    * Checks if a user node is the Sitevision System user.
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision System user, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision System user, <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isSystem(javax.jcr.Node)} instead
    */
   isSystem(aUserNode: Node): boolean;
@@ -47,7 +47,7 @@ export type UserUtil = {
   /**
    * Checks if a user node is the Sitevision Indexer.
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Indexer, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Indexer, <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isIndexer(javax.jcr.Node)} instead
    */
   isIndexer(aUserNode: Node): boolean;
@@ -62,7 +62,7 @@ export type UserUtil = {
   /**
    * Checks if a user node is the Sitevision Extractor.
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Extractor, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Extractor, <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil#isExtractor(javax.jcr.Node)} instead
    */
   isExtractor(aUserNode: Node): boolean;
@@ -70,7 +70,7 @@ export type UserUtil = {
   /**
    * Gets the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
    * @param aUserNode a user node
-   * @return the corresponding sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or has no corresponding user identity for current site.
+   * @return the corresponding sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code>&#xA; if <code>aUserNode</code> is <code>null</code> or has no corresponding user identity for current site.
    * @since Sitevision 3.5.1
    * @deprecated use {@link senselogic.sitevision.api.user.UserIdentityUtil#getUserIdentity(javax.jcr.Node)} instead
    */

package/types/senselogic/sitevision/api/security/jaas/callback/NodePrincipalCallback/index.d.ts

@@ -0,0 +1,109 @@
+import type { String } from "../../../../../../../java/lang/String";
+import type { Node } from "../../../../../../../javax/jcr/Node";
+
+import type { Principal } from "../../../../../../../java/security/Principal";
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     JAAS callback for mapping ids to JCR user nodes.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.callback.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Karl Eklöf
+ */
+export type NodePrincipalCallback = Object & {
+  /**
+   * Gets the username of the principal to be found.
+   * @return a username
+   */
+  getId(): string;
+
+  /**
+   * Gets the node principal that corresponds to the given username.
+   * @return the first user principal in the directory with the given username, or <code>null</code> if no such user is found.
+   */
+  getNodePrincipal(): Node;
+
+  /**
+   * Sets the node principal.
+   * @param aPrincipal a node principal
+   */
+  setNodePrincipal(aPrincipal: Node): void;
+
+  /**
+   * Gets the principal that corresponds to the given username.
+   * @return the first user principal in the directory with the given username, or <code>null</code> if no such user is found.
+   */
+  getPrincipal(): Principal;
+
+  /**
+   * Sets the principal.
+   * @param aPrincipal the principal
+   */
+  setPrincipal(aPrincipal: Principal): void;
+
+  /**
+ * The key/property name to use (by login modules) to set the name property on the node principal.
+  
+    */
+  NAME: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the given name property on the node principal.
+  
+    */
+  GIVENNAME: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the surname property on the node principal.
+  
+    */
+  SN: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the mail property on the node principal.
+  
+    */
+  MAIL: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the (multivalued) groups property on the node principal.
+  
+    */
+  GROUPS: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the phone property on the node principal.
+  
+    */
+  TELEPHONE_NUMBER: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the personal number property on the node principal.
+  
+    */
+  PERSONAL_NUMBER: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the mobile phone property on the node principal.
+  
+    */
+  MOBIL: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the title property on the node principal.
+  
+    */
+  TITLE: string;
+
+  /**
+ * The key/property name to use (by login modules) to set the description property on the node principal.
+  
+    */
+  DESCRIPTION: string;
+};

package/types/senselogic/sitevision/api/security/jaas/callback/NodePrincipalCallback/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getId: function getId() {},
+  getNodePrincipal: function getNodePrincipal() {},
+  setNodePrincipal: function setNodePrincipal() {},
+  getPrincipal: function getPrincipal() {},
+  setPrincipal: function setPrincipal() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/callback/RedirectCallback/index.d.ts

@@ -0,0 +1,22 @@
+import type { String } from "../../../../../../../java/lang/String";
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     JAAS callback for requesting a redirect.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.callback.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type RedirectCallback = Object & {
+  /**
+   * Gets the URL of this callback.
+   * @return the URL of this callback
+   */
+  getUrl(): string;
+};

package/types/senselogic/sitevision/api/security/jaas/callback/RedirectCallback/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getUrl: function getUrl() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/callback/ServletCallback/index.d.ts

@@ -0,0 +1,39 @@
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     JAAS callback for accessing request and response.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.callback.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type ServletCallback = Object & {
+  /**
+   * Gets the request of this callback.
+   * @return the request of this callback
+   */
+  getRequest(): unknown;
+
+  /**
+   * Sets the request of this callback.
+   * @param aRequest the request
+   */
+  setRequest(aRequest: unknown): void;
+
+  /**
+   * Gets the response of this callback.
+   * @return the response of this callback
+   */
+  getResponse(): unknown;
+
+  /**
+   * Sets the response of this callback.
+   * @param aResponse the response
+   */
+  setResponse(aResponse: unknown): void;
+};

package/types/senselogic/sitevision/api/security/jaas/callback/ServletCallback/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getRequest: function getRequest() {},
+  setRequest: function setRequest() {},
+  getResponse: function getResponse() {},
+  setResponse: function setResponse() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/callback/SharedStateCallback/index.d.ts

@@ -0,0 +1,35 @@
+import type { String } from "../../../../../../../java/lang/String";
+
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     JAAS callback for fetching request headers.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.callback.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type SharedStateCallback = Object & {
+  /**
+   * Gets the value that is mapped to the name of this callback.
+   * @return the value that is mapped to the name of this callback.
+   */
+  getValue(): string;
+
+  /**
+   * Sets the value for the name of this callback.
+   * @param aValue the value to set
+   */
+  setValue(aValue: String | string): void;
+
+  /**
+   * Gets the name of this callback.
+   * @return the the name of this callback
+   */
+  getName(): string;
+};

package/types/senselogic/sitevision/api/security/jaas/callback/SharedStateCallback/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getValue: function getValue() {},
+  setValue: function setValue() {},
+  getName: function getName() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/callback/UserAttributeCallback/index.d.ts

@@ -0,0 +1,48 @@
+import type { String } from "../../../../../../../java/lang/String";
+import type { List } from "../../../../../../../java/util/List";
+
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     JAAS callback for fetching user attributes from the directory.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.callback.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type UserAttributeCallback = Object & {
+  /**
+   * Gets the DN.
+   * @return the DN
+   */
+  getDn(): string;
+
+  /**
+   * Gets the attribute name.
+   * @return the attribute name
+   */
+  getName(): string;
+
+  /**
+   * Sets a list of user attribute values.
+   * @param aValue a list of user attribute values.
+   */
+  setValue(aValue: List | unknown[]): void;
+
+  /**
+   * First value of requested attribute as a String.
+   * @return attribute as String or <code>null</code> if none was found
+   */
+  getString(): string;
+
+  /**
+   * Gets the the user attribute values list.
+   * @return list of values.
+   */
+  getValues(): List;
+};

package/types/senselogic/sitevision/api/security/jaas/callback/UserAttributeCallback/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getDn: function getDn() {},
+  getName: function getName() {},
+  setValue: function setValue() {},
+  getString: function getString() {},
+  getValues: function getValues() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/callback/UserPrincipalCallback/index.d.ts

@@ -0,0 +1,36 @@
+import type { String } from "../../../../../../../java/lang/String";
+import type { Principal } from "../../../../../../../java/security/Principal";
+
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     JAAS callback for mapping usernames to Principals. The Principal will be a User object in the Sitevision model.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.callback.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type UserPrincipalCallback = Object & {
+  /**
+   * Gets the username of the principal to be found.
+   * @return username
+   */
+  getName(): string;
+
+  /**
+   * Get principal that corresponds to the given username.
+   * @return the first user principal in the directory with the given name, and <code>null</code> if no such user is found.
+   */
+  getPrincipal(): Principal;
+
+  /**
+   * Sets the principal that corresponds to the given username.
+   * @param aPrincipal a user principal
+   */
+  setPrincipal(aPrincipal: Principal): void;
+};

package/types/senselogic/sitevision/api/security/jaas/callback/UserPrincipalCallback/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getName: function getName() {},
+  getPrincipal: function getPrincipal() {},
+  setPrincipal: function setPrincipal() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/credential/AuthTypeCredential/index.d.ts

@@ -0,0 +1,35 @@
+import type { String } from "../../../../../../../java/lang/String";
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     Credential for authentication types (BASIC, FORM, NTLM etc).
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.credential.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type AuthTypeCredential = Object & {
+  /**
+   * Gets the auth type.
+   * @return the auth type
+   */
+  getAuthType(): string;
+
+  /**
+   * Indicates whether some other object is "equal to" this credential.
+   * @param obj the reference object with which to compare.
+   * @return <code>true</code> if this object is the same as the obj argument, <code>false</code> otherwise.
+   */
+  equals(obj: unknown): boolean;
+
+  /**
+   * Gets the hash code for this credential.
+   * @return the hash code for this credential.
+   */
+  hashCode(): number;
+};

package/types/senselogic/sitevision/api/security/jaas/credential/AuthTypeCredential/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getAuthType: function getAuthType() {},
+  equals: function equals() {},
+  hashCode: function hashCode() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/credential/InetAddressCredential/index.d.ts

@@ -0,0 +1,35 @@
+import type { InetAddress } from "../../../../../../../java/net/InetAddress";
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     Internet address credential. These are created by JAAS LoginModule implementations and placed in the Subject.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.credential.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type InetAddressCredential = Object & {
+  /**
+   * Gets the inet address of this credential.
+   * @return the inet address of this credential.
+   */
+  getAddress(): InetAddress;
+
+  /**
+   * Indicates whether some other object is "equal to" this credential.
+   * @param obj the reference object with which to compare.
+   * @return <code>true</code> if this object is the same as the obj argument, <code>false</code> otherwise.
+   */
+  equals(obj: unknown): boolean;
+
+  /**
+   * Gets the hash code for this credential.
+   * @return the hash code for this credential.
+   */
+  hashCode(): number;
+};

package/types/senselogic/sitevision/api/security/jaas/credential/InetAddressCredential/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getAddress: function getAddress() {},
+  equals: function equals() {},
+  hashCode: function hashCode() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/credential/PasswordCredential/index.d.ts

@@ -0,0 +1,34 @@
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>
+ *     Password credential. These are created by JAAS LoginModule implementations and placed in the Subject.
+ *  </p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.credential.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Rickard Öberg
+ */
+export type PasswordCredential = Object & {
+  /**
+   * Gets the password.
+   * @return the password
+   */
+  getPassword(): string;
+
+  /**
+   * Indicates whether some other object is "equal to" this credential.
+   * @param obj the reference object with which to compare.
+   * @return <code>true</code> if this object is the same as the obj argument, <code>false</code> otherwise.
+   */
+  equals(obj: unknown): boolean;
+
+  /**
+   * Gets the hash code for this credential.
+   * @return the hash code for this credential. Always 0.
+   */
+  hashCode(): number;
+};

package/types/senselogic/sitevision/api/security/jaas/credential/PasswordCredential/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getPassword: function getPassword() {},
+  equals: function equals() {},
+  hashCode: function hashCode() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/credential/VirtualGroupCredential/index.d.ts

@@ -0,0 +1,34 @@
+import type { Set } from "../../../../../../../java/util/Set";
+import type { Object } from "../../../../../../../java/lang/Object";
+
+/**
+ * <p>Credential for virtual groups.</p>
+ *
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this class has been moved
+ *     (from package senselogic.sitevision.security.jaas.credential.api).
+ *     Previously implemented custom JAAS filters/modules using this class must be re-compiled in order to run in Sitevision 3.
+ *  </em>
+ * @author Karl Eklöf
+ * @since Sitevision 2.6.2
+ */
+export type VirtualGroupCredential = Object & {
+  /**
+   * Gets the set of groups for this credential.
+   * @return the set of groups for this credential
+   */
+  getGroups(): Set;
+
+  /**
+   * Indicates whether some other object is "equal to" this credential.
+   * @param obj the reference object with which to compare.
+   * @return <code>true</code> if this object is the same as the obj argument, <code>false</code> otherwise.
+   */
+  equals(obj: unknown): boolean;
+
+  /**
+   * Returns the hash code value for the object.
+   * @return a hash code value for this object.
+   */
+  hashCode(): number;
+};

package/types/senselogic/sitevision/api/security/jaas/credential/VirtualGroupCredential/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getGroups: function getGroups() {},
+  equals: function equals() {},
+  hashCode: function hashCode() {}
+};
+exports["default"] = _default;

package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts

@@ -1,15 +1,18 @@
+import type { Map } from "../../../../../../../java/util/Map";
 import type { AuthenticationFilterChain } from "../AuthenticationFilterChain";
 
+import type { String } from "../../../../../../../java/lang/String";
+
 /**
  * <p>
- *    Interface for request filters that want to handle web interactions in order to get login data.
- * </p>
+ *     Interface for request filters that want to handle web interactions in order to get login data.
+ *  </p>
  *
- * <em>
- *    <strong>Important legacy note!</strong> As of Sitevision 3 this interface has been moved
- *    (from package senselogic.sitevision.security.jaas.filter.api).
- *    Previously implemented custom JAAS filters/modules using this interface must be re-compiled in order to run in Sitevision 3.
- * </em>
+ *  <em>
+ *     <strong>Important legacy note!</strong> As of Sitevision 3 this interface has been moved
+ *     (from package senselogic.sitevision.security.jaas.filter.api).
+ *     Previously implemented custom JAAS filters/modules using this interface must be re-compiled in order to run in Sitevision 3.
+ *  </em>
  * @author Rickard Öberg
  */
 export type AuthenticationFilter = {
@@ -27,8 +30,8 @@ export type AuthenticationFilter = {
   doFilter(
     aRequest: unknown,
     aResponse: unknown,
-    aSharedState: unknown,
-    anOptions: unknown,
+    aSharedState: Map | {},
+    anOptions: Map | {},
     aChain: AuthenticationFilterChain
   ): void;