Class SecurityGroupSettings

java.lang.Object
software.amazon.awssdk.services.wickr.model.SecurityGroupSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SecurityGroupSettings.Builder,SecurityGroupSettings>
@Generated("software.amazon.awssdk:codegen") public final class SecurityGroupSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SecurityGroupSettings.Builder,SecurityGroupSettings>

Comprehensive configuration settings that define all user capabilities, restrictions, and features for members of a security group. These settings control everything from calling permissions to federation settings to security policies.

See Also:

  • Method Details

    • alwaysReauthenticate

      public final Boolean alwaysReauthenticate()

      Requires users to reauthenticate every time they return to the application, providing an additional layer of security.

      Returns:
      Requires users to reauthenticate every time they return to the application, providing an additional layer of security.

    • hasAtakPackageValues

      public final boolean hasAtakPackageValues()
      For responses, this returns true if the service returned a value for the AtakPackageValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • atakPackageValues

      public final List<String> atakPackageValues()

      Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAtakPackageValues() method.

      Returns:
      Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.

    • calling

      public final CallingSettings calling()

      The calling feature permissions and settings that control what types of calls users can initiate and participate in.

      Returns:
      The calling feature permissions and settings that control what types of calls users can initiate and participate in.

    • checkForUpdates

      public final Boolean checkForUpdates()

      Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.

      Returns:
      Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.

    • enableAtak

      public final Boolean enableAtak()

      Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.

      Returns:
      Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.

    • enableCrashReports

      public final Boolean enableCrashReports()

      Allow users to report crashes.

      Returns:
      Allow users to report crashes.

    • enableFileDownload

      public final Boolean enableFileDownload()

      Specifies whether users can download files from messages to their devices.

      Returns:
      Specifies whether users can download files from messages to their devices.

    • enableGuestFederation

      public final Boolean enableGuestFederation()

      Allows users to communicate with guest users from other Wickr networks and federated external networks.

      Returns:
      Allows users to communicate with guest users from other Wickr networks and federated external networks.

    • enableNotificationPreview

      public final Boolean enableNotificationPreview()

      Enables message preview text in push notifications, allowing users to see message content before opening the app.

      Returns:
      Enables message preview text in push notifications, allowing users to see message content before opening the app.

    • enableOpenAccessOption

      public final Boolean enableOpenAccessOption()

      Allow users to avoid censorship when they are geo-blocked or have network limitations.

      Returns:
      Allow users to avoid censorship when they are geo-blocked or have network limitations.

    • enableRestrictedGlobalFederation

      public final Boolean enableRestrictedGlobalFederation()

      Enables restricted global federation, limiting external communication to only specified permitted networks.

      Returns:
      Enables restricted global federation, limiting external communication to only specified permitted networks.

    • filesEnabled

      public final Boolean filesEnabled()

      Enables file sharing capabilities, allowing users to send and receive files in conversations.

      Returns:
      Enables file sharing capabilities, allowing users to send and receive files in conversations.

    • forceDeviceLockout

      public final Integer forceDeviceLockout()

      Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.

      Returns:
      Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.

    • forceOpenAccess

      public final Boolean forceOpenAccess()

      Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.

      Returns:
      Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.

    • forceReadReceipts

      public final Boolean forceReadReceipts()

      Allow user approved bots to read messages in rooms without using a slash command.

      Returns:
      Allow user approved bots to read messages in rooms without using a slash command.

    • globalFederation

      public final Boolean globalFederation()

      Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.

      Returns:
      Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.

    • isAtoEnabled

      public final Boolean isAtoEnabled()

      Enforces a two-factor authentication when a user adds a new device to their account.

      Returns:
      Enforces a two-factor authentication when a user adds a new device to their account.

    • isLinkPreviewEnabled

      public final Boolean isLinkPreviewEnabled()

      Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.

      Returns:
      Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.

    • locationAllowMaps

      public final Boolean locationAllowMaps()

      Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.

      Returns:
      Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.

    • locationEnabled

      public final Boolean locationEnabled()

      Enables location sharing features, allowing users to share their current location with others.

      Returns:
      Enables location sharing features, allowing users to share their current location with others.

    • maxAutoDownloadSize

      public final Long maxAutoDownloadSize()

      The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]

      Returns:
      The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]

    • maxBor

      public final Integer maxBor()

      The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.

      Returns:
      The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.

    • maxTtl

      public final Long maxTtl()

      The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.

      Returns:
      The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.

    • messageForwardingEnabled

      public final Boolean messageForwardingEnabled()

      Enables message forwarding, allowing users to forward messages from one conversation to another.

      Returns:
      Enables message forwarding, allowing users to forward messages from one conversation to another.

    • passwordRequirements

      public final PasswordRequirements passwordRequirements()

      The password complexity requirements that users must follow when creating or changing passwords.

      Returns:
      The password complexity requirements that users must follow when creating or changing passwords.

    • presenceEnabled

      public final Boolean presenceEnabled()

      Enables presence indicators that show whether users are online, away, or offline.

      Returns:
      Enables presence indicators that show whether users are online, away, or offline.

    • hasQuickResponses

      public final boolean hasQuickResponses()
      For responses, this returns true if the service returned a value for the QuickResponses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • quickResponses

      public final List<String> quickResponses()

      A list of pre-defined quick response message templates that users can send with a single tap.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQuickResponses() method.

      Returns:
      A list of pre-defined quick response message templates that users can send with a single tap.

    • showMasterRecoveryKey

      public final Boolean showMasterRecoveryKey()

      Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.

      Returns:
      Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.

    • shredder

      public final ShredderSettings shredder()

      The message shredder configuration that controls secure deletion of messages and files from devices.

      Returns:
      The message shredder configuration that controls secure deletion of messages and files from devices.

    • ssoMaxIdleMinutes

      public final Integer ssoMaxIdleMinutes()

      The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.

      Returns:
      The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.

    • federationMode

      public final Integer federationMode()

      The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).

      Returns:
      The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).

    • lockoutThreshold

      public final Integer lockoutThreshold()

      The number of failed password attempts before a user account is locked out.

      Returns:
      The number of failed password attempts before a user account is locked out.

    • hasPermittedNetworks

      public final boolean hasPermittedNetworks()
      For responses, this returns true if the service returned a value for the PermittedNetworks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • permittedNetworks

      public final List<String> permittedNetworks()

      A list of network IDs that are permitted for local federation when federation mode is set to restricted.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermittedNetworks() method.

      Returns:
      A list of network IDs that are permitted for local federation when federation mode is set to restricted.

    • hasPermittedWickrAwsNetworks

      public final boolean hasPermittedWickrAwsNetworks()
      For responses, this returns true if the service returned a value for the PermittedWickrAwsNetworks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • permittedWickrAwsNetworks

      public final List<WickrAwsNetworks> permittedWickrAwsNetworks()

      A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermittedWickrAwsNetworks() method.

      Returns:
      A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.

    • hasPermittedWickrEnterpriseNetworks

      public final boolean hasPermittedWickrEnterpriseNetworks()
      For responses, this returns true if the service returned a value for the PermittedWickrEnterpriseNetworks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • permittedWickrEnterpriseNetworks

      public final List<PermittedWickrEnterpriseNetwork> permittedWickrEnterpriseNetworks()

      A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermittedWickrEnterpriseNetworks() method.

      Returns:
      A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.

    • toBuilder

      public SecurityGroupSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SecurityGroupSettings.Builder,SecurityGroupSettings>
      Returns:
      a builder for type T

    • builder

      public static SecurityGroupSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SecurityGroupSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.