Package com.coveo.pushapiclient

Record Class UserSecurityIdentityBuilder

java.lang.Object
java.lang.Record
com.coveo.pushapiclient.UserSecurityIdentityBuilder
All Implemented Interfaces:
SecurityIdentityBuilder
public record UserSecurityIdentityBuilder(String[] identities, String securityProvider) extends Record implements SecurityIdentityBuilder
Build a security identity of type `USER`.

Typically used in conjunction with DocumentBuilder.withAllowedPermissions(com.coveo.pushapiclient.SecurityIdentityBuilder) or DocumentBuilder.withDeniedPermissions(com.coveo.pushapiclient.SecurityIdentityBuilder).

See SecurityIdentity.

  • Constructor Details

    • UserSecurityIdentityBuilder

      public UserSecurityIdentityBuilder​(String identity, String securityProvider)
      Construct a UserSecurityIdentityBuilder for a single identity with the given security provider.
      Parameters:
      identity -
      securityProvider -

    • UserSecurityIdentityBuilder

      public UserSecurityIdentityBuilder​(String identity)
      Construct a UserSecurityIdentityBuilder for a single identity with an `Email Security Provider`.
      Parameters:
      identity -

    • UserSecurityIdentityBuilder

      public UserSecurityIdentityBuilder​(String[] identities)
      Construct a UserSecurityIdentityBuilder for multiple identities with an `Email Security Provider`.
      Parameters:
      identities -

    • UserSecurityIdentityBuilder

      public UserSecurityIdentityBuilder​(String[] identities, String securityProvider)
      Creates an instance of a UserSecurityIdentityBuilder record class.
      Parameters:
      identities - the value for the identities record component
      securityProvider - the value for the securityProvider record component

  • Method Details

    • build

      public SecurityIdentity[] build()
      Description copied from interface: SecurityIdentityBuilder
      Build and return a list of SecurityIdentity
      Specified by:
      build in interface SecurityIdentityBuilder
      Returns:

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals​(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • identities

      public String[] identities()
      Returns the value of the identities record component.
      Returns:
      the value of the identities record component

    • securityProvider

      public String securityProvider()
      Returns the value of the securityProvider record component.
      Returns:
      the value of the securityProvider record component