public interface

Permission

implements Serializable
org.springframework.security.acls.model.Permission
Known Indirect Subclasses

Class Overview

Represents a permission granted to a Sid for a given domain object.

Summary

Constants
char RESERVED_OFF
char RESERVED_ON
String THIRTY_TWO_RESERVED_OFF
Public Methods
abstract int getMask()
Returns the bits that represents the permission.
abstract String getPattern()
Returns a 32-character long bit pattern String representing this permission.

Constants

public static final char RESERVED_OFF

Constant Value: 46 (0x0000002e)

public static final char RESERVED_ON

Constant Value: 126 (0x0000007e)

public static final String THIRTY_TWO_RESERVED_OFF

Constant Value: "................................"

Public Methods

public abstract int getMask ()

Returns the bits that represents the permission.

Returns
  • the bits that represent the permission

public abstract String getPattern ()

Returns a 32-character long bit pattern String representing this permission.

Implementations are free to format the pattern as they see fit, although under no circumstances may RESERVED_OFF or RESERVED_ON be used within the pattern. An exemption is in the case of RESERVED_OFF which is used to denote a bit that is off (clear). Implementations may also elect to use RESERVED_ON internally for computation purposes, although this method may not return any String containing RESERVED_ON.

The returned String must be 32 characters in length.

This method is only used for user interface and logging purposes. It is not used in any permission calculations. Therefore, duplication of characters within the output is permitted.

Returns
  • a 32-character bit pattern