com.eruces.teadmin.ACLEntry
The ACLEntry class is a ACL rights container for a principal's TTag.
Since: 1.0
© Pi Soft, 2018-2026 · Tricryption Engine 8.1
Inheritance
- Inherits com.eruces.teadmin.UpdatableObject
- Inherits Comparable
Static Public Attributes
| Type | Name | Description |
|---|---|---|
| final int | ACL_RIGHT_OWNER | The principal is the owner of corresponding ACLInfo, which in-turn is the owner of hidden link. |
| final int | ACL_RIGHT_READ | The principal may read the corresponding ACLInfo object. |
| final int | ACL_RIGHT_WRITE | The principal may write to the corresponding ACLInfo object. |
| final int | ACL_MANDATORY_GROUP | The principal is a mandatory group. |
| final int | ACL_HOST_MATRIX | The principal is a group which defines host matrix. |
| final int | USAGE_NO_LIMIT | The principal may perform unlimited encryption and decryption. |
Public Member Functions
| Member | Description |
|---|---|
ACLEntry() | The ACLEntry constructor is the default class constructor. |
ACLEntry(ACLInfo info) | The ACLEntry constructor is the default class constructor; the constructed ACLEntry object will be put into the specified ACLInfo object. |
long getPrincipalID() | The getPrincipalId method gets a principal identifier. |
void setPrincipalID(long nPrincipalID) | The setPrincipalId method sets a unique principal identifier. |
long getACLID() | The getACLId method gets an access control list identifier. |
void setACLID(long nID) | The setACLId method sets a unique access control list identifier. |
int getFlag() | The getFlag method gets an access control list right assigned to a ACLEntry object. |
void setFlag(int nFlag) | The setFlag method sets an access control list right for a ACLEntry object. |
int getMaxUsage() | The getMaxUsage method gets a number representing the maximum number of times a specific user may use a key to access data. |
void setMaxUsage(int nMaxUsage) | The setMaxUsage method sets the maximum number of times a user associated with a TEACLEntry object may access data using a specific key. |
String toString() | The toString method converts ACL Entry data into a string. |
Member Function Documentation
ACLEntry()
The ACLEntry constructor is the default class constructor.
The new entry carries no principal, no rights and no timestamps; set them before adding it to an ACLInfo.
ACLEntry(ACLInfo info)
The ACLEntry constructor is the default class constructor; the constructed ACLEntry object will be put into the specified ACLInfo object.
Parameters
| Parameter | Description |
|---|---|
info | An ACLInfo object. The new entry takes its ACL id from this object and is added to it. |
long getPrincipalID()
The getPrincipalId method gets a principal identifier.
Returns: Returns an integer representing a principal ID.
void setPrincipalID(long nPrincipalID)
The setPrincipalId method sets a unique principal identifier.
Parameters
| Parameter | Description |
|---|---|
nPrincipalID | An integer representing a principal ID. |
long getACLID()
The getACLId method gets an access control list identifier.
Returns: Returns an integer representing an ACL ID.
void setACLID(long nID)
The setACLId method sets a unique access control list identifier.
Parameters
| Parameter | Description |
|---|---|
nID | An integer representing an ACL ID. |
int getFlag()
The getFlag method gets an access control list right assigned to a ACLEntry object.
All possible values: enum ACLOP ACL_READ = 0x00000001 Principal has ability to perform decryption using the TTag. ACL_WRITE = 0x00000002 Principal can perform encryption and decryption using the TTag. Principal to add other principals to an ACL for the TTag. ACL_OWNER = 0x00000004 Principal is the owner of the TTag. Set automatically. ACL_CHECKOUT = 0x00000008 (For internal use only.) ACL_TEMPORARY = 0x00000010 (For internal use only.) ACL_PURGE = 0x00000020 (For internal use only.) ACL_DISABLE = 0x00000040 (For internal use only.) ACL_NONREMOVABLE= 0x00000080 (For internal use only.) ACL_TEMPLATE_READ = 0x00000100 (For internal use only.) ACL_TEMPLATE_WRITE = 0x00000200 (For internal use only.) ACL_MANDATORY_GROUP = 0x00000400 The principal is a mandatory group. Membership is required to use the TTag. ACL_HOST_MATRIX = 0x00000800 (For internal use only.)
See also: ACL_RIGHT_OWNER, ACL_RIGHT_READ, ACL_RIGHT_WRITE, ACL_MANDATORY_GROUP, ACL_HOST_MATRIX, setFlag.
Returns: Returns an integer representing ACL rights. Additive.
void setFlag(int nFlag)
The setFlag method sets an access control list right for a ACLEntry object.
All possible values: enum ACLOP ACL_READ = 0x00000001 Principal has ability to perform decryption using the TTag. ACL_WRITE = 0x00000002 Principal can perform encryption and decryption using the TTag. Principal to add other principals to an ACL for the TTag. ACL_OWNER = 0x00000004 Principal is the owner of the TTag. Set automatically. ACL_CHECKOUT = 0x00000008 (For internal use only.) ACL_TEMPORARY = 0x00000010 (For internal use only.) ACL_PURGE = 0x00000020 (For internal use only.) ACL_DISABLE = 0x00000040 (For internal use only.) ACL_NONREMOVABLE= 0x00000080 (For internal use only.) ACL_TEMPLATE_READ = 0x00000100 (For internal use only.) ACL_TEMPLATE_WRITE = 0x00000200 (For internal use only.) ACL_MANDATORY_GROUP = 0x00000400 The principal is a mandatory group. Membership is required to use the TTag. ACL_HOST_MATRIX = 0x00000800 (For internal use only.)
Parameters
| Parameter | Description |
|---|---|
nFlag | An integer representing ACL rights. 1=read, 2=write, additive |
See also: ACL_RIGHT_OWNER, ACL_RIGHT_READ, ACL_RIGHT_WRITE, ACL_MANDATORY_GROUP, ACL_HOST_MATRIX, getFlag.
int getMaxUsage()
The getMaxUsage method gets a number representing the maximum number of times a specific user may use a key to access data.
Returns: Returns an integer representing the maximum number of times a user associated with a ACLEntry object may access data using a specific key; if value = -1 ,the user has unlimited use of the key.
See also: USAGE_NO_LIMIT
void setMaxUsage(int nMaxUsage)
The setMaxUsage method sets the maximum number of times a user associated with a TEACLEntry object may access data using a specific key.
Parameters
| Parameter | Description |
|---|---|
nMaxUsage | An integer representing the maximum number of times a user associated with a ACLEntry object may access data using a specific key; if value=-1, the user has unlimited use of the key. |
Exceptions
| Exception | Description |
|---|---|
AdminException | if the Key Service refuses the operation, or an argument fails the check this method makes before sending the request. |
See also: USAGE_NO_LIMIT
String toString()
The toString method converts ACL Entry data into a string.
Returns: a string of ACL entry data