Package com.atlassian.plugins.whitelist

Interface WhitelistRule

All Superinterfaces:
Serializable
All Known Implementing Classes:
ImmutableWhitelistRule, LegacyWhitelistRule
@PublicApi public interface WhitelistRule extends Serializable
The essential data of a whitelist rule which is persisted in the database.
Since:
1.0

  • Method Details

    • getId

      @Nullable Integer getId()
      Returns:
      the id of the whitelist rule; null if not yet persisted

    • getExpression

      String getExpression()
      Returns:
      an whitelist rule expression; can have a specific meaning depending on the type.

    • getType

      WhitelistType getType()
      Returns:
      the whitelist rule type

    • isAllowInbound

      boolean isAllowInbound()
      Returns:
      true if the whitelist rule represents inbound requests as well as outbound requests, false otherwise

    • isAuthenticationRequired

      boolean isAuthenticationRequired()
      Returns:
      true if the whitelist rule requires the user to be authenticated, false otherwise